##// END OF EJS Templates
sslutil: config option to specify TLS protocol version...
Gregory Szorc -
r29559:7dec5e44 default
parent child Browse files
Show More
@@ -1,2166 +1,2189
1 1 The Mercurial system uses a set of configuration files to control
2 2 aspects of its behavior.
3 3
4 4 Troubleshooting
5 5 ===============
6 6
7 7 If you're having problems with your configuration,
8 8 :hg:`config --debug` can help you understand what is introducing
9 9 a setting into your environment.
10 10
11 11 See :hg:`help config.syntax` and :hg:`help config.files`
12 12 for information about how and where to override things.
13 13
14 14 Structure
15 15 =========
16 16
17 17 The configuration files use a simple ini-file format. A configuration
18 18 file consists of sections, led by a ``[section]`` header and followed
19 19 by ``name = value`` entries::
20 20
21 21 [ui]
22 22 username = Firstname Lastname <firstname.lastname@example.net>
23 23 verbose = True
24 24
25 25 The above entries will be referred to as ``ui.username`` and
26 26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
27 27
28 28 Files
29 29 =====
30 30
31 31 Mercurial reads configuration data from several files, if they exist.
32 32 These files do not exist by default and you will have to create the
33 33 appropriate configuration files yourself:
34 34
35 35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
36 36
37 37 Global configuration like the username setting is typically put into:
38 38
39 39 .. container:: windows
40 40
41 41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
42 42
43 43 .. container:: unix.plan9
44 44
45 45 - ``$HOME/.hgrc`` (on Unix, Plan9)
46 46
47 47 The names of these files depend on the system on which Mercurial is
48 48 installed. ``*.rc`` files from a single directory are read in
49 49 alphabetical order, later ones overriding earlier ones. Where multiple
50 50 paths are given below, settings from earlier paths override later
51 51 ones.
52 52
53 53 .. container:: verbose.unix
54 54
55 55 On Unix, the following files are consulted:
56 56
57 57 - ``<repo>/.hg/hgrc`` (per-repository)
58 58 - ``$HOME/.hgrc`` (per-user)
59 59 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
60 60 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
61 61 - ``/etc/mercurial/hgrc`` (per-system)
62 62 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
63 63 - ``<internal>/default.d/*.rc`` (defaults)
64 64
65 65 .. container:: verbose.windows
66 66
67 67 On Windows, the following files are consulted:
68 68
69 69 - ``<repo>/.hg/hgrc`` (per-repository)
70 70 - ``%USERPROFILE%\.hgrc`` (per-user)
71 71 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
72 72 - ``%HOME%\.hgrc`` (per-user)
73 73 - ``%HOME%\Mercurial.ini`` (per-user)
74 74 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
75 75 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
76 76 - ``<install-dir>\Mercurial.ini`` (per-installation)
77 77 - ``<internal>/default.d/*.rc`` (defaults)
78 78
79 79 .. note::
80 80
81 81 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
82 82 is used when running 32-bit Python on 64-bit Windows.
83 83
84 84 .. container:: windows
85 85
86 86 On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
87 87
88 88 .. container:: verbose.plan9
89 89
90 90 On Plan9, the following files are consulted:
91 91
92 92 - ``<repo>/.hg/hgrc`` (per-repository)
93 93 - ``$home/lib/hgrc`` (per-user)
94 94 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
95 95 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
96 96 - ``/lib/mercurial/hgrc`` (per-system)
97 97 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
98 98 - ``<internal>/default.d/*.rc`` (defaults)
99 99
100 100 Per-repository configuration options only apply in a
101 101 particular repository. This file is not version-controlled, and
102 102 will not get transferred during a "clone" operation. Options in
103 103 this file override options in all other configuration files.
104 104
105 105 .. container:: unix.plan9
106 106
107 107 On Plan 9 and Unix, most of this file will be ignored if it doesn't
108 108 belong to a trusted user or to a trusted group. See
109 109 :hg:`help config.trusted` for more details.
110 110
111 111 Per-user configuration file(s) are for the user running Mercurial. Options
112 112 in these files apply to all Mercurial commands executed by this user in any
113 113 directory. Options in these files override per-system and per-installation
114 114 options.
115 115
116 116 Per-installation configuration files are searched for in the
117 117 directory where Mercurial is installed. ``<install-root>`` is the
118 118 parent directory of the **hg** executable (or symlink) being run.
119 119
120 120 .. container:: unix.plan9
121 121
122 122 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
123 123 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
124 124 files apply to all Mercurial commands executed by any user in any
125 125 directory.
126 126
127 127 Per-installation configuration files are for the system on
128 128 which Mercurial is running. Options in these files apply to all
129 129 Mercurial commands executed by any user in any directory. Registry
130 130 keys contain PATH-like strings, every part of which must reference
131 131 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
132 132 be read. Mercurial checks each of these locations in the specified
133 133 order until one or more configuration files are detected.
134 134
135 135 Per-system configuration files are for the system on which Mercurial
136 136 is running. Options in these files apply to all Mercurial commands
137 137 executed by any user in any directory. Options in these files
138 138 override per-installation options.
139 139
140 140 Mercurial comes with some default configuration. The default configuration
141 141 files are installed with Mercurial and will be overwritten on upgrades. Default
142 142 configuration files should never be edited by users or administrators but can
143 143 be overridden in other configuration files. So far the directory only contains
144 144 merge tool configuration but packagers can also put other default configuration
145 145 there.
146 146
147 147 Syntax
148 148 ======
149 149
150 150 A configuration file consists of sections, led by a ``[section]`` header
151 151 and followed by ``name = value`` entries (sometimes called
152 152 ``configuration keys``)::
153 153
154 154 [spam]
155 155 eggs=ham
156 156 green=
157 157 eggs
158 158
159 159 Each line contains one entry. If the lines that follow are indented,
160 160 they are treated as continuations of that entry. Leading whitespace is
161 161 removed from values. Empty lines are skipped. Lines beginning with
162 162 ``#`` or ``;`` are ignored and may be used to provide comments.
163 163
164 164 Configuration keys can be set multiple times, in which case Mercurial
165 165 will use the value that was configured last. As an example::
166 166
167 167 [spam]
168 168 eggs=large
169 169 ham=serrano
170 170 eggs=small
171 171
172 172 This would set the configuration key named ``eggs`` to ``small``.
173 173
174 174 It is also possible to define a section multiple times. A section can
175 175 be redefined on the same and/or on different configuration files. For
176 176 example::
177 177
178 178 [foo]
179 179 eggs=large
180 180 ham=serrano
181 181 eggs=small
182 182
183 183 [bar]
184 184 eggs=ham
185 185 green=
186 186 eggs
187 187
188 188 [foo]
189 189 ham=prosciutto
190 190 eggs=medium
191 191 bread=toasted
192 192
193 193 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
194 194 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
195 195 respectively. As you can see there only thing that matters is the last
196 196 value that was set for each of the configuration keys.
197 197
198 198 If a configuration key is set multiple times in different
199 199 configuration files the final value will depend on the order in which
200 200 the different configuration files are read, with settings from earlier
201 201 paths overriding later ones as described on the ``Files`` section
202 202 above.
203 203
204 204 A line of the form ``%include file`` will include ``file`` into the
205 205 current configuration file. The inclusion is recursive, which means
206 206 that included files can include other files. Filenames are relative to
207 207 the configuration file in which the ``%include`` directive is found.
208 208 Environment variables and ``~user`` constructs are expanded in
209 209 ``file``. This lets you do something like::
210 210
211 211 %include ~/.hgrc.d/$HOST.rc
212 212
213 213 to include a different configuration file on each computer you use.
214 214
215 215 A line with ``%unset name`` will remove ``name`` from the current
216 216 section, if it has been set previously.
217 217
218 218 The values are either free-form text strings, lists of text strings,
219 219 or Boolean values. Boolean values can be set to true using any of "1",
220 220 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
221 221 (all case insensitive).
222 222
223 223 List values are separated by whitespace or comma, except when values are
224 224 placed in double quotation marks::
225 225
226 226 allow_read = "John Doe, PhD", brian, betty
227 227
228 228 Quotation marks can be escaped by prefixing them with a backslash. Only
229 229 quotation marks at the beginning of a word is counted as a quotation
230 230 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
231 231
232 232 Sections
233 233 ========
234 234
235 235 This section describes the different sections that may appear in a
236 236 Mercurial configuration file, the purpose of each section, its possible
237 237 keys, and their possible values.
238 238
239 239 ``alias``
240 240 ---------
241 241
242 242 Defines command aliases.
243 243
244 244 Aliases allow you to define your own commands in terms of other
245 245 commands (or aliases), optionally including arguments. Positional
246 246 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
247 247 are expanded by Mercurial before execution. Positional arguments not
248 248 already used by ``$N`` in the definition are put at the end of the
249 249 command to be executed.
250 250
251 251 Alias definitions consist of lines of the form::
252 252
253 253 <alias> = <command> [<argument>]...
254 254
255 255 For example, this definition::
256 256
257 257 latest = log --limit 5
258 258
259 259 creates a new command ``latest`` that shows only the five most recent
260 260 changesets. You can define subsequent aliases using earlier ones::
261 261
262 262 stable5 = latest -b stable
263 263
264 264 .. note::
265 265
266 266 It is possible to create aliases with the same names as
267 267 existing commands, which will then override the original
268 268 definitions. This is almost always a bad idea!
269 269
270 270 An alias can start with an exclamation point (``!``) to make it a
271 271 shell alias. A shell alias is executed with the shell and will let you
272 272 run arbitrary commands. As an example, ::
273 273
274 274 echo = !echo $@
275 275
276 276 will let you do ``hg echo foo`` to have ``foo`` printed in your
277 277 terminal. A better example might be::
278 278
279 279 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm
280 280
281 281 which will make ``hg purge`` delete all unknown files in the
282 282 repository in the same manner as the purge extension.
283 283
284 284 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
285 285 expand to the command arguments. Unmatched arguments are
286 286 removed. ``$0`` expands to the alias name and ``$@`` expands to all
287 287 arguments separated by a space. ``"$@"`` (with quotes) expands to all
288 288 arguments quoted individually and separated by a space. These expansions
289 289 happen before the command is passed to the shell.
290 290
291 291 Shell aliases are executed in an environment where ``$HG`` expands to
292 292 the path of the Mercurial that was used to execute the alias. This is
293 293 useful when you want to call further Mercurial commands in a shell
294 294 alias, as was done above for the purge alias. In addition,
295 295 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
296 296 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
297 297
298 298 .. note::
299 299
300 300 Some global configuration options such as ``-R`` are
301 301 processed before shell aliases and will thus not be passed to
302 302 aliases.
303 303
304 304
305 305 ``annotate``
306 306 ------------
307 307
308 308 Settings used when displaying file annotations. All values are
309 309 Booleans and default to False. See :hg:`help config.diff` for
310 310 related options for the diff command.
311 311
312 312 ``ignorews``
313 313 Ignore white space when comparing lines.
314 314
315 315 ``ignorewsamount``
316 316 Ignore changes in the amount of white space.
317 317
318 318 ``ignoreblanklines``
319 319 Ignore changes whose lines are all blank.
320 320
321 321
322 322 ``auth``
323 323 --------
324 324
325 325 Authentication credentials for HTTP authentication. This section
326 326 allows you to store usernames and passwords for use when logging
327 327 *into* HTTP servers. See :hg:`help config.web` if
328 328 you want to configure *who* can login to your HTTP server.
329 329
330 330 Each line has the following format::
331 331
332 332 <name>.<argument> = <value>
333 333
334 334 where ``<name>`` is used to group arguments into authentication
335 335 entries. Example::
336 336
337 337 foo.prefix = hg.intevation.de/mercurial
338 338 foo.username = foo
339 339 foo.password = bar
340 340 foo.schemes = http https
341 341
342 342 bar.prefix = secure.example.org
343 343 bar.key = path/to/file.key
344 344 bar.cert = path/to/file.cert
345 345 bar.schemes = https
346 346
347 347 Supported arguments:
348 348
349 349 ``prefix``
350 350 Either ``*`` or a URI prefix with or without the scheme part.
351 351 The authentication entry with the longest matching prefix is used
352 352 (where ``*`` matches everything and counts as a match of length
353 353 1). If the prefix doesn't include a scheme, the match is performed
354 354 against the URI with its scheme stripped as well, and the schemes
355 355 argument, q.v., is then subsequently consulted.
356 356
357 357 ``username``
358 358 Optional. Username to authenticate with. If not given, and the
359 359 remote site requires basic or digest authentication, the user will
360 360 be prompted for it. Environment variables are expanded in the
361 361 username letting you do ``foo.username = $USER``. If the URI
362 362 includes a username, only ``[auth]`` entries with a matching
363 363 username or without a username will be considered.
364 364
365 365 ``password``
366 366 Optional. Password to authenticate with. If not given, and the
367 367 remote site requires basic or digest authentication, the user
368 368 will be prompted for it.
369 369
370 370 ``key``
371 371 Optional. PEM encoded client certificate key file. Environment
372 372 variables are expanded in the filename.
373 373
374 374 ``cert``
375 375 Optional. PEM encoded client certificate chain file. Environment
376 376 variables are expanded in the filename.
377 377
378 378 ``schemes``
379 379 Optional. Space separated list of URI schemes to use this
380 380 authentication entry with. Only used if the prefix doesn't include
381 381 a scheme. Supported schemes are http and https. They will match
382 382 static-http and static-https respectively, as well.
383 383 (default: https)
384 384
385 385 If no suitable authentication entry is found, the user is prompted
386 386 for credentials as usual if required by the remote.
387 387
388 388
389 389 ``committemplate``
390 390 ------------------
391 391
392 392 ``changeset``
393 393 String: configuration in this section is used as the template to
394 394 customize the text shown in the editor when committing.
395 395
396 396 In addition to pre-defined template keywords, commit log specific one
397 397 below can be used for customization:
398 398
399 399 ``extramsg``
400 400 String: Extra message (typically 'Leave message empty to abort
401 401 commit.'). This may be changed by some commands or extensions.
402 402
403 403 For example, the template configuration below shows as same text as
404 404 one shown by default::
405 405
406 406 [committemplate]
407 407 changeset = {desc}\n\n
408 408 HG: Enter commit message. Lines beginning with 'HG:' are removed.
409 409 HG: {extramsg}
410 410 HG: --
411 411 HG: user: {author}\n{ifeq(p2rev, "-1", "",
412 412 "HG: branch merge\n")
413 413 }HG: branch '{branch}'\n{if(activebookmark,
414 414 "HG: bookmark '{activebookmark}'\n") }{subrepos %
415 415 "HG: subrepo {subrepo}\n" }{file_adds %
416 416 "HG: added {file}\n" }{file_mods %
417 417 "HG: changed {file}\n" }{file_dels %
418 418 "HG: removed {file}\n" }{if(files, "",
419 419 "HG: no files changed\n")}
420 420
421 421 .. note::
422 422
423 423 For some problematic encodings (see :hg:`help win32mbcs` for
424 424 detail), this customization should be configured carefully, to
425 425 avoid showing broken characters.
426 426
427 427 For example, if a multibyte character ending with backslash (0x5c) is
428 428 followed by the ASCII character 'n' in the customized template,
429 429 the sequence of backslash and 'n' is treated as line-feed unexpectedly
430 430 (and the multibyte character is broken, too).
431 431
432 432 Customized template is used for commands below (``--edit`` may be
433 433 required):
434 434
435 435 - :hg:`backout`
436 436 - :hg:`commit`
437 437 - :hg:`fetch` (for merge commit only)
438 438 - :hg:`graft`
439 439 - :hg:`histedit`
440 440 - :hg:`import`
441 441 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
442 442 - :hg:`rebase`
443 443 - :hg:`shelve`
444 444 - :hg:`sign`
445 445 - :hg:`tag`
446 446 - :hg:`transplant`
447 447
448 448 Configuring items below instead of ``changeset`` allows showing
449 449 customized message only for specific actions, or showing different
450 450 messages for each action.
451 451
452 452 - ``changeset.backout`` for :hg:`backout`
453 453 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
454 454 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
455 455 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
456 456 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
457 457 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
458 458 - ``changeset.gpg.sign`` for :hg:`sign`
459 459 - ``changeset.graft`` for :hg:`graft`
460 460 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
461 461 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
462 462 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
463 463 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
464 464 - ``changeset.import.bypass`` for :hg:`import --bypass`
465 465 - ``changeset.import.normal.merge`` for :hg:`import` on merges
466 466 - ``changeset.import.normal.normal`` for :hg:`import` on other
467 467 - ``changeset.mq.qnew`` for :hg:`qnew`
468 468 - ``changeset.mq.qfold`` for :hg:`qfold`
469 469 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
470 470 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
471 471 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
472 472 - ``changeset.rebase.normal`` for :hg:`rebase` on other
473 473 - ``changeset.shelve.shelve`` for :hg:`shelve`
474 474 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
475 475 - ``changeset.tag.remove`` for :hg:`tag --remove`
476 476 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
477 477 - ``changeset.transplant.normal`` for :hg:`transplant` on other
478 478
479 479 These dot-separated lists of names are treated as hierarchical ones.
480 480 For example, ``changeset.tag.remove`` customizes the commit message
481 481 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
482 482 commit message for :hg:`tag` regardless of ``--remove`` option.
483 483
484 484 When the external editor is invoked for a commit, the corresponding
485 485 dot-separated list of names without the ``changeset.`` prefix
486 486 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
487 487 variable.
488 488
489 489 In this section, items other than ``changeset`` can be referred from
490 490 others. For example, the configuration to list committed files up
491 491 below can be referred as ``{listupfiles}``::
492 492
493 493 [committemplate]
494 494 listupfiles = {file_adds %
495 495 "HG: added {file}\n" }{file_mods %
496 496 "HG: changed {file}\n" }{file_dels %
497 497 "HG: removed {file}\n" }{if(files, "",
498 498 "HG: no files changed\n")}
499 499
500 500 ``decode/encode``
501 501 -----------------
502 502
503 503 Filters for transforming files on checkout/checkin. This would
504 504 typically be used for newline processing or other
505 505 localization/canonicalization of files.
506 506
507 507 Filters consist of a filter pattern followed by a filter command.
508 508 Filter patterns are globs by default, rooted at the repository root.
509 509 For example, to match any file ending in ``.txt`` in the root
510 510 directory only, use the pattern ``*.txt``. To match any file ending
511 511 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
512 512 For each file only the first matching filter applies.
513 513
514 514 The filter command can start with a specifier, either ``pipe:`` or
515 515 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
516 516
517 517 A ``pipe:`` command must accept data on stdin and return the transformed
518 518 data on stdout.
519 519
520 520 Pipe example::
521 521
522 522 [encode]
523 523 # uncompress gzip files on checkin to improve delta compression
524 524 # note: not necessarily a good idea, just an example
525 525 *.gz = pipe: gunzip
526 526
527 527 [decode]
528 528 # recompress gzip files when writing them to the working dir (we
529 529 # can safely omit "pipe:", because it's the default)
530 530 *.gz = gzip
531 531
532 532 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
533 533 with the name of a temporary file that contains the data to be
534 534 filtered by the command. The string ``OUTFILE`` is replaced with the name
535 535 of an empty temporary file, where the filtered data must be written by
536 536 the command.
537 537
538 538 .. container:: windows
539 539
540 540 .. note::
541 541
542 542 The tempfile mechanism is recommended for Windows systems,
543 543 where the standard shell I/O redirection operators often have
544 544 strange effects and may corrupt the contents of your files.
545 545
546 546 This filter mechanism is used internally by the ``eol`` extension to
547 547 translate line ending characters between Windows (CRLF) and Unix (LF)
548 548 format. We suggest you use the ``eol`` extension for convenience.
549 549
550 550
551 551 ``defaults``
552 552 ------------
553 553
554 554 (defaults are deprecated. Don't use them. Use aliases instead.)
555 555
556 556 Use the ``[defaults]`` section to define command defaults, i.e. the
557 557 default options/arguments to pass to the specified commands.
558 558
559 559 The following example makes :hg:`log` run in verbose mode, and
560 560 :hg:`status` show only the modified files, by default::
561 561
562 562 [defaults]
563 563 log = -v
564 564 status = -m
565 565
566 566 The actual commands, instead of their aliases, must be used when
567 567 defining command defaults. The command defaults will also be applied
568 568 to the aliases of the commands defined.
569 569
570 570
571 571 ``diff``
572 572 --------
573 573
574 574 Settings used when displaying diffs. Everything except for ``unified``
575 575 is a Boolean and defaults to False. See :hg:`help config.annotate`
576 576 for related options for the annotate command.
577 577
578 578 ``git``
579 579 Use git extended diff format.
580 580
581 581 ``nobinary``
582 582 Omit git binary patches.
583 583
584 584 ``nodates``
585 585 Don't include dates in diff headers.
586 586
587 587 ``noprefix``
588 588 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
589 589
590 590 ``showfunc``
591 591 Show which function each change is in.
592 592
593 593 ``ignorews``
594 594 Ignore white space when comparing lines.
595 595
596 596 ``ignorewsamount``
597 597 Ignore changes in the amount of white space.
598 598
599 599 ``ignoreblanklines``
600 600 Ignore changes whose lines are all blank.
601 601
602 602 ``unified``
603 603 Number of lines of context to show.
604 604
605 605 ``email``
606 606 ---------
607 607
608 608 Settings for extensions that send email messages.
609 609
610 610 ``from``
611 611 Optional. Email address to use in "From" header and SMTP envelope
612 612 of outgoing messages.
613 613
614 614 ``to``
615 615 Optional. Comma-separated list of recipients' email addresses.
616 616
617 617 ``cc``
618 618 Optional. Comma-separated list of carbon copy recipients'
619 619 email addresses.
620 620
621 621 ``bcc``
622 622 Optional. Comma-separated list of blind carbon copy recipients'
623 623 email addresses.
624 624
625 625 ``method``
626 626 Optional. Method to use to send email messages. If value is ``smtp``
627 627 (default), use SMTP (see the ``[smtp]`` section for configuration).
628 628 Otherwise, use as name of program to run that acts like sendmail
629 629 (takes ``-f`` option for sender, list of recipients on command line,
630 630 message on stdin). Normally, setting this to ``sendmail`` or
631 631 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
632 632
633 633 ``charsets``
634 634 Optional. Comma-separated list of character sets considered
635 635 convenient for recipients. Addresses, headers, and parts not
636 636 containing patches of outgoing messages will be encoded in the
637 637 first character set to which conversion from local encoding
638 638 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
639 639 conversion fails, the text in question is sent as is.
640 640 (default: '')
641 641
642 642 Order of outgoing email character sets:
643 643
644 644 1. ``us-ascii``: always first, regardless of settings
645 645 2. ``email.charsets``: in order given by user
646 646 3. ``ui.fallbackencoding``: if not in email.charsets
647 647 4. ``$HGENCODING``: if not in email.charsets
648 648 5. ``utf-8``: always last, regardless of settings
649 649
650 650 Email example::
651 651
652 652 [email]
653 653 from = Joseph User <joe.user@example.com>
654 654 method = /usr/sbin/sendmail
655 655 # charsets for western Europeans
656 656 # us-ascii, utf-8 omitted, as they are tried first and last
657 657 charsets = iso-8859-1, iso-8859-15, windows-1252
658 658
659 659
660 660 ``extensions``
661 661 --------------
662 662
663 663 Mercurial has an extension mechanism for adding new features. To
664 664 enable an extension, create an entry for it in this section.
665 665
666 666 If you know that the extension is already in Python's search path,
667 667 you can give the name of the module, followed by ``=``, with nothing
668 668 after the ``=``.
669 669
670 670 Otherwise, give a name that you choose, followed by ``=``, followed by
671 671 the path to the ``.py`` file (including the file name extension) that
672 672 defines the extension.
673 673
674 674 To explicitly disable an extension that is enabled in an hgrc of
675 675 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
676 676 or ``foo = !`` when path is not supplied.
677 677
678 678 Example for ``~/.hgrc``::
679 679
680 680 [extensions]
681 681 # (the color extension will get loaded from Mercurial's path)
682 682 color =
683 683 # (this extension will get loaded from the file specified)
684 684 myfeature = ~/.hgext/myfeature.py
685 685
686 686
687 687 ``format``
688 688 ----------
689 689
690 690 ``usegeneraldelta``
691 691 Enable or disable the "generaldelta" repository format which improves
692 692 repository compression by allowing "revlog" to store delta against arbitrary
693 693 revision instead of the previous stored one. This provides significant
694 694 improvement for repositories with branches.
695 695
696 696 Repositories with this on-disk format require Mercurial version 1.9.
697 697
698 698 Enabled by default.
699 699
700 700 ``dotencode``
701 701 Enable or disable the "dotencode" repository format which enhances
702 702 the "fncache" repository format (which has to be enabled to use
703 703 dotencode) to avoid issues with filenames starting with ._ on
704 704 Mac OS X and spaces on Windows.
705 705
706 706 Repositories with this on-disk format require Mercurial version 1.7.
707 707
708 708 Enabled by default.
709 709
710 710 ``usefncache``
711 711 Enable or disable the "fncache" repository format which enhances
712 712 the "store" repository format (which has to be enabled to use
713 713 fncache) to allow longer filenames and avoids using Windows
714 714 reserved names, e.g. "nul".
715 715
716 716 Repositories with this on-disk format require Mercurial version 1.1.
717 717
718 718 Enabled by default.
719 719
720 720 ``usestore``
721 721 Enable or disable the "store" repository format which improves
722 722 compatibility with systems that fold case or otherwise mangle
723 723 filenames. Disabling this option will allow you to store longer filenames
724 724 in some situations at the expense of compatibility.
725 725
726 726 Repositories with this on-disk format require Mercurial version 0.9.4.
727 727
728 728 Enabled by default.
729 729
730 730 ``graph``
731 731 ---------
732 732
733 733 Web graph view configuration. This section let you change graph
734 734 elements display properties by branches, for instance to make the
735 735 ``default`` branch stand out.
736 736
737 737 Each line has the following format::
738 738
739 739 <branch>.<argument> = <value>
740 740
741 741 where ``<branch>`` is the name of the branch being
742 742 customized. Example::
743 743
744 744 [graph]
745 745 # 2px width
746 746 default.width = 2
747 747 # red color
748 748 default.color = FF0000
749 749
750 750 Supported arguments:
751 751
752 752 ``width``
753 753 Set branch edges width in pixels.
754 754
755 755 ``color``
756 756 Set branch edges color in hexadecimal RGB notation.
757 757
758 758 ``hooks``
759 759 ---------
760 760
761 761 Commands or Python functions that get automatically executed by
762 762 various actions such as starting or finishing a commit. Multiple
763 763 hooks can be run for the same action by appending a suffix to the
764 764 action. Overriding a site-wide hook can be done by changing its
765 765 value or setting it to an empty string. Hooks can be prioritized
766 766 by adding a prefix of ``priority.`` to the hook name on a new line
767 767 and setting the priority. The default priority is 0.
768 768
769 769 Example ``.hg/hgrc``::
770 770
771 771 [hooks]
772 772 # update working directory after adding changesets
773 773 changegroup.update = hg update
774 774 # do not use the site-wide hook
775 775 incoming =
776 776 incoming.email = /my/email/hook
777 777 incoming.autobuild = /my/build/hook
778 778 # force autobuild hook to run before other incoming hooks
779 779 priority.incoming.autobuild = 1
780 780
781 781 Most hooks are run with environment variables set that give useful
782 782 additional information. For each hook below, the environment
783 783 variables it is passed are listed with names of the form ``$HG_foo``.
784 784
785 785 ``changegroup``
786 786 Run after a changegroup has been added via push, pull or unbundle. ID of the
787 787 first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL
788 788 from which changes came is in ``$HG_URL``.
789 789
790 790 ``commit``
791 791 Run after a changeset has been created in the local repository. ID
792 792 of the newly created changeset is in ``$HG_NODE``. Parent changeset
793 793 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
794 794
795 795 ``incoming``
796 796 Run after a changeset has been pulled, pushed, or unbundled into
797 797 the local repository. The ID of the newly arrived changeset is in
798 798 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
799 799
800 800 ``outgoing``
801 801 Run after sending changes from local repository to another. ID of
802 802 first changeset sent is in ``$HG_NODE``. Source of operation is in
803 803 ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook.
804 804
805 805 ``post-<command>``
806 806 Run after successful invocations of the associated command. The
807 807 contents of the command line are passed as ``$HG_ARGS`` and the result
808 808 code in ``$HG_RESULT``. Parsed command line arguments are passed as
809 809 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
810 810 the python data internally passed to <command>. ``$HG_OPTS`` is a
811 811 dictionary of options (with unspecified options set to their defaults).
812 812 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
813 813
814 814 ``fail-<command>``
815 815 Run after a failed invocation of an associated command. The contents
816 816 of the command line are passed as ``$HG_ARGS``. Parsed command line
817 817 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
818 818 string representations of the python data internally passed to
819 819 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
820 820 options set to their defaults). ``$HG_PATS`` is a list of arguments.
821 821 Hook failure is ignored.
822 822
823 823 ``pre-<command>``
824 824 Run before executing the associated command. The contents of the
825 825 command line are passed as ``$HG_ARGS``. Parsed command line arguments
826 826 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
827 827 representations of the data internally passed to <command>. ``$HG_OPTS``
828 828 is a dictionary of options (with unspecified options set to their
829 829 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
830 830 failure, the command doesn't execute and Mercurial returns the failure
831 831 code.
832 832
833 833 ``prechangegroup``
834 834 Run before a changegroup is added via push, pull or unbundle. Exit
835 835 status 0 allows the changegroup to proceed. Non-zero status will
836 836 cause the push, pull or unbundle to fail. URL from which changes
837 837 will come is in ``$HG_URL``.
838 838
839 839 ``precommit``
840 840 Run before starting a local commit. Exit status 0 allows the
841 841 commit to proceed. Non-zero status will cause the commit to fail.
842 842 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
843 843
844 844 ``prelistkeys``
845 845 Run before listing pushkeys (like bookmarks) in the
846 846 repository. Non-zero status will cause failure. The key namespace is
847 847 in ``$HG_NAMESPACE``.
848 848
849 849 ``preoutgoing``
850 850 Run before collecting changes to send from the local repository to
851 851 another. Non-zero status will cause failure. This lets you prevent
852 852 pull over HTTP or SSH. Also prevents against local pull, push
853 853 (outbound) or bundle commands, but not effective, since you can
854 854 just copy files instead then. Source of operation is in
855 855 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
856 856 SSH or HTTP repository. If "push", "pull" or "bundle", operation
857 857 is happening on behalf of repository on same system.
858 858
859 859 ``prepushkey``
860 860 Run before a pushkey (like a bookmark) is added to the
861 861 repository. Non-zero status will cause the key to be rejected. The
862 862 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
863 863 the old value (if any) is in ``$HG_OLD``, and the new value is in
864 864 ``$HG_NEW``.
865 865
866 866 ``pretag``
867 867 Run before creating a tag. Exit status 0 allows the tag to be
868 868 created. Non-zero status will cause the tag to fail. ID of
869 869 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
870 870 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
871 871
872 872 ``pretxnopen``
873 873 Run before any new repository transaction is open. The reason for the
874 874 transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
875 875 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
876 876 transaction from being opened.
877 877
878 878 ``pretxnclose``
879 879 Run right before the transaction is actually finalized. Any repository change
880 880 will be visible to the hook program. This lets you validate the transaction
881 881 content or change it. Exit status 0 allows the commit to proceed. Non-zero
882 882 status will cause the transaction to be rolled back. The reason for the
883 883 transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for
884 884 the transaction will be in ``HG_TXNID``. The rest of the available data will
885 885 vary according the transaction type. New changesets will add ``$HG_NODE`` (id
886 886 of the first added changeset), ``$HG_NODE_LAST`` (id of the last added
887 887 changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases
888 888 changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc.
889 889
890 890 ``txnclose``
891 891 Run after any repository transaction has been committed. At this
892 892 point, the transaction can no longer be rolled back. The hook will run
893 893 after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for
894 894 details about available variables.
895 895
896 896 ``txnabort``
897 897 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
898 898 docs for details about available variables.
899 899
900 900 ``pretxnchangegroup``
901 901 Run after a changegroup has been added via push, pull or unbundle, but before
902 902 the transaction has been committed. Changegroup is visible to hook program.
903 903 This lets you validate incoming changes before accepting them. Passed the ID
904 904 of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``.
905 905 Exit status 0 allows the transaction to commit. Non-zero status will cause
906 906 the transaction to be rolled back and the push, pull or unbundle will fail.
907 907 URL that was source of changes is in ``$HG_URL``.
908 908
909 909 ``pretxncommit``
910 910 Run after a changeset has been created but the transaction not yet
911 911 committed. Changeset is visible to hook program. This lets you
912 912 validate commit message and changes. Exit status 0 allows the
913 913 commit to proceed. Non-zero status will cause the transaction to
914 914 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
915 915 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
916 916
917 917 ``preupdate``
918 918 Run before updating the working directory. Exit status 0 allows
919 919 the update to proceed. Non-zero status will prevent the update.
920 920 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
921 921 of second new parent is in ``$HG_PARENT2``.
922 922
923 923 ``listkeys``
924 924 Run after listing pushkeys (like bookmarks) in the repository. The
925 925 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
926 926 dictionary containing the keys and values.
927 927
928 928 ``pushkey``
929 929 Run after a pushkey (like a bookmark) is added to the
930 930 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
931 931 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
932 932 value is in ``$HG_NEW``.
933 933
934 934 ``tag``
935 935 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
936 936 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
937 937 repository if ``$HG_LOCAL=0``.
938 938
939 939 ``update``
940 940 Run after updating the working directory. Changeset ID of first
941 941 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
942 942 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
943 943 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
944 944
945 945 .. note::
946 946
947 947 It is generally better to use standard hooks rather than the
948 948 generic pre- and post- command hooks as they are guaranteed to be
949 949 called in the appropriate contexts for influencing transactions.
950 950 Also, hooks like "commit" will be called in all contexts that
951 951 generate a commit (e.g. tag) and not just the commit command.
952 952
953 953 .. note::
954 954
955 955 Environment variables with empty values may not be passed to
956 956 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
957 957 will have an empty value under Unix-like platforms for non-merge
958 958 changesets, while it will not be available at all under Windows.
959 959
960 960 The syntax for Python hooks is as follows::
961 961
962 962 hookname = python:modulename.submodule.callable
963 963 hookname = python:/path/to/python/module.py:callable
964 964
965 965 Python hooks are run within the Mercurial process. Each hook is
966 966 called with at least three keyword arguments: a ui object (keyword
967 967 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
968 968 keyword that tells what kind of hook is used. Arguments listed as
969 969 environment variables above are passed as keyword arguments, with no
970 970 ``HG_`` prefix, and names in lower case.
971 971
972 972 If a Python hook returns a "true" value or raises an exception, this
973 973 is treated as a failure.
974 974
975 975
976 976 ``hostfingerprints``
977 977 --------------------
978 978
979 979 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
980 980
981 981 Fingerprints of the certificates of known HTTPS servers.
982 982
983 983 A HTTPS connection to a server with a fingerprint configured here will
984 984 only succeed if the servers certificate matches the fingerprint.
985 985 This is very similar to how ssh known hosts works.
986 986
987 987 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
988 988 Multiple values can be specified (separated by spaces or commas). This can
989 989 be used to define both old and new fingerprints while a host transitions
990 990 to a new certificate.
991 991
992 992 The CA chain and web.cacerts is not used for servers with a fingerprint.
993 993
994 994 For example::
995 995
996 996 [hostfingerprints]
997 997 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
998 998 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
999 999
1000 1000 ``hostsecurity``
1001 1001 ----------------
1002 1002
1003 Used to specify per-host security settings.
1004
1005 Options in this section have the form ``hostname``:``setting``. This allows
1006 multiple settings to be defined on a per-host basis.
1003 Used to specify global and per-host security settings for connecting to
1004 other machines.
1005
1006 The following options control default behavior for all hosts.
1007
1008 ``minimumprotocol``
1009 Defines the minimum channel encryption protocol to use.
1010
1011 By default, the highest version of TLS - 1.0 or greater - supported by
1012 both client and server is used.
1013
1014 Allowed values are: ``tls1.0`` (the default), ``tls1.1``, ``tls1.2``.
1015
1016 Options in the ``[hostsecurity]`` section can have the form
1017 ``hostname``:``setting``. This allows multiple settings to be defined on a
1018 per-host basis.
1007 1019
1008 1020 The following per-host settings can be defined.
1009 1021
1010 1022 ``fingerprints``
1011 1023 A list of hashes of the DER encoded peer/remote certificate. Values have
1012 1024 the form ``algorithm``:``fingerprint``. e.g.
1013 1025 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1014 1026
1015 1027 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1016 1028 ``sha512``.
1017 1029
1018 1030 Use of ``sha256`` or ``sha512`` is preferred.
1019 1031
1020 1032 If a fingerprint is specified, the CA chain is not validated for this
1021 1033 host and Mercurial will require the remote certificate to match one
1022 1034 of the fingerprints specified. This means if the server updates its
1023 1035 certificate, Mercurial will abort until a new fingerprint is defined.
1024 1036 This can provide stronger security than traditional CA-based validation
1025 1037 at the expense of convenience.
1026 1038
1027 1039 This option takes precedence over ``verifycertsfile``.
1028 1040
1041 ``minimumprotocol``
1042 This behaves like ``minimumprotocol`` as described above except it
1043 only applies to the host on which it is defined.
1044
1029 1045 ``verifycertsfile``
1030 1046 Path to file a containing a list of PEM encoded certificates used to
1031 1047 verify the server certificate. Environment variables and ``~user``
1032 1048 constructs are expanded in the filename.
1033 1049
1034 1050 The server certificate or the certificate's certificate authority (CA)
1035 1051 must match a certificate from this file or certificate verification
1036 1052 will fail and connections to the server will be refused.
1037 1053
1038 1054 If defined, only certificates provided by this file will be used:
1039 1055 ``web.cacerts`` and any system/default certificates will not be
1040 1056 used.
1041 1057
1042 1058 This option has no effect if the per-host ``fingerprints`` option
1043 1059 is set.
1044 1060
1045 1061 The format of the file is as follows:
1046 1062
1047 1063 -----BEGIN CERTIFICATE-----
1048 1064 ... (certificate in base64 PEM encoding) ...
1049 1065 -----END CERTIFICATE-----
1050 1066 -----BEGIN CERTIFICATE-----
1051 1067 ... (certificate in base64 PEM encoding) ...
1052 1068 -----END CERTIFICATE-----
1053 1069
1054 1070 For example::
1055 1071
1056 1072 [hostsecurity]
1057 1073 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1058 1074 hg2.example.com:fingerprints = sha1:914f1aff87249c09b6859b88b1906d30756491ca, sha1:fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1059 1075 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1060 1076
1077 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1078 when connecting to ``hg.example.com``::
1079
1080 [hostsecurity]
1081 minimumprotocol = tls1.2
1082 hg.example.com:minimumprotocol = tls1.1
1083
1061 1084 ``http_proxy``
1062 1085 --------------
1063 1086
1064 1087 Used to access web-based Mercurial repositories through a HTTP
1065 1088 proxy.
1066 1089
1067 1090 ``host``
1068 1091 Host name and (optional) port of the proxy server, for example
1069 1092 "myproxy:8000".
1070 1093
1071 1094 ``no``
1072 1095 Optional. Comma-separated list of host names that should bypass
1073 1096 the proxy.
1074 1097
1075 1098 ``passwd``
1076 1099 Optional. Password to authenticate with at the proxy server.
1077 1100
1078 1101 ``user``
1079 1102 Optional. User name to authenticate with at the proxy server.
1080 1103
1081 1104 ``always``
1082 1105 Optional. Always use the proxy, even for localhost and any entries
1083 1106 in ``http_proxy.no``. (default: False)
1084 1107
1085 1108 ``merge``
1086 1109 ---------
1087 1110
1088 1111 This section specifies behavior during merges and updates.
1089 1112
1090 1113 ``checkignored``
1091 1114 Controls behavior when an ignored file on disk has the same name as a tracked
1092 1115 file in the changeset being merged or updated to, and has different
1093 1116 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1094 1117 abort on such files. With ``warn``, warn on such files and back them up as
1095 1118 ``.orig``. With ``ignore``, don't print a warning and back them up as
1096 1119 ``.orig``. (default: ``abort``)
1097 1120
1098 1121 ``checkunknown``
1099 1122 Controls behavior when an unknown file that isn't ignored has the same name
1100 1123 as a tracked file in the changeset being merged or updated to, and has
1101 1124 different contents. Similar to ``merge.checkignored``, except for files that
1102 1125 are not ignored. (default: ``abort``)
1103 1126
1104 1127 ``merge-patterns``
1105 1128 ------------------
1106 1129
1107 1130 This section specifies merge tools to associate with particular file
1108 1131 patterns. Tools matched here will take precedence over the default
1109 1132 merge tool. Patterns are globs by default, rooted at the repository
1110 1133 root.
1111 1134
1112 1135 Example::
1113 1136
1114 1137 [merge-patterns]
1115 1138 **.c = kdiff3
1116 1139 **.jpg = myimgmerge
1117 1140
1118 1141 ``merge-tools``
1119 1142 ---------------
1120 1143
1121 1144 This section configures external merge tools to use for file-level
1122 1145 merges. This section has likely been preconfigured at install time.
1123 1146 Use :hg:`config merge-tools` to check the existing configuration.
1124 1147 Also see :hg:`help merge-tools` for more details.
1125 1148
1126 1149 Example ``~/.hgrc``::
1127 1150
1128 1151 [merge-tools]
1129 1152 # Override stock tool location
1130 1153 kdiff3.executable = ~/bin/kdiff3
1131 1154 # Specify command line
1132 1155 kdiff3.args = $base $local $other -o $output
1133 1156 # Give higher priority
1134 1157 kdiff3.priority = 1
1135 1158
1136 1159 # Changing the priority of preconfigured tool
1137 1160 meld.priority = 0
1138 1161
1139 1162 # Disable a preconfigured tool
1140 1163 vimdiff.disabled = yes
1141 1164
1142 1165 # Define new tool
1143 1166 myHtmlTool.args = -m $local $other $base $output
1144 1167 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1145 1168 myHtmlTool.priority = 1
1146 1169
1147 1170 Supported arguments:
1148 1171
1149 1172 ``priority``
1150 1173 The priority in which to evaluate this tool.
1151 1174 (default: 0)
1152 1175
1153 1176 ``executable``
1154 1177 Either just the name of the executable or its pathname.
1155 1178
1156 1179 .. container:: windows
1157 1180
1158 1181 On Windows, the path can use environment variables with ${ProgramFiles}
1159 1182 syntax.
1160 1183
1161 1184 (default: the tool name)
1162 1185
1163 1186 ``args``
1164 1187 The arguments to pass to the tool executable. You can refer to the
1165 1188 files being merged as well as the output file through these
1166 1189 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
1167 1190 of ``$local`` and ``$other`` can vary depending on which action is being
1168 1191 performed. During and update or merge, ``$local`` represents the original
1169 1192 state of the file, while ``$other`` represents the commit you are updating
1170 1193 to or the commit you are merging with. During a rebase ``$local``
1171 1194 represents the destination of the rebase, and ``$other`` represents the
1172 1195 commit being rebased.
1173 1196 (default: ``$local $base $other``)
1174 1197
1175 1198 ``premerge``
1176 1199 Attempt to run internal non-interactive 3-way merge tool before
1177 1200 launching external tool. Options are ``true``, ``false``, ``keep`` or
1178 1201 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1179 1202 premerge fails. The ``keep-merge3`` will do the same but include information
1180 1203 about the base of the merge in the marker (see internal :merge3 in
1181 1204 :hg:`help merge-tools`).
1182 1205 (default: True)
1183 1206
1184 1207 ``binary``
1185 1208 This tool can merge binary files. (default: False, unless tool
1186 1209 was selected by file pattern match)
1187 1210
1188 1211 ``symlink``
1189 1212 This tool can merge symlinks. (default: False)
1190 1213
1191 1214 ``check``
1192 1215 A list of merge success-checking options:
1193 1216
1194 1217 ``changed``
1195 1218 Ask whether merge was successful when the merged file shows no changes.
1196 1219 ``conflicts``
1197 1220 Check whether there are conflicts even though the tool reported success.
1198 1221 ``prompt``
1199 1222 Always prompt for merge success, regardless of success reported by tool.
1200 1223
1201 1224 ``fixeol``
1202 1225 Attempt to fix up EOL changes caused by the merge tool.
1203 1226 (default: False)
1204 1227
1205 1228 ``gui``
1206 1229 This tool requires a graphical interface to run. (default: False)
1207 1230
1208 1231 .. container:: windows
1209 1232
1210 1233 ``regkey``
1211 1234 Windows registry key which describes install location of this
1212 1235 tool. Mercurial will search for this key first under
1213 1236 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1214 1237 (default: None)
1215 1238
1216 1239 ``regkeyalt``
1217 1240 An alternate Windows registry key to try if the first key is not
1218 1241 found. The alternate key uses the same ``regname`` and ``regappend``
1219 1242 semantics of the primary key. The most common use for this key
1220 1243 is to search for 32bit applications on 64bit operating systems.
1221 1244 (default: None)
1222 1245
1223 1246 ``regname``
1224 1247 Name of value to read from specified registry key.
1225 1248 (default: the unnamed (default) value)
1226 1249
1227 1250 ``regappend``
1228 1251 String to append to the value read from the registry, typically
1229 1252 the executable name of the tool.
1230 1253 (default: None)
1231 1254
1232 1255
1233 1256 ``patch``
1234 1257 ---------
1235 1258
1236 1259 Settings used when applying patches, for instance through the 'import'
1237 1260 command or with Mercurial Queues extension.
1238 1261
1239 1262 ``eol``
1240 1263 When set to 'strict' patch content and patched files end of lines
1241 1264 are preserved. When set to ``lf`` or ``crlf``, both files end of
1242 1265 lines are ignored when patching and the result line endings are
1243 1266 normalized to either LF (Unix) or CRLF (Windows). When set to
1244 1267 ``auto``, end of lines are again ignored while patching but line
1245 1268 endings in patched files are normalized to their original setting
1246 1269 on a per-file basis. If target file does not exist or has no end
1247 1270 of line, patch line endings are preserved.
1248 1271 (default: strict)
1249 1272
1250 1273 ``fuzz``
1251 1274 The number of lines of 'fuzz' to allow when applying patches. This
1252 1275 controls how much context the patcher is allowed to ignore when
1253 1276 trying to apply a patch.
1254 1277 (default: 2)
1255 1278
1256 1279 ``paths``
1257 1280 ---------
1258 1281
1259 1282 Assigns symbolic names and behavior to repositories.
1260 1283
1261 1284 Options are symbolic names defining the URL or directory that is the
1262 1285 location of the repository. Example::
1263 1286
1264 1287 [paths]
1265 1288 my_server = https://example.com/my_repo
1266 1289 local_path = /home/me/repo
1267 1290
1268 1291 These symbolic names can be used from the command line. To pull
1269 1292 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1270 1293 :hg:`push local_path`.
1271 1294
1272 1295 Options containing colons (``:``) denote sub-options that can influence
1273 1296 behavior for that specific path. Example::
1274 1297
1275 1298 [paths]
1276 1299 my_server = https://example.com/my_path
1277 1300 my_server:pushurl = ssh://example.com/my_path
1278 1301
1279 1302 The following sub-options can be defined:
1280 1303
1281 1304 ``pushurl``
1282 1305 The URL to use for push operations. If not defined, the location
1283 1306 defined by the path's main entry is used.
1284 1307
1285 1308 ``pushrev``
1286 1309 A revset defining which revisions to push by default.
1287 1310
1288 1311 When :hg:`push` is executed without a ``-r`` argument, the revset
1289 1312 defined by this sub-option is evaluated to determine what to push.
1290 1313
1291 1314 For example, a value of ``.`` will push the working directory's
1292 1315 revision by default.
1293 1316
1294 1317 Revsets specifying bookmarks will not result in the bookmark being
1295 1318 pushed.
1296 1319
1297 1320 The following special named paths exist:
1298 1321
1299 1322 ``default``
1300 1323 The URL or directory to use when no source or remote is specified.
1301 1324
1302 1325 :hg:`clone` will automatically define this path to the location the
1303 1326 repository was cloned from.
1304 1327
1305 1328 ``default-push``
1306 1329 (deprecated) The URL or directory for the default :hg:`push` location.
1307 1330 ``default:pushurl`` should be used instead.
1308 1331
1309 1332 ``phases``
1310 1333 ----------
1311 1334
1312 1335 Specifies default handling of phases. See :hg:`help phases` for more
1313 1336 information about working with phases.
1314 1337
1315 1338 ``publish``
1316 1339 Controls draft phase behavior when working as a server. When true,
1317 1340 pushed changesets are set to public in both client and server and
1318 1341 pulled or cloned changesets are set to public in the client.
1319 1342 (default: True)
1320 1343
1321 1344 ``new-commit``
1322 1345 Phase of newly-created commits.
1323 1346 (default: draft)
1324 1347
1325 1348 ``checksubrepos``
1326 1349 Check the phase of the current revision of each subrepository. Allowed
1327 1350 values are "ignore", "follow" and "abort". For settings other than
1328 1351 "ignore", the phase of the current revision of each subrepository is
1329 1352 checked before committing the parent repository. If any of those phases is
1330 1353 greater than the phase of the parent repository (e.g. if a subrepo is in a
1331 1354 "secret" phase while the parent repo is in "draft" phase), the commit is
1332 1355 either aborted (if checksubrepos is set to "abort") or the higher phase is
1333 1356 used for the parent repository commit (if set to "follow").
1334 1357 (default: follow)
1335 1358
1336 1359
1337 1360 ``profiling``
1338 1361 -------------
1339 1362
1340 1363 Specifies profiling type, format, and file output. Two profilers are
1341 1364 supported: an instrumenting profiler (named ``ls``), and a sampling
1342 1365 profiler (named ``stat``).
1343 1366
1344 1367 In this section description, 'profiling data' stands for the raw data
1345 1368 collected during profiling, while 'profiling report' stands for a
1346 1369 statistical text report generated from the profiling data. The
1347 1370 profiling is done using lsprof.
1348 1371
1349 1372 ``type``
1350 1373 The type of profiler to use.
1351 1374 (default: ls)
1352 1375
1353 1376 ``ls``
1354 1377 Use Python's built-in instrumenting profiler. This profiler
1355 1378 works on all platforms, but each line number it reports is the
1356 1379 first line of a function. This restriction makes it difficult to
1357 1380 identify the expensive parts of a non-trivial function.
1358 1381 ``stat``
1359 1382 Use a third-party statistical profiler, statprof. This profiler
1360 1383 currently runs only on Unix systems, and is most useful for
1361 1384 profiling commands that run for longer than about 0.1 seconds.
1362 1385
1363 1386 ``format``
1364 1387 Profiling format. Specific to the ``ls`` instrumenting profiler.
1365 1388 (default: text)
1366 1389
1367 1390 ``text``
1368 1391 Generate a profiling report. When saving to a file, it should be
1369 1392 noted that only the report is saved, and the profiling data is
1370 1393 not kept.
1371 1394 ``kcachegrind``
1372 1395 Format profiling data for kcachegrind use: when saving to a
1373 1396 file, the generated file can directly be loaded into
1374 1397 kcachegrind.
1375 1398
1376 1399 ``frequency``
1377 1400 Sampling frequency. Specific to the ``stat`` sampling profiler.
1378 1401 (default: 1000)
1379 1402
1380 1403 ``output``
1381 1404 File path where profiling data or report should be saved. If the
1382 1405 file exists, it is replaced. (default: None, data is printed on
1383 1406 stderr)
1384 1407
1385 1408 ``sort``
1386 1409 Sort field. Specific to the ``ls`` instrumenting profiler.
1387 1410 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1388 1411 ``inlinetime``.
1389 1412 (default: inlinetime)
1390 1413
1391 1414 ``limit``
1392 1415 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1393 1416 (default: 30)
1394 1417
1395 1418 ``nested``
1396 1419 Show at most this number of lines of drill-down info after each main entry.
1397 1420 This can help explain the difference between Total and Inline.
1398 1421 Specific to the ``ls`` instrumenting profiler.
1399 1422 (default: 5)
1400 1423
1401 1424 ``progress``
1402 1425 ------------
1403 1426
1404 1427 Mercurial commands can draw progress bars that are as informative as
1405 1428 possible. Some progress bars only offer indeterminate information, while others
1406 1429 have a definite end point.
1407 1430
1408 1431 ``delay``
1409 1432 Number of seconds (float) before showing the progress bar. (default: 3)
1410 1433
1411 1434 ``changedelay``
1412 1435 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1413 1436 that value will be used instead. (default: 1)
1414 1437
1415 1438 ``refresh``
1416 1439 Time in seconds between refreshes of the progress bar. (default: 0.1)
1417 1440
1418 1441 ``format``
1419 1442 Format of the progress bar.
1420 1443
1421 1444 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1422 1445 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1423 1446 last 20 characters of the item, but this can be changed by adding either
1424 1447 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1425 1448 first num characters.
1426 1449
1427 1450 (default: topic bar number estimate)
1428 1451
1429 1452 ``width``
1430 1453 If set, the maximum width of the progress information (that is, min(width,
1431 1454 term width) will be used).
1432 1455
1433 1456 ``clear-complete``
1434 1457 Clear the progress bar after it's done. (default: True)
1435 1458
1436 1459 ``disable``
1437 1460 If true, don't show a progress bar.
1438 1461
1439 1462 ``assume-tty``
1440 1463 If true, ALWAYS show a progress bar, unless disable is given.
1441 1464
1442 1465 ``rebase``
1443 1466 ----------
1444 1467
1445 1468 ``allowdivergence``
1446 1469 Default to False, when True allow creating divergence when performing
1447 1470 rebase of obsolete changesets.
1448 1471
1449 1472 ``revsetalias``
1450 1473 ---------------
1451 1474
1452 1475 Alias definitions for revsets. See :hg:`help revsets` for details.
1453 1476
1454 1477 ``server``
1455 1478 ----------
1456 1479
1457 1480 Controls generic server settings.
1458 1481
1459 1482 ``uncompressed``
1460 1483 Whether to allow clients to clone a repository using the
1461 1484 uncompressed streaming protocol. This transfers about 40% more
1462 1485 data than a regular clone, but uses less memory and CPU on both
1463 1486 server and client. Over a LAN (100 Mbps or better) or a very fast
1464 1487 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1465 1488 regular clone. Over most WAN connections (anything slower than
1466 1489 about 6 Mbps), uncompressed streaming is slower, because of the
1467 1490 extra data transfer overhead. This mode will also temporarily hold
1468 1491 the write lock while determining what data to transfer.
1469 1492 (default: True)
1470 1493
1471 1494 ``preferuncompressed``
1472 1495 When set, clients will try to use the uncompressed streaming
1473 1496 protocol. (default: False)
1474 1497
1475 1498 ``validate``
1476 1499 Whether to validate the completeness of pushed changesets by
1477 1500 checking that all new file revisions specified in manifests are
1478 1501 present. (default: False)
1479 1502
1480 1503 ``maxhttpheaderlen``
1481 1504 Instruct HTTP clients not to send request headers longer than this
1482 1505 many bytes. (default: 1024)
1483 1506
1484 1507 ``bundle1``
1485 1508 Whether to allow clients to push and pull using the legacy bundle1
1486 1509 exchange format. (default: True)
1487 1510
1488 1511 ``bundle1gd``
1489 1512 Like ``bundle1`` but only used if the repository is using the
1490 1513 *generaldelta* storage format. (default: True)
1491 1514
1492 1515 ``bundle1.push``
1493 1516 Whether to allow clients to push using the legacy bundle1 exchange
1494 1517 format. (default: True)
1495 1518
1496 1519 ``bundle1gd.push``
1497 1520 Like ``bundle1.push`` but only used if the repository is using the
1498 1521 *generaldelta* storage format. (default: True)
1499 1522
1500 1523 ``bundle1.pull``
1501 1524 Whether to allow clients to pull using the legacy bundle1 exchange
1502 1525 format. (default: True)
1503 1526
1504 1527 ``bundle1gd.pull``
1505 1528 Like ``bundle1.pull`` but only used if the repository is using the
1506 1529 *generaldelta* storage format. (default: True)
1507 1530
1508 1531 Large repositories using the *generaldelta* storage format should
1509 1532 consider setting this option because converting *generaldelta*
1510 1533 repositories to the exchange format required by the bundle1 data
1511 1534 format can consume a lot of CPU.
1512 1535
1513 1536 ``smtp``
1514 1537 --------
1515 1538
1516 1539 Configuration for extensions that need to send email messages.
1517 1540
1518 1541 ``host``
1519 1542 Host name of mail server, e.g. "mail.example.com".
1520 1543
1521 1544 ``port``
1522 1545 Optional. Port to connect to on mail server. (default: 465 if
1523 1546 ``tls`` is smtps; 25 otherwise)
1524 1547
1525 1548 ``tls``
1526 1549 Optional. Method to enable TLS when connecting to mail server: starttls,
1527 1550 smtps or none. (default: none)
1528 1551
1529 1552 ``username``
1530 1553 Optional. User name for authenticating with the SMTP server.
1531 1554 (default: None)
1532 1555
1533 1556 ``password``
1534 1557 Optional. Password for authenticating with the SMTP server. If not
1535 1558 specified, interactive sessions will prompt the user for a
1536 1559 password; non-interactive sessions will fail. (default: None)
1537 1560
1538 1561 ``local_hostname``
1539 1562 Optional. The hostname that the sender can use to identify
1540 1563 itself to the MTA.
1541 1564
1542 1565
1543 1566 ``subpaths``
1544 1567 ------------
1545 1568
1546 1569 Subrepository source URLs can go stale if a remote server changes name
1547 1570 or becomes temporarily unavailable. This section lets you define
1548 1571 rewrite rules of the form::
1549 1572
1550 1573 <pattern> = <replacement>
1551 1574
1552 1575 where ``pattern`` is a regular expression matching a subrepository
1553 1576 source URL and ``replacement`` is the replacement string used to
1554 1577 rewrite it. Groups can be matched in ``pattern`` and referenced in
1555 1578 ``replacements``. For instance::
1556 1579
1557 1580 http://server/(.*)-hg/ = http://hg.server/\1/
1558 1581
1559 1582 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1560 1583
1561 1584 Relative subrepository paths are first made absolute, and the
1562 1585 rewrite rules are then applied on the full (absolute) path. If ``pattern``
1563 1586 doesn't match the full path, an attempt is made to apply it on the
1564 1587 relative path alone. The rules are applied in definition order.
1565 1588
1566 1589 ``templatealias``
1567 1590 -----------------
1568 1591
1569 1592 Alias definitions for templates. See :hg:`help templates` for details.
1570 1593
1571 1594 ``trusted``
1572 1595 -----------
1573 1596
1574 1597 Mercurial will not use the settings in the
1575 1598 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1576 1599 user or to a trusted group, as various hgrc features allow arbitrary
1577 1600 commands to be run. This issue is often encountered when configuring
1578 1601 hooks or extensions for shared repositories or servers. However,
1579 1602 the web interface will use some safe settings from the ``[web]``
1580 1603 section.
1581 1604
1582 1605 This section specifies what users and groups are trusted. The
1583 1606 current user is always trusted. To trust everybody, list a user or a
1584 1607 group with name ``*``. These settings must be placed in an
1585 1608 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1586 1609 user or service running Mercurial.
1587 1610
1588 1611 ``users``
1589 1612 Comma-separated list of trusted users.
1590 1613
1591 1614 ``groups``
1592 1615 Comma-separated list of trusted groups.
1593 1616
1594 1617
1595 1618 ``ui``
1596 1619 ------
1597 1620
1598 1621 User interface controls.
1599 1622
1600 1623 ``archivemeta``
1601 1624 Whether to include the .hg_archival.txt file containing meta data
1602 1625 (hashes for the repository base and for tip) in archives created
1603 1626 by the :hg:`archive` command or downloaded via hgweb.
1604 1627 (default: True)
1605 1628
1606 1629 ``askusername``
1607 1630 Whether to prompt for a username when committing. If True, and
1608 1631 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1609 1632 be prompted to enter a username. If no username is entered, the
1610 1633 default ``USER@HOST`` is used instead.
1611 1634 (default: False)
1612 1635
1613 1636 ``clonebundles``
1614 1637 Whether the "clone bundles" feature is enabled.
1615 1638
1616 1639 When enabled, :hg:`clone` may download and apply a server-advertised
1617 1640 bundle file from a URL instead of using the normal exchange mechanism.
1618 1641
1619 1642 This can likely result in faster and more reliable clones.
1620 1643
1621 1644 (default: True)
1622 1645
1623 1646 ``clonebundlefallback``
1624 1647 Whether failure to apply an advertised "clone bundle" from a server
1625 1648 should result in fallback to a regular clone.
1626 1649
1627 1650 This is disabled by default because servers advertising "clone
1628 1651 bundles" often do so to reduce server load. If advertised bundles
1629 1652 start mass failing and clients automatically fall back to a regular
1630 1653 clone, this would add significant and unexpected load to the server
1631 1654 since the server is expecting clone operations to be offloaded to
1632 1655 pre-generated bundles. Failing fast (the default behavior) ensures
1633 1656 clients don't overwhelm the server when "clone bundle" application
1634 1657 fails.
1635 1658
1636 1659 (default: False)
1637 1660
1638 1661 ``clonebundleprefers``
1639 1662 Defines preferences for which "clone bundles" to use.
1640 1663
1641 1664 Servers advertising "clone bundles" may advertise multiple available
1642 1665 bundles. Each bundle may have different attributes, such as the bundle
1643 1666 type and compression format. This option is used to prefer a particular
1644 1667 bundle over another.
1645 1668
1646 1669 The following keys are defined by Mercurial:
1647 1670
1648 1671 BUNDLESPEC
1649 1672 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
1650 1673 e.g. ``gzip-v2`` or ``bzip2-v1``.
1651 1674
1652 1675 COMPRESSION
1653 1676 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
1654 1677
1655 1678 Server operators may define custom keys.
1656 1679
1657 1680 Example values: ``COMPRESSION=bzip2``,
1658 1681 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
1659 1682
1660 1683 By default, the first bundle advertised by the server is used.
1661 1684
1662 1685 ``commitsubrepos``
1663 1686 Whether to commit modified subrepositories when committing the
1664 1687 parent repository. If False and one subrepository has uncommitted
1665 1688 changes, abort the commit.
1666 1689 (default: False)
1667 1690
1668 1691 ``debug``
1669 1692 Print debugging information. (default: False)
1670 1693
1671 1694 ``editor``
1672 1695 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
1673 1696
1674 1697 ``fallbackencoding``
1675 1698 Encoding to try if it's not possible to decode the changelog using
1676 1699 UTF-8. (default: ISO-8859-1)
1677 1700
1678 1701 ``graphnodetemplate``
1679 1702 The template used to print changeset nodes in an ASCII revision graph.
1680 1703 (default: ``{graphnode}``)
1681 1704
1682 1705 ``ignore``
1683 1706 A file to read per-user ignore patterns from. This file should be
1684 1707 in the same format as a repository-wide .hgignore file. Filenames
1685 1708 are relative to the repository root. This option supports hook syntax,
1686 1709 so if you want to specify multiple ignore files, you can do so by
1687 1710 setting something like ``ignore.other = ~/.hgignore2``. For details
1688 1711 of the ignore file format, see the ``hgignore(5)`` man page.
1689 1712
1690 1713 ``interactive``
1691 1714 Allow to prompt the user. (default: True)
1692 1715
1693 1716 ``interface``
1694 1717 Select the default interface for interactive features (default: text).
1695 1718 Possible values are 'text' and 'curses'.
1696 1719
1697 1720 ``interface.chunkselector``
1698 1721 Select the interface for change recording (e.g. :hg:`commit` -i).
1699 1722 Possible values are 'text' and 'curses'.
1700 1723 This config overrides the interface specified by ui.interface.
1701 1724
1702 1725 ``logtemplate``
1703 1726 Template string for commands that print changesets.
1704 1727
1705 1728 ``merge``
1706 1729 The conflict resolution program to use during a manual merge.
1707 1730 For more information on merge tools see :hg:`help merge-tools`.
1708 1731 For configuring merge tools see the ``[merge-tools]`` section.
1709 1732
1710 1733 ``mergemarkers``
1711 1734 Sets the merge conflict marker label styling. The ``detailed``
1712 1735 style uses the ``mergemarkertemplate`` setting to style the labels.
1713 1736 The ``basic`` style just uses 'local' and 'other' as the marker label.
1714 1737 One of ``basic`` or ``detailed``.
1715 1738 (default: ``basic``)
1716 1739
1717 1740 ``mergemarkertemplate``
1718 1741 The template used to print the commit description next to each conflict
1719 1742 marker during merge conflicts. See :hg:`help templates` for the template
1720 1743 format.
1721 1744
1722 1745 Defaults to showing the hash, tags, branches, bookmarks, author, and
1723 1746 the first line of the commit description.
1724 1747
1725 1748 If you use non-ASCII characters in names for tags, branches, bookmarks,
1726 1749 authors, and/or commit descriptions, you must pay attention to encodings of
1727 1750 managed files. At template expansion, non-ASCII characters use the encoding
1728 1751 specified by the ``--encoding`` global option, ``HGENCODING`` or other
1729 1752 environment variables that govern your locale. If the encoding of the merge
1730 1753 markers is different from the encoding of the merged files,
1731 1754 serious problems may occur.
1732 1755
1733 1756 ``origbackuppath``
1734 1757 The path to a directory used to store generated .orig files. If the path is
1735 1758 not a directory, one will be created.
1736 1759
1737 1760 ``patch``
1738 1761 An optional external tool that ``hg import`` and some extensions
1739 1762 will use for applying patches. By default Mercurial uses an
1740 1763 internal patch utility. The external tool must work as the common
1741 1764 Unix ``patch`` program. In particular, it must accept a ``-p``
1742 1765 argument to strip patch headers, a ``-d`` argument to specify the
1743 1766 current directory, a file name to patch, and a patch file to take
1744 1767 from stdin.
1745 1768
1746 1769 It is possible to specify a patch tool together with extra
1747 1770 arguments. For example, setting this option to ``patch --merge``
1748 1771 will use the ``patch`` program with its 2-way merge option.
1749 1772
1750 1773 ``portablefilenames``
1751 1774 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1752 1775 (default: ``warn``)
1753 1776
1754 1777 ``warn``
1755 1778 Print a warning message on POSIX platforms, if a file with a non-portable
1756 1779 filename is added (e.g. a file with a name that can't be created on
1757 1780 Windows because it contains reserved parts like ``AUX``, reserved
1758 1781 characters like ``:``, or would cause a case collision with an existing
1759 1782 file).
1760 1783
1761 1784 ``ignore``
1762 1785 Don't print a warning.
1763 1786
1764 1787 ``abort``
1765 1788 The command is aborted.
1766 1789
1767 1790 ``true``
1768 1791 Alias for ``warn``.
1769 1792
1770 1793 ``false``
1771 1794 Alias for ``ignore``.
1772 1795
1773 1796 .. container:: windows
1774 1797
1775 1798 On Windows, this configuration option is ignored and the command aborted.
1776 1799
1777 1800 ``quiet``
1778 1801 Reduce the amount of output printed.
1779 1802 (default: False)
1780 1803
1781 1804 ``remotecmd``
1782 1805 Remote command to use for clone/push/pull operations.
1783 1806 (default: ``hg``)
1784 1807
1785 1808 ``report_untrusted``
1786 1809 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
1787 1810 trusted user or group.
1788 1811 (default: True)
1789 1812
1790 1813 ``slash``
1791 1814 Display paths using a slash (``/``) as the path separator. This
1792 1815 only makes a difference on systems where the default path
1793 1816 separator is not the slash character (e.g. Windows uses the
1794 1817 backslash character (``\``)).
1795 1818 (default: False)
1796 1819
1797 1820 ``statuscopies``
1798 1821 Display copies in the status command.
1799 1822
1800 1823 ``ssh``
1801 1824 Command to use for SSH connections. (default: ``ssh``)
1802 1825
1803 1826 ``strict``
1804 1827 Require exact command names, instead of allowing unambiguous
1805 1828 abbreviations. (default: False)
1806 1829
1807 1830 ``style``
1808 1831 Name of style to use for command output.
1809 1832
1810 1833 ``supportcontact``
1811 1834 A URL where users should report a Mercurial traceback. Use this if you are a
1812 1835 large organisation with its own Mercurial deployment process and crash
1813 1836 reports should be addressed to your internal support.
1814 1837
1815 1838 ``textwidth``
1816 1839 Maximum width of help text. A longer line generated by ``hg help`` or
1817 1840 ``hg subcommand --help`` will be broken after white space to get this
1818 1841 width or the terminal width, whichever comes first.
1819 1842 A non-positive value will disable this and the terminal width will be
1820 1843 used. (default: 78)
1821 1844
1822 1845 ``timeout``
1823 1846 The timeout used when a lock is held (in seconds), a negative value
1824 1847 means no timeout. (default: 600)
1825 1848
1826 1849 ``traceback``
1827 1850 Mercurial always prints a traceback when an unknown exception
1828 1851 occurs. Setting this to True will make Mercurial print a traceback
1829 1852 on all exceptions, even those recognized by Mercurial (such as
1830 1853 IOError or MemoryError). (default: False)
1831 1854
1832 1855 ``username``
1833 1856 The committer of a changeset created when running "commit".
1834 1857 Typically a person's name and email address, e.g. ``Fred Widget
1835 1858 <fred@example.com>``. Environment variables in the
1836 1859 username are expanded.
1837 1860
1838 1861 (default: ``$EMAIL`` or ``username@hostname``. If the username in
1839 1862 hgrc is empty, e.g. if the system admin set ``username =`` in the
1840 1863 system hgrc, it has to be specified manually or in a different
1841 1864 hgrc file)
1842 1865
1843 1866 ``verbose``
1844 1867 Increase the amount of output printed. (default: False)
1845 1868
1846 1869
1847 1870 ``web``
1848 1871 -------
1849 1872
1850 1873 Web interface configuration. The settings in this section apply to
1851 1874 both the builtin webserver (started by :hg:`serve`) and the script you
1852 1875 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
1853 1876 and WSGI).
1854 1877
1855 1878 The Mercurial webserver does no authentication (it does not prompt for
1856 1879 usernames and passwords to validate *who* users are), but it does do
1857 1880 authorization (it grants or denies access for *authenticated users*
1858 1881 based on settings in this section). You must either configure your
1859 1882 webserver to do authentication for you, or disable the authorization
1860 1883 checks.
1861 1884
1862 1885 For a quick setup in a trusted environment, e.g., a private LAN, where
1863 1886 you want it to accept pushes from anybody, you can use the following
1864 1887 command line::
1865 1888
1866 1889 $ hg --config web.allow_push=* --config web.push_ssl=False serve
1867 1890
1868 1891 Note that this will allow anybody to push anything to the server and
1869 1892 that this should not be used for public servers.
1870 1893
1871 1894 The full set of options is:
1872 1895
1873 1896 ``accesslog``
1874 1897 Where to output the access log. (default: stdout)
1875 1898
1876 1899 ``address``
1877 1900 Interface address to bind to. (default: all)
1878 1901
1879 1902 ``allow_archive``
1880 1903 List of archive format (bz2, gz, zip) allowed for downloading.
1881 1904 (default: empty)
1882 1905
1883 1906 ``allowbz2``
1884 1907 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
1885 1908 revisions.
1886 1909 (default: False)
1887 1910
1888 1911 ``allowgz``
1889 1912 (DEPRECATED) Whether to allow .tar.gz downloading of repository
1890 1913 revisions.
1891 1914 (default: False)
1892 1915
1893 1916 ``allowpull``
1894 1917 Whether to allow pulling from the repository. (default: True)
1895 1918
1896 1919 ``allow_push``
1897 1920 Whether to allow pushing to the repository. If empty or not set,
1898 1921 pushing is not allowed. If the special value ``*``, any remote
1899 1922 user can push, including unauthenticated users. Otherwise, the
1900 1923 remote user must have been authenticated, and the authenticated
1901 1924 user name must be present in this list. The contents of the
1902 1925 allow_push list are examined after the deny_push list.
1903 1926
1904 1927 ``allow_read``
1905 1928 If the user has not already been denied repository access due to
1906 1929 the contents of deny_read, this list determines whether to grant
1907 1930 repository access to the user. If this list is not empty, and the
1908 1931 user is unauthenticated or not present in the list, then access is
1909 1932 denied for the user. If the list is empty or not set, then access
1910 1933 is permitted to all users by default. Setting allow_read to the
1911 1934 special value ``*`` is equivalent to it not being set (i.e. access
1912 1935 is permitted to all users). The contents of the allow_read list are
1913 1936 examined after the deny_read list.
1914 1937
1915 1938 ``allowzip``
1916 1939 (DEPRECATED) Whether to allow .zip downloading of repository
1917 1940 revisions. This feature creates temporary files.
1918 1941 (default: False)
1919 1942
1920 1943 ``archivesubrepos``
1921 1944 Whether to recurse into subrepositories when archiving.
1922 1945 (default: False)
1923 1946
1924 1947 ``baseurl``
1925 1948 Base URL to use when publishing URLs in other locations, so
1926 1949 third-party tools like email notification hooks can construct
1927 1950 URLs. Example: ``http://hgserver/repos/``.
1928 1951
1929 1952 ``cacerts``
1930 1953 Path to file containing a list of PEM encoded certificate
1931 1954 authority certificates. Environment variables and ``~user``
1932 1955 constructs are expanded in the filename. If specified on the
1933 1956 client, then it will verify the identity of remote HTTPS servers
1934 1957 with these certificates.
1935 1958
1936 1959 To disable SSL verification temporarily, specify ``--insecure`` from
1937 1960 command line.
1938 1961
1939 1962 You can use OpenSSL's CA certificate file if your platform has
1940 1963 one. On most Linux systems this will be
1941 1964 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
1942 1965 generate this file manually. The form must be as follows::
1943 1966
1944 1967 -----BEGIN CERTIFICATE-----
1945 1968 ... (certificate in base64 PEM encoding) ...
1946 1969 -----END CERTIFICATE-----
1947 1970 -----BEGIN CERTIFICATE-----
1948 1971 ... (certificate in base64 PEM encoding) ...
1949 1972 -----END CERTIFICATE-----
1950 1973
1951 1974 ``cache``
1952 1975 Whether to support caching in hgweb. (default: True)
1953 1976
1954 1977 ``certificate``
1955 1978 Certificate to use when running :hg:`serve`.
1956 1979
1957 1980 ``collapse``
1958 1981 With ``descend`` enabled, repositories in subdirectories are shown at
1959 1982 a single level alongside repositories in the current path. With
1960 1983 ``collapse`` also enabled, repositories residing at a deeper level than
1961 1984 the current path are grouped behind navigable directory entries that
1962 1985 lead to the locations of these repositories. In effect, this setting
1963 1986 collapses each collection of repositories found within a subdirectory
1964 1987 into a single entry for that subdirectory. (default: False)
1965 1988
1966 1989 ``comparisoncontext``
1967 1990 Number of lines of context to show in side-by-side file comparison. If
1968 1991 negative or the value ``full``, whole files are shown. (default: 5)
1969 1992
1970 1993 This setting can be overridden by a ``context`` request parameter to the
1971 1994 ``comparison`` command, taking the same values.
1972 1995
1973 1996 ``contact``
1974 1997 Name or email address of the person in charge of the repository.
1975 1998 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
1976 1999
1977 2000 ``deny_push``
1978 2001 Whether to deny pushing to the repository. If empty or not set,
1979 2002 push is not denied. If the special value ``*``, all remote users are
1980 2003 denied push. Otherwise, unauthenticated users are all denied, and
1981 2004 any authenticated user name present in this list is also denied. The
1982 2005 contents of the deny_push list are examined before the allow_push list.
1983 2006
1984 2007 ``deny_read``
1985 2008 Whether to deny reading/viewing of the repository. If this list is
1986 2009 not empty, unauthenticated users are all denied, and any
1987 2010 authenticated user name present in this list is also denied access to
1988 2011 the repository. If set to the special value ``*``, all remote users
1989 2012 are denied access (rarely needed ;). If deny_read is empty or not set,
1990 2013 the determination of repository access depends on the presence and
1991 2014 content of the allow_read list (see description). If both
1992 2015 deny_read and allow_read are empty or not set, then access is
1993 2016 permitted to all users by default. If the repository is being
1994 2017 served via hgwebdir, denied users will not be able to see it in
1995 2018 the list of repositories. The contents of the deny_read list have
1996 2019 priority over (are examined before) the contents of the allow_read
1997 2020 list.
1998 2021
1999 2022 ``descend``
2000 2023 hgwebdir indexes will not descend into subdirectories. Only repositories
2001 2024 directly in the current path will be shown (other repositories are still
2002 2025 available from the index corresponding to their containing path).
2003 2026
2004 2027 ``description``
2005 2028 Textual description of the repository's purpose or contents.
2006 2029 (default: "unknown")
2007 2030
2008 2031 ``encoding``
2009 2032 Character encoding name. (default: the current locale charset)
2010 2033 Example: "UTF-8".
2011 2034
2012 2035 ``errorlog``
2013 2036 Where to output the error log. (default: stderr)
2014 2037
2015 2038 ``guessmime``
2016 2039 Control MIME types for raw download of file content.
2017 2040 Set to True to let hgweb guess the content type from the file
2018 2041 extension. This will serve HTML files as ``text/html`` and might
2019 2042 allow cross-site scripting attacks when serving untrusted
2020 2043 repositories. (default: False)
2021 2044
2022 2045 ``hidden``
2023 2046 Whether to hide the repository in the hgwebdir index.
2024 2047 (default: False)
2025 2048
2026 2049 ``ipv6``
2027 2050 Whether to use IPv6. (default: False)
2028 2051
2029 2052 ``labels``
2030 2053 List of string *labels* associated with the repository.
2031 2054
2032 2055 Labels are exposed as a template keyword and can be used to customize
2033 2056 output. e.g. the ``index`` template can group or filter repositories
2034 2057 by labels and the ``summary`` template can display additional content
2035 2058 if a specific label is present.
2036 2059
2037 2060 ``logoimg``
2038 2061 File name of the logo image that some templates display on each page.
2039 2062 The file name is relative to ``staticurl``. That is, the full path to
2040 2063 the logo image is "staticurl/logoimg".
2041 2064 If unset, ``hglogo.png`` will be used.
2042 2065
2043 2066 ``logourl``
2044 2067 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2045 2068 will be used.
2046 2069
2047 2070 ``maxchanges``
2048 2071 Maximum number of changes to list on the changelog. (default: 10)
2049 2072
2050 2073 ``maxfiles``
2051 2074 Maximum number of files to list per changeset. (default: 10)
2052 2075
2053 2076 ``maxshortchanges``
2054 2077 Maximum number of changes to list on the shortlog, graph or filelog
2055 2078 pages. (default: 60)
2056 2079
2057 2080 ``name``
2058 2081 Repository name to use in the web interface.
2059 2082 (default: current working directory)
2060 2083
2061 2084 ``port``
2062 2085 Port to listen on. (default: 8000)
2063 2086
2064 2087 ``prefix``
2065 2088 Prefix path to serve from. (default: '' (server root))
2066 2089
2067 2090 ``push_ssl``
2068 2091 Whether to require that inbound pushes be transported over SSL to
2069 2092 prevent password sniffing. (default: True)
2070 2093
2071 2094 ``refreshinterval``
2072 2095 How frequently directory listings re-scan the filesystem for new
2073 2096 repositories, in seconds. This is relevant when wildcards are used
2074 2097 to define paths. Depending on how much filesystem traversal is
2075 2098 required, refreshing may negatively impact performance.
2076 2099
2077 2100 Values less than or equal to 0 always refresh.
2078 2101 (default: 20)
2079 2102
2080 2103 ``staticurl``
2081 2104 Base URL to use for static files. If unset, static files (e.g. the
2082 2105 hgicon.png favicon) will be served by the CGI script itself. Use
2083 2106 this setting to serve them directly with the HTTP server.
2084 2107 Example: ``http://hgserver/static/``.
2085 2108
2086 2109 ``stripes``
2087 2110 How many lines a "zebra stripe" should span in multi-line output.
2088 2111 Set to 0 to disable. (default: 1)
2089 2112
2090 2113 ``style``
2091 2114 Which template map style to use. The available options are the names of
2092 2115 subdirectories in the HTML templates path. (default: ``paper``)
2093 2116 Example: ``monoblue``.
2094 2117
2095 2118 ``templates``
2096 2119 Where to find the HTML templates. The default path to the HTML templates
2097 2120 can be obtained from ``hg debuginstall``.
2098 2121
2099 2122 ``websub``
2100 2123 ----------
2101 2124
2102 2125 Web substitution filter definition. You can use this section to
2103 2126 define a set of regular expression substitution patterns which
2104 2127 let you automatically modify the hgweb server output.
2105 2128
2106 2129 The default hgweb templates only apply these substitution patterns
2107 2130 on the revision description fields. You can apply them anywhere
2108 2131 you want when you create your own templates by adding calls to the
2109 2132 "websub" filter (usually after calling the "escape" filter).
2110 2133
2111 2134 This can be used, for example, to convert issue references to links
2112 2135 to your issue tracker, or to convert "markdown-like" syntax into
2113 2136 HTML (see the examples below).
2114 2137
2115 2138 Each entry in this section names a substitution filter.
2116 2139 The value of each entry defines the substitution expression itself.
2117 2140 The websub expressions follow the old interhg extension syntax,
2118 2141 which in turn imitates the Unix sed replacement syntax::
2119 2142
2120 2143 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
2121 2144
2122 2145 You can use any separator other than "/". The final "i" is optional
2123 2146 and indicates that the search must be case insensitive.
2124 2147
2125 2148 Examples::
2126 2149
2127 2150 [websub]
2128 2151 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
2129 2152 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
2130 2153 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
2131 2154
2132 2155 ``worker``
2133 2156 ----------
2134 2157
2135 2158 Parallel master/worker configuration. We currently perform working
2136 2159 directory updates in parallel on Unix-like systems, which greatly
2137 2160 helps performance.
2138 2161
2139 2162 ``numcpus``
2140 2163 Number of CPUs to use for parallel operations. A zero or
2141 2164 negative value is treated as ``use the default``.
2142 2165 (default: 4 or the number of CPUs on the system, whichever is larger)
2143 2166
2144 2167 ``backgroundclose``
2145 2168 Whether to enable closing file handles on background threads during certain
2146 2169 operations. Some platforms aren't very efficient at closing file
2147 2170 handles that have been written or appended to. By performing file closing
2148 2171 on background threads, file write rate can increase substantially.
2149 2172 (default: true on Windows, false elsewhere)
2150 2173
2151 2174 ``backgroundcloseminfilecount``
2152 2175 Minimum number of files required to trigger background file closing.
2153 2176 Operations not writing this many files won't start background close
2154 2177 threads.
2155 2178 (default: 2048)
2156 2179
2157 2180 ``backgroundclosemaxqueue``
2158 2181 The maximum number of opened file handles waiting to be closed in the
2159 2182 background. This option only has an effect if ``backgroundclose`` is
2160 2183 enabled.
2161 2184 (default: 384)
2162 2185
2163 2186 ``backgroundclosethreadcount``
2164 2187 Number of threads to process background file closes. Only relevant if
2165 2188 ``backgroundclose`` is enabled.
2166 2189 (default: 4)
@@ -1,666 +1,733
1 1 # sslutil.py - SSL handling for mercurial
2 2 #
3 3 # Copyright 2005, 2006, 2007, 2008 Matt Mackall <mpm@selenic.com>
4 4 # Copyright 2006, 2007 Alexis S. L. Carvalho <alexis@cecm.usp.br>
5 5 # Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com>
6 6 #
7 7 # This software may be used and distributed according to the terms of the
8 8 # GNU General Public License version 2 or any later version.
9 9
10 10 from __future__ import absolute_import
11 11
12 12 import hashlib
13 13 import os
14 14 import re
15 15 import ssl
16 16 import sys
17 17
18 18 from .i18n import _
19 19 from . import (
20 20 error,
21 21 util,
22 22 )
23 23
24 24 # Python 2.7.9+ overhauled the built-in SSL/TLS features of Python. It added
25 25 # support for TLS 1.1, TLS 1.2, SNI, system CA stores, etc. These features are
26 26 # all exposed via the "ssl" module.
27 27 #
28 28 # Depending on the version of Python being used, SSL/TLS support is either
29 29 # modern/secure or legacy/insecure. Many operations in this module have
30 30 # separate code paths depending on support in Python.
31 31
32 hassni = getattr(ssl, 'HAS_SNI', False)
32 configprotocols = set([
33 'tls1.0',
34 'tls1.1',
35 'tls1.2',
36 ])
33 37
34 try:
35 OP_NO_SSLv2 = ssl.OP_NO_SSLv2
36 OP_NO_SSLv3 = ssl.OP_NO_SSLv3
37 except AttributeError:
38 OP_NO_SSLv2 = 0x1000000
39 OP_NO_SSLv3 = 0x2000000
38 hassni = getattr(ssl, 'HAS_SNI', False)
40 39
41 40 try:
42 41 # ssl.SSLContext was added in 2.7.9 and presence indicates modern
43 42 # SSL/TLS features are available.
44 43 SSLContext = ssl.SSLContext
45 44 modernssl = True
46 45 _canloaddefaultcerts = util.safehasattr(SSLContext, 'load_default_certs')
47 46 except AttributeError:
48 47 modernssl = False
49 48 _canloaddefaultcerts = False
50 49
51 50 # We implement SSLContext using the interface from the standard library.
52 51 class SSLContext(object):
53 52 # ssl.wrap_socket gained the "ciphers" named argument in 2.7.
54 53 _supportsciphers = sys.version_info >= (2, 7)
55 54
56 55 def __init__(self, protocol):
57 56 # From the public interface of SSLContext
58 57 self.protocol = protocol
59 58 self.check_hostname = False
60 59 self.options = 0
61 60 self.verify_mode = ssl.CERT_NONE
62 61
63 62 # Used by our implementation.
64 63 self._certfile = None
65 64 self._keyfile = None
66 65 self._certpassword = None
67 66 self._cacerts = None
68 67 self._ciphers = None
69 68
70 69 def load_cert_chain(self, certfile, keyfile=None, password=None):
71 70 self._certfile = certfile
72 71 self._keyfile = keyfile
73 72 self._certpassword = password
74 73
75 74 def load_default_certs(self, purpose=None):
76 75 pass
77 76
78 77 def load_verify_locations(self, cafile=None, capath=None, cadata=None):
79 78 if capath:
80 79 raise error.Abort(_('capath not supported'))
81 80 if cadata:
82 81 raise error.Abort(_('cadata not supported'))
83 82
84 83 self._cacerts = cafile
85 84
86 85 def set_ciphers(self, ciphers):
87 86 if not self._supportsciphers:
88 87 raise error.Abort(_('setting ciphers not supported'))
89 88
90 89 self._ciphers = ciphers
91 90
92 91 def wrap_socket(self, socket, server_hostname=None, server_side=False):
93 92 # server_hostname is unique to SSLContext.wrap_socket and is used
94 93 # for SNI in that context. So there's nothing for us to do with it
95 94 # in this legacy code since we don't support SNI.
96 95
97 96 args = {
98 97 'keyfile': self._keyfile,
99 98 'certfile': self._certfile,
100 99 'server_side': server_side,
101 100 'cert_reqs': self.verify_mode,
102 101 'ssl_version': self.protocol,
103 102 'ca_certs': self._cacerts,
104 103 }
105 104
106 105 if self._supportsciphers:
107 106 args['ciphers'] = self._ciphers
108 107
109 108 return ssl.wrap_socket(socket, **args)
110 109
111 110 def _hostsettings(ui, hostname):
112 111 """Obtain security settings for a hostname.
113 112
114 113 Returns a dict of settings relevant to that hostname.
115 114 """
116 115 s = {
117 116 # Whether we should attempt to load default/available CA certs
118 117 # if an explicit ``cafile`` is not defined.
119 118 'allowloaddefaultcerts': True,
120 119 # List of 2-tuple of (hash algorithm, hash).
121 120 'certfingerprints': [],
122 121 # Path to file containing concatenated CA certs. Used by
123 122 # SSLContext.load_verify_locations().
124 123 'cafile': None,
125 124 # Whether certificate verification should be disabled.
126 125 'disablecertverification': False,
127 126 # Whether the legacy [hostfingerprints] section has data for this host.
128 127 'legacyfingerprint': False,
129 128 # PROTOCOL_* constant to use for SSLContext.__init__.
130 129 'protocol': None,
131 130 # ssl.CERT_* constant used by SSLContext.verify_mode.
132 131 'verifymode': None,
133 132 # Defines extra ssl.OP* bitwise options to set.
134 133 'ctxoptions': None,
135 134 }
136 135
137 136 # Despite its name, PROTOCOL_SSLv23 selects the highest protocol
138 137 # that both ends support, including TLS protocols. On legacy stacks,
139 # the highest it likely goes in TLS 1.0. On modern stacks, it can
138 # the highest it likely goes is TLS 1.0. On modern stacks, it can
140 139 # support TLS 1.2.
141 140 #
142 141 # The PROTOCOL_TLSv* constants select a specific TLS version
143 142 # only (as opposed to multiple versions). So the method for
144 143 # supporting multiple TLS versions is to use PROTOCOL_SSLv23 and
145 144 # disable protocols via SSLContext.options and OP_NO_* constants.
146 145 # However, SSLContext.options doesn't work unless we have the
147 146 # full/real SSLContext available to us.
148 if modernssl:
149 s['protocol'] = ssl.PROTOCOL_SSLv23
150 else:
151 s['protocol'] = ssl.PROTOCOL_TLSv1
147
148 # Allow minimum TLS protocol to be specified in the config.
149 def validateprotocol(protocol, key):
150 if protocol not in configprotocols:
151 raise error.Abort(
152 _('unsupported protocol from hostsecurity.%s: %s') %
153 (key, protocol),
154 hint=_('valid protocols: %s') %
155 ' '.join(sorted(configprotocols)))
152 156
153 # SSLv2 and SSLv3 are broken. We ban them outright.
154 # WARNING: ctxoptions doesn't have an effect unless the modern ssl module
155 # is available. Be careful when adding flags!
156 s['ctxoptions'] = OP_NO_SSLv2 | OP_NO_SSLv3
157 key = 'minimumprotocol'
158 # Default to TLS 1.0+ as that is what browsers are currently doing.
159 protocol = ui.config('hostsecurity', key, 'tls1.0')
160 validateprotocol(protocol, key)
157 161
158 # Prevent CRIME.
159 # There is no guarantee this attribute is defined on the module.
160 s['ctxoptions'] |= getattr(ssl, 'OP_NO_COMPRESSION', 0)
162 key = '%s:minimumprotocol' % hostname
163 protocol = ui.config('hostsecurity', key, protocol)
164 validateprotocol(protocol, key)
165
166 s['protocol'], s['ctxoptions'] = protocolsettings(protocol)
161 167
162 168 # Look for fingerprints in [hostsecurity] section. Value is a list
163 169 # of <alg>:<fingerprint> strings.
164 170 fingerprints = ui.configlist('hostsecurity', '%s:fingerprints' % hostname,
165 171 [])
166 172 for fingerprint in fingerprints:
167 173 if not (fingerprint.startswith(('sha1:', 'sha256:', 'sha512:'))):
168 174 raise error.Abort(_('invalid fingerprint for %s: %s') % (
169 175 hostname, fingerprint),
170 176 hint=_('must begin with "sha1:", "sha256:", '
171 177 'or "sha512:"'))
172 178
173 179 alg, fingerprint = fingerprint.split(':', 1)
174 180 fingerprint = fingerprint.replace(':', '').lower()
175 181 s['certfingerprints'].append((alg, fingerprint))
176 182
177 183 # Fingerprints from [hostfingerprints] are always SHA-1.
178 184 for fingerprint in ui.configlist('hostfingerprints', hostname, []):
179 185 fingerprint = fingerprint.replace(':', '').lower()
180 186 s['certfingerprints'].append(('sha1', fingerprint))
181 187 s['legacyfingerprint'] = True
182 188
183 189 # If a host cert fingerprint is defined, it is the only thing that
184 190 # matters. No need to validate CA certs.
185 191 if s['certfingerprints']:
186 192 s['verifymode'] = ssl.CERT_NONE
187 193 s['allowloaddefaultcerts'] = False
188 194
189 195 # If --insecure is used, don't take CAs into consideration.
190 196 elif ui.insecureconnections:
191 197 s['disablecertverification'] = True
192 198 s['verifymode'] = ssl.CERT_NONE
193 199 s['allowloaddefaultcerts'] = False
194 200
195 201 if ui.configbool('devel', 'disableloaddefaultcerts'):
196 202 s['allowloaddefaultcerts'] = False
197 203
198 204 # If both fingerprints and a per-host ca file are specified, issue a warning
199 205 # because users should not be surprised about what security is or isn't
200 206 # being performed.
201 207 cafile = ui.config('hostsecurity', '%s:verifycertsfile' % hostname)
202 208 if s['certfingerprints'] and cafile:
203 209 ui.warn(_('(hostsecurity.%s:verifycertsfile ignored when host '
204 210 'fingerprints defined; using host fingerprints for '
205 211 'verification)\n') % hostname)
206 212
207 213 # Try to hook up CA certificate validation unless something above
208 214 # makes it not necessary.
209 215 if s['verifymode'] is None:
210 216 # Look at per-host ca file first.
211 217 if cafile:
212 218 cafile = util.expandpath(cafile)
213 219 if not os.path.exists(cafile):
214 220 raise error.Abort(_('path specified by %s does not exist: %s') %
215 221 ('hostsecurity.%s:verifycertsfile' % hostname,
216 222 cafile))
217 223 s['cafile'] = cafile
218 224 else:
219 225 # Find global certificates file in config.
220 226 cafile = ui.config('web', 'cacerts')
221 227
222 228 if cafile:
223 229 cafile = util.expandpath(cafile)
224 230 if not os.path.exists(cafile):
225 231 raise error.Abort(_('could not find web.cacerts: %s') %
226 232 cafile)
227 233 elif s['allowloaddefaultcerts']:
228 234 # CAs not defined in config. Try to find system bundles.
229 235 cafile = _defaultcacerts(ui)
230 236 if cafile:
231 237 ui.debug('using %s for CA file\n' % cafile)
232 238
233 239 s['cafile'] = cafile
234 240
235 241 # Require certificate validation if CA certs are being loaded and
236 242 # verification hasn't been disabled above.
237 243 if cafile or (_canloaddefaultcerts and s['allowloaddefaultcerts']):
238 244 s['verifymode'] = ssl.CERT_REQUIRED
239 245 else:
240 246 # At this point we don't have a fingerprint, aren't being
241 247 # explicitly insecure, and can't load CA certs. Connecting
242 248 # is insecure. We allow the connection and abort during
243 249 # validation (once we have the fingerprint to print to the
244 250 # user).
245 251 s['verifymode'] = ssl.CERT_NONE
246 252
247 253 assert s['protocol'] is not None
248 254 assert s['ctxoptions'] is not None
249 255 assert s['verifymode'] is not None
250 256
251 257 return s
252 258
259 def protocolsettings(protocol):
260 """Resolve the protocol and context options for a config value."""
261 if protocol not in configprotocols:
262 raise ValueError('protocol value not supported: %s' % protocol)
263
264 # Legacy ssl module only supports up to TLS 1.0. Ideally we'd use
265 # PROTOCOL_SSLv23 and options to disable SSLv2 and SSLv3. However,
266 # SSLContext.options doesn't work in our implementation since we use
267 # a fake SSLContext on these Python versions.
268 if not modernssl:
269 if protocol != 'tls1.0':
270 raise error.Abort(_('current Python does not support protocol '
271 'setting %s') % protocol,
272 hint=_('upgrade Python or disable setting since '
273 'only TLS 1.0 is supported'))
274
275 return ssl.PROTOCOL_TLSv1, 0
276
277 # WARNING: returned options don't work unless the modern ssl module
278 # is available. Be careful when adding options here.
279
280 # SSLv2 and SSLv3 are broken. We ban them outright.
281 options = ssl.OP_NO_SSLv2 | ssl.OP_NO_SSLv3
282
283 if protocol == 'tls1.0':
284 # Defaults above are to use TLS 1.0+
285 pass
286 elif protocol == 'tls1.1':
287 options |= ssl.OP_NO_TLSv1
288 elif protocol == 'tls1.2':
289 options |= ssl.OP_NO_TLSv1 | ssl.OP_NO_TLSv1_1
290 else:
291 raise error.Abort(_('this should not happen'))
292
293 # Prevent CRIME.
294 # There is no guarantee this attribute is defined on the module.
295 options |= getattr(ssl, 'OP_NO_COMPRESSION', 0)
296
297 return ssl.PROTOCOL_SSLv23, options
298
253 299 def wrapsocket(sock, keyfile, certfile, ui, serverhostname=None):
254 300 """Add SSL/TLS to a socket.
255 301
256 302 This is a glorified wrapper for ``ssl.wrap_socket()``. It makes sane
257 303 choices based on what security options are available.
258 304
259 305 In addition to the arguments supported by ``ssl.wrap_socket``, we allow
260 306 the following additional arguments:
261 307
262 308 * serverhostname - The expected hostname of the remote server. If the
263 309 server (and client) support SNI, this tells the server which certificate
264 310 to use.
265 311 """
266 312 if not serverhostname:
267 313 raise error.Abort(_('serverhostname argument is required'))
268 314
269 315 settings = _hostsettings(ui, serverhostname)
270 316
271 317 # We can't use ssl.create_default_context() because it calls
272 318 # load_default_certs() unless CA arguments are passed to it. We want to
273 319 # have explicit control over CA loading because implicitly loading
274 320 # CAs may undermine the user's intent. For example, a user may define a CA
275 321 # bundle with a specific CA cert removed. If the system/default CA bundle
276 322 # is loaded and contains that removed CA, you've just undone the user's
277 323 # choice.
278 324 sslcontext = SSLContext(settings['protocol'])
279 325
280 326 # This is a no-op unless using modern ssl.
281 327 sslcontext.options |= settings['ctxoptions']
282 328
283 329 # This still works on our fake SSLContext.
284 330 sslcontext.verify_mode = settings['verifymode']
285 331
286 332 if certfile is not None:
287 333 def password():
288 334 f = keyfile or certfile
289 335 return ui.getpass(_('passphrase for %s: ') % f, '')
290 336 sslcontext.load_cert_chain(certfile, keyfile, password)
291 337
292 338 if settings['cafile'] is not None:
293 339 try:
294 340 sslcontext.load_verify_locations(cafile=settings['cafile'])
295 341 except ssl.SSLError as e:
296 342 raise error.Abort(_('error loading CA file %s: %s') % (
297 343 settings['cafile'], e.args[1]),
298 344 hint=_('file is empty or malformed?'))
299 345 caloaded = True
300 346 elif settings['allowloaddefaultcerts']:
301 347 # This is a no-op on old Python.
302 348 sslcontext.load_default_certs()
303 349 caloaded = True
304 350 else:
305 351 caloaded = False
306 352
307 353 try:
308 354 sslsocket = sslcontext.wrap_socket(sock, server_hostname=serverhostname)
309 except ssl.SSLError:
355 except ssl.SSLError as e:
310 356 # If we're doing certificate verification and no CA certs are loaded,
311 357 # that is almost certainly the reason why verification failed. Provide
312 358 # a hint to the user.
313 359 # Only modern ssl module exposes SSLContext.get_ca_certs() so we can
314 360 # only show this warning if modern ssl is available.
315 361 if (caloaded and settings['verifymode'] == ssl.CERT_REQUIRED and
316 362 modernssl and not sslcontext.get_ca_certs()):
317 363 ui.warn(_('(an attempt was made to load CA certificates but none '
318 364 'were loaded; see '
319 365 'https://mercurial-scm.org/wiki/SecureConnections for '
320 366 'how to configure Mercurial to avoid this error)\n'))
367 # Try to print more helpful error messages for known failures.
368 if util.safehasattr(e, 'reason'):
369 if e.reason == 'UNSUPPORTED_PROTOCOL':
370 ui.warn(_('(could not negotiate a common protocol; see '
371 'https://mercurial-scm.org/wiki/SecureConnections '
372 'for how to configure Mercurial to avoid this '
373 'error)\n'))
321 374 raise
322 375
323 376 # check if wrap_socket failed silently because socket had been
324 377 # closed
325 378 # - see http://bugs.python.org/issue13721
326 379 if not sslsocket.cipher():
327 380 raise error.Abort(_('ssl connection failed'))
328 381
329 382 sslsocket._hgstate = {
330 383 'caloaded': caloaded,
331 384 'hostname': serverhostname,
332 385 'settings': settings,
333 386 'ui': ui,
334 387 }
335 388
336 389 return sslsocket
337 390
338 391 def wrapserversocket(sock, ui, certfile=None, keyfile=None, cafile=None,
339 392 requireclientcert=False):
340 393 """Wrap a socket for use by servers.
341 394
342 395 ``certfile`` and ``keyfile`` specify the files containing the certificate's
343 396 public and private keys, respectively. Both keys can be defined in the same
344 397 file via ``certfile`` (the private key must come first in the file).
345 398
346 399 ``cafile`` defines the path to certificate authorities.
347 400
348 401 ``requireclientcert`` specifies whether to require client certificates.
349 402
350 403 Typically ``cafile`` is only defined if ``requireclientcert`` is true.
351 404 """
405 protocol, options = protocolsettings('tls1.0')
406
407 # This config option is intended for use in tests only. It is a giant
408 # footgun to kill security. Don't define it.
409 exactprotocol = ui.config('devel', 'serverexactprotocol')
410 if exactprotocol == 'tls1.0':
411 protocol = ssl.PROTOCOL_TLSv1
412 elif exactprotocol == 'tls1.1':
413 protocol = ssl.PROTOCOL_TLSv1_1
414 elif exactprotocol == 'tls1.2':
415 protocol = ssl.PROTOCOL_TLSv1_2
416 elif exactprotocol:
417 raise error.Abort(_('invalid value for serverexactprotocol: %s') %
418 exactprotocol)
419
352 420 if modernssl:
353 421 # We /could/ use create_default_context() here since it doesn't load
354 # CAs when configured for client auth.
355 sslcontext = SSLContext(ssl.PROTOCOL_SSLv23)
356 # SSLv2 and SSLv3 are broken. Ban them outright.
357 sslcontext.options |= OP_NO_SSLv2 | OP_NO_SSLv3
358 # Prevent CRIME
359 sslcontext.options |= getattr(ssl, 'OP_NO_COMPRESSION', 0)
422 # CAs when configured for client auth. However, it is hard-coded to
423 # use ssl.PROTOCOL_SSLv23 which may not be appropriate here.
424 sslcontext = SSLContext(protocol)
425 sslcontext.options |= options
426
360 427 # Improve forward secrecy.
361 428 sslcontext.options |= getattr(ssl, 'OP_SINGLE_DH_USE', 0)
362 429 sslcontext.options |= getattr(ssl, 'OP_SINGLE_ECDH_USE', 0)
363 430
364 431 # Use the list of more secure ciphers if found in the ssl module.
365 432 if util.safehasattr(ssl, '_RESTRICTED_SERVER_CIPHERS'):
366 433 sslcontext.options |= getattr(ssl, 'OP_CIPHER_SERVER_PREFERENCE', 0)
367 434 sslcontext.set_ciphers(ssl._RESTRICTED_SERVER_CIPHERS)
368 435 else:
369 436 sslcontext = SSLContext(ssl.PROTOCOL_TLSv1)
370 437
371 438 if requireclientcert:
372 439 sslcontext.verify_mode = ssl.CERT_REQUIRED
373 440 else:
374 441 sslcontext.verify_mode = ssl.CERT_NONE
375 442
376 443 if certfile or keyfile:
377 444 sslcontext.load_cert_chain(certfile=certfile, keyfile=keyfile)
378 445
379 446 if cafile:
380 447 sslcontext.load_verify_locations(cafile=cafile)
381 448
382 449 return sslcontext.wrap_socket(sock, server_side=True)
383 450
384 451 class wildcarderror(Exception):
385 452 """Represents an error parsing wildcards in DNS name."""
386 453
387 454 def _dnsnamematch(dn, hostname, maxwildcards=1):
388 455 """Match DNS names according RFC 6125 section 6.4.3.
389 456
390 457 This code is effectively copied from CPython's ssl._dnsname_match.
391 458
392 459 Returns a bool indicating whether the expected hostname matches
393 460 the value in ``dn``.
394 461 """
395 462 pats = []
396 463 if not dn:
397 464 return False
398 465
399 466 pieces = dn.split(r'.')
400 467 leftmost = pieces[0]
401 468 remainder = pieces[1:]
402 469 wildcards = leftmost.count('*')
403 470 if wildcards > maxwildcards:
404 471 raise wildcarderror(
405 472 _('too many wildcards in certificate DNS name: %s') % dn)
406 473
407 474 # speed up common case w/o wildcards
408 475 if not wildcards:
409 476 return dn.lower() == hostname.lower()
410 477
411 478 # RFC 6125, section 6.4.3, subitem 1.
412 479 # The client SHOULD NOT attempt to match a presented identifier in which
413 480 # the wildcard character comprises a label other than the left-most label.
414 481 if leftmost == '*':
415 482 # When '*' is a fragment by itself, it matches a non-empty dotless
416 483 # fragment.
417 484 pats.append('[^.]+')
418 485 elif leftmost.startswith('xn--') or hostname.startswith('xn--'):
419 486 # RFC 6125, section 6.4.3, subitem 3.
420 487 # The client SHOULD NOT attempt to match a presented identifier
421 488 # where the wildcard character is embedded within an A-label or
422 489 # U-label of an internationalized domain name.
423 490 pats.append(re.escape(leftmost))
424 491 else:
425 492 # Otherwise, '*' matches any dotless string, e.g. www*
426 493 pats.append(re.escape(leftmost).replace(r'\*', '[^.]*'))
427 494
428 495 # add the remaining fragments, ignore any wildcards
429 496 for frag in remainder:
430 497 pats.append(re.escape(frag))
431 498
432 499 pat = re.compile(r'\A' + r'\.'.join(pats) + r'\Z', re.IGNORECASE)
433 500 return pat.match(hostname) is not None
434 501
435 502 def _verifycert(cert, hostname):
436 503 '''Verify that cert (in socket.getpeercert() format) matches hostname.
437 504 CRLs is not handled.
438 505
439 506 Returns error message if any problems are found and None on success.
440 507 '''
441 508 if not cert:
442 509 return _('no certificate received')
443 510
444 511 dnsnames = []
445 512 san = cert.get('subjectAltName', [])
446 513 for key, value in san:
447 514 if key == 'DNS':
448 515 try:
449 516 if _dnsnamematch(value, hostname):
450 517 return
451 518 except wildcarderror as e:
452 519 return e.args[0]
453 520
454 521 dnsnames.append(value)
455 522
456 523 if not dnsnames:
457 524 # The subject is only checked when there is no DNS in subjectAltName.
458 525 for sub in cert.get('subject', []):
459 526 for key, value in sub:
460 527 # According to RFC 2818 the most specific Common Name must
461 528 # be used.
462 529 if key == 'commonName':
463 530 # 'subject' entries are unicide.
464 531 try:
465 532 value = value.encode('ascii')
466 533 except UnicodeEncodeError:
467 534 return _('IDN in certificate not supported')
468 535
469 536 try:
470 537 if _dnsnamematch(value, hostname):
471 538 return
472 539 except wildcarderror as e:
473 540 return e.args[0]
474 541
475 542 dnsnames.append(value)
476 543
477 544 if len(dnsnames) > 1:
478 545 return _('certificate is for %s') % ', '.join(dnsnames)
479 546 elif len(dnsnames) == 1:
480 547 return _('certificate is for %s') % dnsnames[0]
481 548 else:
482 549 return _('no commonName or subjectAltName found in certificate')
483 550
484 551 def _plainapplepython():
485 552 """return true if this seems to be a pure Apple Python that
486 553 * is unfrozen and presumably has the whole mercurial module in the file
487 554 system
488 555 * presumably is an Apple Python that uses Apple OpenSSL which has patches
489 556 for using system certificate store CAs in addition to the provided
490 557 cacerts file
491 558 """
492 559 if sys.platform != 'darwin' or util.mainfrozen() or not sys.executable:
493 560 return False
494 561 exe = os.path.realpath(sys.executable).lower()
495 562 return (exe.startswith('/usr/bin/python') or
496 563 exe.startswith('/system/library/frameworks/python.framework/'))
497 564
498 565 _systemcacertpaths = [
499 566 # RHEL, CentOS, and Fedora
500 567 '/etc/pki/tls/certs/ca-bundle.trust.crt',
501 568 # Debian, Ubuntu, Gentoo
502 569 '/etc/ssl/certs/ca-certificates.crt',
503 570 ]
504 571
505 572 def _defaultcacerts(ui):
506 573 """return path to default CA certificates or None.
507 574
508 575 It is assumed this function is called when the returned certificates
509 576 file will actually be used to validate connections. Therefore this
510 577 function may print warnings or debug messages assuming this usage.
511 578
512 579 We don't print a message when the Python is able to load default
513 580 CA certs because this scenario is detected at socket connect time.
514 581 """
515 582 # The "certifi" Python package provides certificates. If it is installed,
516 583 # assume the user intends it to be used and use it.
517 584 try:
518 585 import certifi
519 586 certs = certifi.where()
520 587 ui.debug('using ca certificates from certifi\n')
521 588 return certs
522 589 except ImportError:
523 590 pass
524 591
525 592 # On Windows, only the modern ssl module is capable of loading the system
526 593 # CA certificates. If we're not capable of doing that, emit a warning
527 594 # because we'll get a certificate verification error later and the lack
528 595 # of loaded CA certificates will be the reason why.
529 596 # Assertion: this code is only called if certificates are being verified.
530 597 if os.name == 'nt':
531 598 if not _canloaddefaultcerts:
532 599 ui.warn(_('(unable to load Windows CA certificates; see '
533 600 'https://mercurial-scm.org/wiki/SecureConnections for '
534 601 'how to configure Mercurial to avoid this message)\n'))
535 602
536 603 return None
537 604
538 605 # Apple's OpenSSL has patches that allow a specially constructed certificate
539 606 # to load the system CA store. If we're running on Apple Python, use this
540 607 # trick.
541 608 if _plainapplepython():
542 609 dummycert = os.path.join(os.path.dirname(__file__), 'dummycert.pem')
543 610 if os.path.exists(dummycert):
544 611 return dummycert
545 612
546 613 # The Apple OpenSSL trick isn't available to us. If Python isn't able to
547 614 # load system certs, we're out of luck.
548 615 if sys.platform == 'darwin':
549 616 # FUTURE Consider looking for Homebrew or MacPorts installed certs
550 617 # files. Also consider exporting the keychain certs to a file during
551 618 # Mercurial install.
552 619 if not _canloaddefaultcerts:
553 620 ui.warn(_('(unable to load CA certificates; see '
554 621 'https://mercurial-scm.org/wiki/SecureConnections for '
555 622 'how to configure Mercurial to avoid this message)\n'))
556 623 return None
557 624
558 625 # / is writable on Windows. Out of an abundance of caution make sure
559 626 # we're not on Windows because paths from _systemcacerts could be installed
560 627 # by non-admin users.
561 628 assert os.name != 'nt'
562 629
563 630 # Try to find CA certificates in well-known locations. We print a warning
564 631 # when using a found file because we don't want too much silent magic
565 632 # for security settings. The expectation is that proper Mercurial
566 633 # installs will have the CA certs path defined at install time and the
567 634 # installer/packager will make an appropriate decision on the user's
568 635 # behalf. We only get here and perform this setting as a feature of
569 636 # last resort.
570 637 if not _canloaddefaultcerts:
571 638 for path in _systemcacertpaths:
572 639 if os.path.isfile(path):
573 640 ui.warn(_('(using CA certificates from %s; if you see this '
574 641 'message, your Mercurial install is not properly '
575 642 'configured; see '
576 643 'https://mercurial-scm.org/wiki/SecureConnections '
577 644 'for how to configure Mercurial to avoid this '
578 645 'message)\n') % path)
579 646 return path
580 647
581 648 ui.warn(_('(unable to load CA certificates; see '
582 649 'https://mercurial-scm.org/wiki/SecureConnections for '
583 650 'how to configure Mercurial to avoid this message)\n'))
584 651
585 652 return None
586 653
587 654 def validatesocket(sock):
588 655 """Validate a socket meets security requiremnets.
589 656
590 657 The passed socket must have been created with ``wrapsocket()``.
591 658 """
592 659 host = sock._hgstate['hostname']
593 660 ui = sock._hgstate['ui']
594 661 settings = sock._hgstate['settings']
595 662
596 663 try:
597 664 peercert = sock.getpeercert(True)
598 665 peercert2 = sock.getpeercert()
599 666 except AttributeError:
600 667 raise error.Abort(_('%s ssl connection error') % host)
601 668
602 669 if not peercert:
603 670 raise error.Abort(_('%s certificate error: '
604 671 'no certificate received') % host)
605 672
606 673 if settings['disablecertverification']:
607 674 # We don't print the certificate fingerprint because it shouldn't
608 675 # be necessary: if the user requested certificate verification be
609 676 # disabled, they presumably already saw a message about the inability
610 677 # to verify the certificate and this message would have printed the
611 678 # fingerprint. So printing the fingerprint here adds little to no
612 679 # value.
613 680 ui.warn(_('warning: connection security to %s is disabled per current '
614 681 'settings; communication is susceptible to eavesdropping '
615 682 'and tampering\n') % host)
616 683 return
617 684
618 685 # If a certificate fingerprint is pinned, use it and only it to
619 686 # validate the remote cert.
620 687 peerfingerprints = {
621 688 'sha1': hashlib.sha1(peercert).hexdigest(),
622 689 'sha256': hashlib.sha256(peercert).hexdigest(),
623 690 'sha512': hashlib.sha512(peercert).hexdigest(),
624 691 }
625 692
626 693 def fmtfingerprint(s):
627 694 return ':'.join([s[x:x + 2] for x in range(0, len(s), 2)])
628 695
629 696 nicefingerprint = 'sha256:%s' % fmtfingerprint(peerfingerprints['sha256'])
630 697
631 698 if settings['certfingerprints']:
632 699 for hash, fingerprint in settings['certfingerprints']:
633 700 if peerfingerprints[hash].lower() == fingerprint:
634 701 ui.debug('%s certificate matched fingerprint %s:%s\n' %
635 702 (host, hash, fmtfingerprint(fingerprint)))
636 703 return
637 704
638 705 # Pinned fingerprint didn't match. This is a fatal error.
639 706 if settings['legacyfingerprint']:
640 707 section = 'hostfingerprint'
641 708 nice = fmtfingerprint(peerfingerprints['sha1'])
642 709 else:
643 710 section = 'hostsecurity'
644 711 nice = '%s:%s' % (hash, fmtfingerprint(peerfingerprints[hash]))
645 712 raise error.Abort(_('certificate for %s has unexpected '
646 713 'fingerprint %s') % (host, nice),
647 714 hint=_('check %s configuration') % section)
648 715
649 716 # Security is enabled but no CAs are loaded. We can't establish trust
650 717 # for the cert so abort.
651 718 if not sock._hgstate['caloaded']:
652 719 raise error.Abort(
653 720 _('unable to verify security of %s (no loaded CA certificates); '
654 721 'refusing to connect') % host,
655 722 hint=_('see https://mercurial-scm.org/wiki/SecureConnections for '
656 723 'how to configure Mercurial to avoid this error or set '
657 724 'hostsecurity.%s:fingerprints=%s to trust this server') %
658 725 (host, nicefingerprint))
659 726
660 727 msg = _verifycert(peercert2, host)
661 728 if msg:
662 729 raise error.Abort(_('%s certificate error: %s') % (host, msg),
663 730 hint=_('set hostsecurity.%s:certfingerprints=%s '
664 731 'config setting or use --insecure to connect '
665 732 'insecurely') %
666 733 (host, nicefingerprint))
@@ -1,435 +1,503
1 1 #require serve ssl
2 2
3 3 Proper https client requires the built-in ssl from Python 2.6.
4 4
5 5 Make server certificates:
6 6
7 7 $ CERTSDIR="$TESTDIR/sslcerts"
8 8 $ cat "$CERTSDIR/priv.pem" "$CERTSDIR/pub.pem" >> server.pem
9 9 $ PRIV=`pwd`/server.pem
10 10 $ cat "$CERTSDIR/priv.pem" "$CERTSDIR/pub-not-yet.pem" > server-not-yet.pem
11 11 $ cat "$CERTSDIR/priv.pem" "$CERTSDIR/pub-expired.pem" > server-expired.pem
12 12
13 13 $ hg init test
14 14 $ cd test
15 15 $ echo foo>foo
16 16 $ mkdir foo.d foo.d/bAr.hg.d foo.d/baR.d.hg
17 17 $ echo foo>foo.d/foo
18 18 $ echo bar>foo.d/bAr.hg.d/BaR
19 19 $ echo bar>foo.d/baR.d.hg/bAR
20 20 $ hg commit -A -m 1
21 21 adding foo
22 22 adding foo.d/bAr.hg.d/BaR
23 23 adding foo.d/baR.d.hg/bAR
24 24 adding foo.d/foo
25 25 $ hg serve -p $HGPORT -d --pid-file=../hg0.pid --certificate=$PRIV
26 26 $ cat ../hg0.pid >> $DAEMON_PIDS
27 27
28 28 cacert not found
29 29
30 30 $ hg in --config web.cacerts=no-such.pem https://localhost:$HGPORT/
31 31 abort: could not find web.cacerts: no-such.pem
32 32 [255]
33 33
34 34 Test server address cannot be reused
35 35
36 36 #if windows
37 37 $ hg serve -p $HGPORT --certificate=$PRIV 2>&1
38 38 abort: cannot start server at ':$HGPORT':
39 39 [255]
40 40 #else
41 41 $ hg serve -p $HGPORT --certificate=$PRIV 2>&1
42 42 abort: cannot start server at ':$HGPORT': Address already in use
43 43 [255]
44 44 #endif
45 45 $ cd ..
46 46
47 47 Our test cert is not signed by a trusted CA. It should fail to verify if
48 48 we are able to load CA certs.
49 49
50 50 #if sslcontext defaultcacerts no-defaultcacertsloaded
51 51 $ hg clone https://localhost:$HGPORT/ copy-pull
52 52 (an attempt was made to load CA certificates but none were loaded; see https://mercurial-scm.org/wiki/SecureConnections for how to configure Mercurial to avoid this error)
53 53 abort: error: *certificate verify failed* (glob)
54 54 [255]
55 55 #endif
56 56
57 57 #if no-sslcontext defaultcacerts
58 58 $ hg clone https://localhost:$HGPORT/ copy-pull
59 59 (using CA certificates from *; if you see this message, your Mercurial install is not properly configured; see https://mercurial-scm.org/wiki/SecureConnections for how to configure Mercurial to avoid this message) (glob) (?)
60 60 abort: error: *certificate verify failed* (glob)
61 61 [255]
62 62 #endif
63 63
64 64 #if no-sslcontext windows
65 65 $ hg clone https://localhost:$HGPORT/ copy-pull
66 66 (unable to load Windows CA certificates; see https://mercurial-scm.org/wiki/SecureConnections for how to configure Mercurial to avoid this message)
67 67 abort: error: *certificate verify failed* (glob)
68 68 [255]
69 69 #endif
70 70
71 71 #if no-sslcontext osx
72 72 $ hg clone https://localhost:$HGPORT/ copy-pull
73 73 (unable to load CA certificates; see https://mercurial-scm.org/wiki/SecureConnections for how to configure Mercurial to avoid this message)
74 74 abort: localhost certificate error: no certificate received
75 75 (set hostsecurity.localhost:certfingerprints=sha256:20:de:b3:ad:b4:cd:a5:42:f0:74:41:1c:a2:70:1e:da:6e:c0:5c:16:9e:e7:22:0f:f1:b7:e5:6e:e4:92:af:7e config setting or use --insecure to connect insecurely)
76 76 [255]
77 77 #endif
78 78
79 79 #if defaultcacertsloaded
80 80 $ hg clone https://localhost:$HGPORT/ copy-pull
81 81 (using CA certificates from *; if you see this message, your Mercurial install is not properly configured; see https://mercurial-scm.org/wiki/SecureConnections for how to configure Mercurial to avoid this message) (glob) (?)
82 82 abort: error: *certificate verify failed* (glob)
83 83 [255]
84 84 #endif
85 85
86 86 #if no-defaultcacerts
87 87 $ hg clone https://localhost:$HGPORT/ copy-pull
88 88 (unable to load * certificates; see https://mercurial-scm.org/wiki/SecureConnections for how to configure Mercurial to avoid this message) (glob) (?)
89 89 abort: localhost certificate error: no certificate received
90 90 (set hostsecurity.localhost:certfingerprints=sha256:20:de:b3:ad:b4:cd:a5:42:f0:74:41:1c:a2:70:1e:da:6e:c0:5c:16:9e:e7:22:0f:f1:b7:e5:6e:e4:92:af:7e config setting or use --insecure to connect insecurely)
91 91 [255]
92 92 #endif
93 93
94 94 Specifying a per-host certificate file that doesn't exist will abort
95 95
96 96 $ hg --config hostsecurity.localhost:verifycertsfile=/does/not/exist clone https://localhost:$HGPORT/
97 97 abort: path specified by hostsecurity.localhost:verifycertsfile does not exist: /does/not/exist
98 98 [255]
99 99
100 100 A malformed per-host certificate file will raise an error
101 101
102 102 $ echo baddata > badca.pem
103 103 #if sslcontext
104 104 $ hg --config hostsecurity.localhost:verifycertsfile=badca.pem clone https://localhost:$HGPORT/
105 105 abort: error loading CA file badca.pem: * (glob)
106 106 (file is empty or malformed?)
107 107 [255]
108 108 #else
109 109 $ hg --config hostsecurity.localhost:verifycertsfile=badca.pem clone https://localhost:$HGPORT/
110 110 abort: error: * (glob)
111 111 [255]
112 112 #endif
113 113
114 114 A per-host certificate mismatching the server will fail verification
115 115
116 116 (modern ssl is able to discern whether the loaded cert is a CA cert)
117 117 #if sslcontext
118 118 $ hg --config hostsecurity.localhost:verifycertsfile="$CERTSDIR/client-cert.pem" clone https://localhost:$HGPORT/
119 119 (an attempt was made to load CA certificates but none were loaded; see https://mercurial-scm.org/wiki/SecureConnections for how to configure Mercurial to avoid this error)
120 120 abort: error: *certificate verify failed* (glob)
121 121 [255]
122 122 #else
123 123 $ hg --config hostsecurity.localhost:verifycertsfile="$CERTSDIR/client-cert.pem" clone https://localhost:$HGPORT/
124 124 abort: error: *certificate verify failed* (glob)
125 125 [255]
126 126 #endif
127 127
128 128 A per-host certificate matching the server's cert will be accepted
129 129
130 130 $ hg --config hostsecurity.localhost:verifycertsfile="$CERTSDIR/pub.pem" clone -U https://localhost:$HGPORT/ perhostgood1
131 131 requesting all changes
132 132 adding changesets
133 133 adding manifests
134 134 adding file changes
135 135 added 1 changesets with 4 changes to 4 files
136 136
137 137 A per-host certificate with multiple certs and one matching will be accepted
138 138
139 139 $ cat "$CERTSDIR/client-cert.pem" "$CERTSDIR/pub.pem" > perhost.pem
140 140 $ hg --config hostsecurity.localhost:verifycertsfile=perhost.pem clone -U https://localhost:$HGPORT/ perhostgood2
141 141 requesting all changes
142 142 adding changesets
143 143 adding manifests
144 144 adding file changes
145 145 added 1 changesets with 4 changes to 4 files
146 146
147 147 Defining both per-host certificate and a fingerprint will print a warning
148 148
149 149 $ hg --config hostsecurity.localhost:verifycertsfile="$CERTSDIR/pub.pem" --config hostsecurity.localhost:fingerprints=sha1:ecd87cd6b386d04fc1b8b41c9d8f5e168eef1c03 clone -U https://localhost:$HGPORT/ caandfingerwarning
150 150 (hostsecurity.localhost:verifycertsfile ignored when host fingerprints defined; using host fingerprints for verification)
151 151 requesting all changes
152 152 adding changesets
153 153 adding manifests
154 154 adding file changes
155 155 added 1 changesets with 4 changes to 4 files
156 156
157 157 $ DISABLECACERTS="--config devel.disableloaddefaultcerts=true"
158 158
159 159 Inability to verify peer certificate will result in abort
160 160
161 161 $ hg clone https://localhost:$HGPORT/ copy-pull $DISABLECACERTS
162 162 abort: unable to verify security of localhost (no loaded CA certificates); refusing to connect
163 163 (see https://mercurial-scm.org/wiki/SecureConnections for how to configure Mercurial to avoid this error or set hostsecurity.localhost:fingerprints=sha256:20:de:b3:ad:b4:cd:a5:42:f0:74:41:1c:a2:70:1e:da:6e:c0:5c:16:9e:e7:22:0f:f1:b7:e5:6e:e4:92:af:7e to trust this server)
164 164 [255]
165 165
166 166 $ hg clone --insecure https://localhost:$HGPORT/ copy-pull
167 167 warning: connection security to localhost is disabled per current settings; communication is susceptible to eavesdropping and tampering
168 168 requesting all changes
169 169 adding changesets
170 170 adding manifests
171 171 adding file changes
172 172 added 1 changesets with 4 changes to 4 files
173 173 updating to branch default
174 174 4 files updated, 0 files merged, 0 files removed, 0 files unresolved
175 175 $ hg verify -R copy-pull
176 176 checking changesets
177 177 checking manifests
178 178 crosschecking files in changesets and manifests
179 179 checking files
180 180 4 files, 1 changesets, 4 total revisions
181 181 $ cd test
182 182 $ echo bar > bar
183 183 $ hg commit -A -d '1 0' -m 2
184 184 adding bar
185 185 $ cd ..
186 186
187 187 pull without cacert
188 188
189 189 $ cd copy-pull
190 190 $ echo '[hooks]' >> .hg/hgrc
191 191 $ echo "changegroup = printenv.py changegroup" >> .hg/hgrc
192 192 $ hg pull $DISABLECACERTS
193 193 pulling from https://localhost:$HGPORT/
194 194 abort: unable to verify security of localhost (no loaded CA certificates); refusing to connect
195 195 (see https://mercurial-scm.org/wiki/SecureConnections for how to configure Mercurial to avoid this error or set hostsecurity.localhost:fingerprints=sha256:20:de:b3:ad:b4:cd:a5:42:f0:74:41:1c:a2:70:1e:da:6e:c0:5c:16:9e:e7:22:0f:f1:b7:e5:6e:e4:92:af:7e to trust this server)
196 196 [255]
197 197
198 198 $ hg pull --insecure
199 199 pulling from https://localhost:$HGPORT/
200 200 warning: connection security to localhost is disabled per current settings; communication is susceptible to eavesdropping and tampering
201 201 searching for changes
202 202 adding changesets
203 203 adding manifests
204 204 adding file changes
205 205 added 1 changesets with 1 changes to 1 files
206 206 changegroup hook: HG_NODE=5fed3813f7f5e1824344fdc9cf8f63bb662c292d HG_NODE_LAST=5fed3813f7f5e1824344fdc9cf8f63bb662c292d HG_SOURCE=pull HG_TXNID=TXN:* HG_URL=https://localhost:$HGPORT/ (glob)
207 207 (run 'hg update' to get a working copy)
208 208 $ cd ..
209 209
210 210 cacert configured in local repo
211 211
212 212 $ cp copy-pull/.hg/hgrc copy-pull/.hg/hgrc.bu
213 213 $ echo "[web]" >> copy-pull/.hg/hgrc
214 214 $ echo "cacerts=$CERTSDIR/pub.pem" >> copy-pull/.hg/hgrc
215 215 $ hg -R copy-pull pull --traceback
216 216 pulling from https://localhost:$HGPORT/
217 217 searching for changes
218 218 no changes found
219 219 $ mv copy-pull/.hg/hgrc.bu copy-pull/.hg/hgrc
220 220
221 221 cacert configured globally, also testing expansion of environment
222 222 variables in the filename
223 223
224 224 $ echo "[web]" >> $HGRCPATH
225 225 $ echo 'cacerts=$P/pub.pem' >> $HGRCPATH
226 226 $ P="$CERTSDIR" hg -R copy-pull pull
227 227 pulling from https://localhost:$HGPORT/
228 228 searching for changes
229 229 no changes found
230 230 $ P="$CERTSDIR" hg -R copy-pull pull --insecure
231 231 pulling from https://localhost:$HGPORT/
232 232 warning: connection security to localhost is disabled per current settings; communication is susceptible to eavesdropping and tampering
233 233 searching for changes
234 234 no changes found
235 235
236 236 empty cacert file
237 237
238 238 $ touch emptycafile
239 239
240 240 #if sslcontext
241 241 $ hg --config web.cacerts=emptycafile -R copy-pull pull
242 242 pulling from https://localhost:$HGPORT/
243 243 abort: error loading CA file emptycafile: * (glob)
244 244 (file is empty or malformed?)
245 245 [255]
246 246 #else
247 247 $ hg --config web.cacerts=emptycafile -R copy-pull pull
248 248 pulling from https://localhost:$HGPORT/
249 249 abort: error: * (glob)
250 250 [255]
251 251 #endif
252 252
253 253 cacert mismatch
254 254
255 255 $ hg -R copy-pull pull --config web.cacerts="$CERTSDIR/pub.pem" \
256 256 > https://127.0.0.1:$HGPORT/
257 257 pulling from https://127.0.0.1:$HGPORT/ (glob)
258 258 abort: 127.0.0.1 certificate error: certificate is for localhost (glob)
259 259 (set hostsecurity.127.0.0.1:certfingerprints=sha256:20:de:b3:ad:b4:cd:a5:42:f0:74:41:1c:a2:70:1e:da:6e:c0:5c:16:9e:e7:22:0f:f1:b7:e5:6e:e4:92:af:7e config setting or use --insecure to connect insecurely) (glob)
260 260 [255]
261 261 $ hg -R copy-pull pull --config web.cacerts="$CERTSDIR/pub.pem" \
262 262 > https://127.0.0.1:$HGPORT/ --insecure
263 263 pulling from https://127.0.0.1:$HGPORT/ (glob)
264 264 warning: connection security to 127.0.0.1 is disabled per current settings; communication is susceptible to eavesdropping and tampering (glob)
265 265 searching for changes
266 266 no changes found
267 267 $ hg -R copy-pull pull --config web.cacerts="$CERTSDIR/pub-other.pem"
268 268 pulling from https://localhost:$HGPORT/
269 269 abort: error: *certificate verify failed* (glob)
270 270 [255]
271 271 $ hg -R copy-pull pull --config web.cacerts="$CERTSDIR/pub-other.pem" \
272 272 > --insecure
273 273 pulling from https://localhost:$HGPORT/
274 274 warning: connection security to localhost is disabled per current settings; communication is susceptible to eavesdropping and tampering
275 275 searching for changes
276 276 no changes found
277 277
278 278 Test server cert which isn't valid yet
279 279
280 280 $ hg serve -R test -p $HGPORT1 -d --pid-file=hg1.pid --certificate=server-not-yet.pem
281 281 $ cat hg1.pid >> $DAEMON_PIDS
282 282 $ hg -R copy-pull pull --config web.cacerts="$CERTSDIR/pub-not-yet.pem" \
283 283 > https://localhost:$HGPORT1/
284 284 pulling from https://localhost:$HGPORT1/
285 285 abort: error: *certificate verify failed* (glob)
286 286 [255]
287 287
288 288 Test server cert which no longer is valid
289 289
290 290 $ hg serve -R test -p $HGPORT2 -d --pid-file=hg2.pid --certificate=server-expired.pem
291 291 $ cat hg2.pid >> $DAEMON_PIDS
292 292 $ hg -R copy-pull pull --config web.cacerts="$CERTSDIR/pub-expired.pem" \
293 293 > https://localhost:$HGPORT2/
294 294 pulling from https://localhost:$HGPORT2/
295 295 abort: error: *certificate verify failed* (glob)
296 296 [255]
297 297
298 298 Fingerprints
299 299
300 300 - works without cacerts (hostkeyfingerprints)
301 301 $ hg -R copy-pull id https://localhost:$HGPORT/ --insecure --config hostfingerprints.localhost=ec:d8:7c:d6:b3:86:d0:4f:c1:b8:b4:1c:9d:8f:5e:16:8e:ef:1c:03
302 302 5fed3813f7f5
303 303
304 304 - works without cacerts (hostsecurity)
305 305 $ hg -R copy-pull id https://localhost:$HGPORT/ --config hostsecurity.localhost:fingerprints=sha1:ecd87cd6b386d04fc1b8b41c9d8f5e168eef1c03
306 306 5fed3813f7f5
307 307
308 308 $ hg -R copy-pull id https://localhost:$HGPORT/ --config hostsecurity.localhost:fingerprints=sha256:20:de:b3:ad:b4:cd:a5:42:f0:74:41:1c:a2:70:1e:da:6e:c0:5c:16:9e:e7:22:0f:f1:b7:e5:6e:e4:92:af:7e
309 309 5fed3813f7f5
310 310
311 311 - multiple fingerprints specified and first matches
312 312 $ hg --config 'hostfingerprints.localhost=ecd87cd6b386d04fc1b8b41c9d8f5e168eef1c03, deadbeefdeadbeefdeadbeefdeadbeefdeadbeef' -R copy-pull id https://localhost:$HGPORT/ --insecure
313 313 5fed3813f7f5
314 314
315 315 $ hg --config 'hostsecurity.localhost:fingerprints=sha1:ecd87cd6b386d04fc1b8b41c9d8f5e168eef1c03, sha1:deadbeefdeadbeefdeadbeefdeadbeefdeadbeef' -R copy-pull id https://localhost:$HGPORT/
316 316 5fed3813f7f5
317 317
318 318 - multiple fingerprints specified and last matches
319 319 $ hg --config 'hostfingerprints.localhost=deadbeefdeadbeefdeadbeefdeadbeefdeadbeef, ecd87cd6b386d04fc1b8b41c9d8f5e168eef1c03' -R copy-pull id https://localhost:$HGPORT/ --insecure
320 320 5fed3813f7f5
321 321
322 322 $ hg --config 'hostsecurity.localhost:fingerprints=sha1:deadbeefdeadbeefdeadbeefdeadbeefdeadbeef, sha1:ecd87cd6b386d04fc1b8b41c9d8f5e168eef1c03' -R copy-pull id https://localhost:$HGPORT/
323 323 5fed3813f7f5
324 324
325 325 - multiple fingerprints specified and none match
326 326
327 327 $ hg --config 'hostfingerprints.localhost=deadbeefdeadbeefdeadbeefdeadbeefdeadbeef, aeadbeefdeadbeefdeadbeefdeadbeefdeadbeef' -R copy-pull id https://localhost:$HGPORT/ --insecure
328 328 abort: certificate for localhost has unexpected fingerprint ec:d8:7c:d6:b3:86:d0:4f:c1:b8:b4:1c:9d:8f:5e:16:8e:ef:1c:03
329 329 (check hostfingerprint configuration)
330 330 [255]
331 331
332 332 $ hg --config 'hostsecurity.localhost:fingerprints=sha1:deadbeefdeadbeefdeadbeefdeadbeefdeadbeef, sha1:aeadbeefdeadbeefdeadbeefdeadbeefdeadbeef' -R copy-pull id https://localhost:$HGPORT/
333 333 abort: certificate for localhost has unexpected fingerprint sha1:ec:d8:7c:d6:b3:86:d0:4f:c1:b8:b4:1c:9d:8f:5e:16:8e:ef:1c:03
334 334 (check hostsecurity configuration)
335 335 [255]
336 336
337 337 - fails when cert doesn't match hostname (port is ignored)
338 338 $ hg -R copy-pull id https://localhost:$HGPORT1/ --config hostfingerprints.localhost=ecd87cd6b386d04fc1b8b41c9d8f5e168eef1c03
339 339 abort: certificate for localhost has unexpected fingerprint f4:2f:5a:0c:3e:52:5b:db:e7:24:a8:32:1d:18:97:6d:69:b5:87:84
340 340 (check hostfingerprint configuration)
341 341 [255]
342 342
343 343
344 344 - ignores that certificate doesn't match hostname
345 345 $ hg -R copy-pull id https://127.0.0.1:$HGPORT/ --config hostfingerprints.127.0.0.1=ecd87cd6b386d04fc1b8b41c9d8f5e168eef1c03
346 346 5fed3813f7f5
347 347
348 HGPORT1 is reused below for tinyproxy tests. Kill that server.
348 Ports used by next test. Kill servers.
349
350 $ killdaemons.py hg0.pid
349 351 $ killdaemons.py hg1.pid
352 $ killdaemons.py hg2.pid
353
354 #if sslcontext
355 Start servers running supported TLS versions
356
357 $ cd test
358 $ hg serve -p $HGPORT -d --pid-file=../hg0.pid --certificate=$PRIV \
359 > --config devel.serverexactprotocol=tls1.0
360 $ cat ../hg0.pid >> $DAEMON_PIDS
361 $ hg serve -p $HGPORT1 -d --pid-file=../hg1.pid --certificate=$PRIV \
362 > --config devel.serverexactprotocol=tls1.1
363 $ cat ../hg1.pid >> $DAEMON_PIDS
364 $ hg serve -p $HGPORT2 -d --pid-file=../hg2.pid --certificate=$PRIV \
365 > --config devel.serverexactprotocol=tls1.2
366 $ cat ../hg2.pid >> $DAEMON_PIDS
367 $ cd ..
368
369 Clients talking same TLS versions work
370
371 $ P="$CERTSDIR" hg --config hostsecurity.minimumprotocol=tls1.0 id https://localhost:$HGPORT/
372 5fed3813f7f5
373 $ P="$CERTSDIR" hg --config hostsecurity.minimumprotocol=tls1.1 id https://localhost:$HGPORT1/
374 5fed3813f7f5
375 $ P="$CERTSDIR" hg --config hostsecurity.minimumprotocol=tls1.2 id https://localhost:$HGPORT2/
376 5fed3813f7f5
377
378 Clients requiring newer TLS version than what server supports fail
379
380 $ P="$CERTSDIR" hg --config hostsecurity.minimumprotocol=tls1.1 id https://localhost:$HGPORT/
381 (could not negotiate a common protocol; see https://mercurial-scm.org/wiki/SecureConnections for how to configure Mercurial to avoid this error)
382 abort: error: *unsupported protocol* (glob)
383 [255]
384 $ P="$CERTSDIR" hg --config hostsecurity.minimumprotocol=tls1.2 id https://localhost:$HGPORT/
385 (could not negotiate a common protocol; see https://mercurial-scm.org/wiki/SecureConnections for how to configure Mercurial to avoid this error)
386 abort: error: *unsupported protocol* (glob)
387 [255]
388 $ P="$CERTSDIR" hg --config hostsecurity.minimumprotocol=tls1.2 id https://localhost:$HGPORT1/
389 (could not negotiate a common protocol; see https://mercurial-scm.org/wiki/SecureConnections for how to configure Mercurial to avoid this error)
390 abort: error: *unsupported protocol* (glob)
391 [255]
392
393 The per-host config option overrides the default
394
395 $ P="$CERTSDIR" hg id https://localhost:$HGPORT/ \
396 > --config hostsecurity.minimumprotocol=tls1.2 \
397 > --config hostsecurity.localhost:minimumprotocol=tls1.0
398 5fed3813f7f5
399
400 The per-host config option by itself works
401
402 $ P="$CERTSDIR" hg id https://localhost:$HGPORT/ \
403 > --config hostsecurity.localhost:minimumprotocol=tls1.2
404 (could not negotiate a common protocol; see https://mercurial-scm.org/wiki/SecureConnections for how to configure Mercurial to avoid this error)
405 abort: error: *unsupported protocol* (glob)
406 [255]
407
408 $ killdaemons.py hg0.pid
409 $ killdaemons.py hg1.pid
410 $ killdaemons.py hg2.pid
411 #endif
350 412
351 413 Prepare for connecting through proxy
352 414
415 $ hg serve -R test -p $HGPORT -d --pid-file=hg0.pid --certificate=$PRIV
416 $ cat hg0.pid >> $DAEMON_PIDS
417 $ hg serve -R test -p $HGPORT2 -d --pid-file=hg2.pid --certificate=server-expired.pem
418 $ cat hg2.pid >> $DAEMON_PIDS
419 tinyproxy.py doesn't fully detach, so killing it may result in extra output
420 from the shell. So don't kill it.
353 421 $ tinyproxy.py $HGPORT1 localhost >proxy.log </dev/null 2>&1 &
354 422 $ while [ ! -f proxy.pid ]; do sleep 0; done
355 423 $ cat proxy.pid >> $DAEMON_PIDS
356 424
357 425 $ echo "[http_proxy]" >> copy-pull/.hg/hgrc
358 426 $ echo "always=True" >> copy-pull/.hg/hgrc
359 427 $ echo "[hostfingerprints]" >> copy-pull/.hg/hgrc
360 428 $ echo "localhost =" >> copy-pull/.hg/hgrc
361 429
362 430 Test unvalidated https through proxy
363 431
364 432 $ http_proxy=http://localhost:$HGPORT1/ hg -R copy-pull pull --insecure --traceback
365 433 pulling from https://localhost:$HGPORT/
366 434 warning: connection security to localhost is disabled per current settings; communication is susceptible to eavesdropping and tampering
367 435 searching for changes
368 436 no changes found
369 437
370 438 Test https with cacert and fingerprint through proxy
371 439
372 440 $ http_proxy=http://localhost:$HGPORT1/ hg -R copy-pull pull \
373 441 > --config web.cacerts="$CERTSDIR/pub.pem"
374 442 pulling from https://localhost:$HGPORT/
375 443 searching for changes
376 444 no changes found
377 445 $ http_proxy=http://localhost:$HGPORT1/ hg -R copy-pull pull https://127.0.0.1:$HGPORT/ --config hostfingerprints.127.0.0.1=ecd87cd6b386d04fc1b8b41c9d8f5e168eef1c03
378 446 pulling from https://127.0.0.1:$HGPORT/ (glob)
379 447 searching for changes
380 448 no changes found
381 449
382 450 Test https with cert problems through proxy
383 451
384 452 $ http_proxy=http://localhost:$HGPORT1/ hg -R copy-pull pull \
385 453 > --config web.cacerts="$CERTSDIR/pub-other.pem"
386 454 pulling from https://localhost:$HGPORT/
387 455 abort: error: *certificate verify failed* (glob)
388 456 [255]
389 457 $ http_proxy=http://localhost:$HGPORT1/ hg -R copy-pull pull \
390 458 > --config web.cacerts="$CERTSDIR/pub-expired.pem" https://localhost:$HGPORT2/
391 459 pulling from https://localhost:$HGPORT2/
392 460 abort: error: *certificate verify failed* (glob)
393 461 [255]
394 462
395 463
396 464 $ killdaemons.py hg0.pid
397 465
398 466 #if sslcontext
399 467
400 468 Start hgweb that requires client certificates:
401 469
402 470 $ cd test
403 471 $ hg serve -p $HGPORT -d --pid-file=../hg0.pid --certificate=$PRIV \
404 472 > --config devel.servercafile=$PRIV --config devel.serverrequirecert=true
405 473 $ cat ../hg0.pid >> $DAEMON_PIDS
406 474 $ cd ..
407 475
408 476 without client certificate:
409 477
410 478 $ P="$CERTSDIR" hg id https://localhost:$HGPORT/
411 479 abort: error: *handshake failure* (glob)
412 480 [255]
413 481
414 482 with client certificate:
415 483
416 484 $ cat << EOT >> $HGRCPATH
417 485 > [auth]
418 486 > l.prefix = localhost
419 487 > l.cert = $CERTSDIR/client-cert.pem
420 488 > l.key = $CERTSDIR/client-key.pem
421 489 > EOT
422 490
423 491 $ P="$CERTSDIR" hg id https://localhost:$HGPORT/ \
424 492 > --config auth.l.key="$CERTSDIR/client-key-decrypted.pem"
425 493 5fed3813f7f5
426 494
427 495 $ printf '1234\n' | env P="$CERTSDIR" hg id https://localhost:$HGPORT/ \
428 496 > --config ui.interactive=True --config ui.nontty=True
429 497 passphrase for */client-key.pem: 5fed3813f7f5 (glob)
430 498
431 499 $ env P="$CERTSDIR" hg id https://localhost:$HGPORT/
432 500 abort: error: * (glob)
433 501 [255]
434 502
435 503 #endif
General Comments 0
You need to be logged in to leave comments. Login now