derivepassphrase.git

1) # SPDX-FileCopyrightText: 2025 Marco Ricci <software@the13thletter.info>

2) #
3) # SPDX-Licence-Identifier: MIT
4) 
5) """Internal module.  Do not use.  Contains error strings and functions."""
6) 
7) from __future__ import annotations
8) 

9) import contextlib

10) import datetime

11) import enum

12) import functools

13) import gettext
14) import inspect

15) import os

16) import string

17) import sys

18) import textwrap

19) import types

20) from typing import TYPE_CHECKING, NamedTuple, Protocol, TextIO, Union, cast

21) 

22) from typing_extensions import TypeAlias, override

23) 
24) import derivepassphrase as dpp
25) 
26) if TYPE_CHECKING:

27)     from collections.abc import Iterable, Iterator, Mapping, Sequence

28) 
29)     from typing_extensions import Any, Self
30) 
31) __author__ = dpp.__author__
32) __version__ = dpp.__version__
33) 
34) __all__ = ('PROG_NAME',)
35) 
36) PROG_NAME = 'derivepassphrase'

37) 
38) 
39) def load_translations(
40)     localedirs: list[str] | None = None,
41)     languages: Sequence[str] | None = None,
42)     class_: type[gettext.NullTranslations] | None = None,

43) ) -> gettext.NullTranslations:  # pragma: no cover

44)     """Load a translation catalog for derivepassphrase.
45) 
46)     Runs [`gettext.translation`][] under the hood for multiple locale
47)     directories.  `fallback=True` is implied.
48) 
49)     Args:
50)         localedirs:
51)             A list of directories to run [`gettext.translation`][]
52)             against.  Defaults to `$XDG_DATA_HOME/locale` (usually
53)             `~/.local/share/locale`), `{sys.prefix}/share/locale` and
54)             `{sys.base_prefix}/share/locale` if not given.
55)         languages:
56)             Passed directly to [`gettext.translation`][].
57)         class_:
58)             Passed directly to [`gettext.translation`][].
59) 
60)     Returns:
61)         A (potentially dummy) translation catalog.
62) 
63)     """
64)     if localedirs is None:
65)         if sys.platform.startswith('win'):
66)             xdg_data_home = os.environ.get(
67)                 'APPDATA',
68)                 os.path.expanduser('~'),
69)             )
70)         elif os.environ.get('XDG_DATA_HOME'):
71)             xdg_data_home = os.environ['XDG_DATA_HOME']
72)         else:
73)             xdg_data_home = os.path.join(
74)                 os.path.expanduser('~'), '.local', 'share'
75)             )
76)         localedirs = [
77)             os.path.join(xdg_data_home, 'locale'),
78)             os.path.join(sys.prefix, 'share', 'locale'),
79)             os.path.join(sys.base_prefix, 'share', 'locale'),
80)         ]
81)     for localedir in localedirs:
82)         with contextlib.suppress(OSError):
83)             return gettext.translation(
84)                 PROG_NAME,
85)                 localedir=localedir,
86)                 languages=languages,
87)                 class_=class_,
88)             )
89)     return gettext.NullTranslations()
90) 
91) 
92) translation = load_translations()

93) _debug_translation_message_cache: dict[
94)     tuple[str, str],
95)     tuple[MsgTemplate, frozenset],
96) ] = {}

97) 
98) 
99) class DebugTranslations(gettext.NullTranslations):
100)     """A debug object indicating which known message is being requested.
101) 
102)     Each call to the `*gettext` methods will return the enum name if the
103)     message is a known translatable message for the `derivepassphrase`
104)     command-line interface, or the message itself otherwise.
105) 
106)     """
107) 
108)     @staticmethod
109)     def _load_cache() -> None:
110)         cache = _debug_translation_message_cache
111)         for enum_class in MSG_TEMPLATE_CLASSES:
112)             for member in enum_class.__members__.values():
113)                 value = cast('TranslatableString', member.value)

114)                 queue: list[tuple[TranslatableString, frozenset[str]]] = [
115)                     (value, frozenset())
116)                 ]

117)                 value2 = value.maybe_without_filename()

118)                 if value != value2:
119)                     queue.append((value2, frozenset({'filename'})))
120)                 for v, trimmed in queue:

121)                     singular = v.singular
122)                     plural = v.plural
123)                     context = v.l10n_context

124)                     cache.setdefault((context, singular), (member, trimmed))

125)                     # Currently no translatable messages use plural forms
126)                     if plural:  # pragma: no cover

127)                         cache.setdefault((context, plural), (member, trimmed))

128) 
129)     @classmethod
130)     def _locate_message(
131)         cls,
132)         message: str,
133)         /,
134)         *,
135)         context: str = '',
136)         message_plural: str = '',
137)         n: int = 1,
138)     ) -> str:
139)         try:

140)             enum_value, trimmed = _debug_translation_message_cache[
141)                 context, message
142)             ]

143)         except KeyError:
144)             return message if not message_plural or n == 1 else message_plural
145)         return cls._format_enum_name_maybe_with_fields(
146)             enum_name=str(enum_value),
147)             ts=cast('TranslatableString', enum_value.value),

148)             trimmed=trimmed,

149)         )
150) 
151)     @staticmethod
152)     def _format_enum_name_maybe_with_fields(
153)         enum_name: str,
154)         ts: TranslatableString,

155)         trimmed: frozenset[str] = frozenset(),

156)     ) -> str:
157)         formatter = string.Formatter()
158)         fields: dict[str, int] = {}
159)         for _lit, field, _spec, _conv in formatter.parse(ts.singular):
160)             if field is not None and field not in fields:
161)                 fields[field] = len(fields)

162)         sorted_fields = sorted(fields.keys(), key=fields.__getitem__)
163)         formatted_fields = [
164)             f'{f}=None' if f in trimmed else f'{f}={{{f}!r}}'
165)             for f in sorted_fields

166)         ]
167)         return (

168)             '{!s}({})'.format(enum_name, ', '.join(formatted_fields))
169)             if formatted_fields

170)             else str(enum_name)
171)         )
172) 
173)     @override
174)     def gettext(
175)         self,
176)         message: str,
177)         /,
178)     ) -> str:  # pragma: no cover
179)         return self._locate_message(message)
180) 
181)     @override
182)     def ngettext(
183)         self,
184)         msgid1: str,
185)         msgid2: str,
186)         n: int,
187)         /,
188)     ) -> str:  # pragma: no cover
189)         return self._locate_message(msgid1, message_plural=msgid2, n=n)
190) 
191)     @override
192)     def pgettext(
193)         self,
194)         context: str,
195)         message: str,
196)         /,
197)     ) -> str:
198)         return self._locate_message(message, context=context)
199) 
200)     @override
201)     def npgettext(
202)         self,
203)         context: str,
204)         msgid1: str,
205)         msgid2: str,
206)         n: int,
207)         /,
208)     ) -> str:  # pragma: no cover
209)         return self._locate_message(
210)             msgid1,
211)             context=context,
212)             message_plural=msgid2,
213)             n=n,
214)         )

215) 
216) 
217) class TranslatableString(NamedTuple):
218)     l10n_context: str

219)     singular: str
220)     plural: str = ''
221)     flags: frozenset[str] = frozenset()
222)     translator_comments: str = ''

223) 

224)     @staticmethod
225)     def _maybe_rewrap(
226)         string: str,
227)         /,
228)         *,
229)         fix_sentence_endings: bool = True,
230)     ) -> str:
231)         string = inspect.cleandoc(string)
232)         if not any(s.strip() == '\b' for s in string.splitlines()):
233)             string = '\n'.join(
234)                 textwrap.wrap(
235)                     string,
236)                     width=float('inf'),  # type: ignore[arg-type]
237)                     fix_sentence_endings=fix_sentence_endings,
238)                 )
239)             )
240)         else:
241)             string = ''.join(
242)                 s
243)                 for s in string.splitlines(True)  # noqa: FBT003
244)                 if s.strip() != '\b'
245)             )
246)         return string
247) 

248)     def maybe_without_filename(self) -> Self:
249)         """Return a new translatable string without the "filename" field.
250) 
251)         Only acts upon translatable strings containing the exact
252)         contents `": {filename!r}"`.  The specified part will be
253)         removed.  This is correct usage in English for messages like
254)         `"Cannot open file: {error!s}: {filename!r}."`, but not
255)         necessarily in other languages.
256) 
257)         """
258)         filename_str = ': {filename!r}'
259)         ret = self
260)         a, sep1, b = self.singular.partition(filename_str)
261)         c, sep2, d = self.plural.partition(filename_str)
262)         if sep1:
263)             ret = ret._replace(singular=(a + b))

264)         # Currently no translatable messages use plural forms
265)         if sep2:  # pragma: no cover

266)             ret = ret._replace(plural=(c + d))
267)         return ret
268) 

269)     def rewrapped(self) -> Self:
270)         """Return a rewrapped version of self.
271) 
272)         Normalizes all parts assumed to contain English prose.
273) 
274)         """
275)         msg = self._maybe_rewrap(self.singular, fix_sentence_endings=True)
276)         plural = self._maybe_rewrap(self.plural, fix_sentence_endings=True)
277)         context = self.l10n_context.strip()
278)         comments = self._maybe_rewrap(
279)             self.translator_comments, fix_sentence_endings=False
280)         )
281)         return self._replace(
282)             singular=msg,
283)             plural=plural,
284)             l10n_context=context,
285)             translator_comments=comments,
286)         )
287) 
288)     def with_comments(self, comments: str, /) -> Self:
289)         """Add or replace the string's translator comments.
290) 
291)         The comments are assumed to contain English prose, and will be
292)         normalized.
293) 
294)         Returns:
295)             A new [`TranslatableString`][] with the specified comments.
296) 
297)         """
298)         if not comments.lstrip().startswith(  # pragma: no cover
299)             'TRANSLATORS:'
300)         ):
301)             comments = 'TRANSLATORS: ' + comments.lstrip()
302)         comments = self._maybe_rewrap(comments, fix_sentence_endings=False)
303)         return self._replace(translator_comments=comments)
304) 
305)     def validate_flags(self, *extra_flags: str) -> Self:
306)         """Add all flags, then validate them against the string.
307) 
308)         Returns:
309)             A new [`TranslatableString`][] with the extra flags added,
310)             and all flags validated.
311) 
312)         Raises:
313)             ValueError:
314)                 The flags failed to validate.  See the exact error
315)                 message for details.
316) 

317)         Examples:
318)             >>> TranslatableString('', 'all OK').validate_flags()
319)             ... # doctest: +NORMALIZE_WHITESPACE
320)             TranslatableString(l10n_context='', singular='all OK', plural='',
321)                                flags=frozenset(), translator_comments='')
322)             >>> TranslatableString('', '20% OK').validate_flags(
323)             ...     'no-python-format'
324)             ... )
325)             ... # doctest: +NORMALIZE_WHITESPACE
326)             TranslatableString(l10n_context='', singular='20% OK', plural='',
327)                                flags=frozenset({'no-python-format'}),
328)                                translator_comments='')
329)             >>> TranslatableString('', '%d items').validate_flags()
330)             ... # doctest: +ELLIPSIS
331)             Traceback (most recent call last):
332)                 ...
333)             ValueError: Missing flag for how to deal with percent character ...
334)             >>> TranslatableString('', '{braces}').validate_flags()
335)             ... # doctest: +ELLIPSIS
336)             Traceback (most recent call last):
337)                 ...
338)             ValueError: Missing flag for how to deal with brace character ...
339)             >>> TranslatableString('', 'no braces').validate_flags(
340)             ...     'python-brace-format'
341)             ... )
342)             ... # doctest: +ELLIPSIS
343)             Traceback (most recent call last):
344)                 ...
345)             ValueError: Missing format string parameters ...
346) 

347)         """
348)         all_flags = frozenset(
349)             f.strip() for f in self.flags.union(extra_flags)
350)         )
351)         if '{' in self.singular and not bool(
352)             all_flags & {'python-brace-format', 'no-python-brace-format'}
353)         ):
354)             msg = (
355)                 f'Missing flag for how to deal with brace character '
356)                 f'in {self.singular!r}'
357)             )
358)             raise ValueError(msg)
359)         if '%' in self.singular and not bool(
360)             all_flags & {'python-format', 'no-python-format'}
361)         ):
362)             msg = (
363)                 f'Missing flag for how to deal with percent character '
364)                 f'in {self.singular!r}'
365)             )
366)             raise ValueError(msg)
367)         if (
368)             all_flags & {'python-format', 'python-brace-format'}
369)             and '%' not in self.singular
370)             and '{' not in self.singular
371)         ):
372)             msg = f'Missing format string parameters in {self.singular!r}'
373)             raise ValueError(msg)
374)         return self._replace(flags=all_flags)
375) 

376) 

377) def translatable(
378)     context: str,
379)     single: str,

380)     # /,

381)     flags: Iterable[str] = (),
382)     plural: str = '',
383)     comments: str = '',
384) ) -> TranslatableString:
385)     """Return a [`TranslatableString`][] with validated parts.
386) 
387)     This factory function is really only there to make the enum
388)     definitions more readable.
389) 
390)     """

391)     flags = (

392)         frozenset(flags)

393)         if not isinstance(flags, str)
394)         else frozenset({flags})
395)     )

396)     return (
397)         TranslatableString(context, single, plural=plural, flags=flags)
398)         .rewrapped()
399)         .with_comments(comments)
400)         .validate_flags()
401)     )

402) 
403) 

404) class TranslatedString:

405)     def __init__(
406)         self,

407)         template: (
408)             str
409)             | TranslatableString

410)             | MsgTemplate

411)         ),

412)         args_dict: Mapping[str, Any] = types.MappingProxyType({}),
413)         /,
414)         **kwargs: Any,  # noqa: ANN401
415)     ) -> None:

416)         if isinstance(template, MSG_TEMPLATE_CLASSES):

417)             template = cast('TranslatableString', template.value)

418)         self.template = template
419)         self.kwargs = {**args_dict, **kwargs}
420)         self._rendered: str | None = None
421) 

422)     def __bool__(self) -> bool:
423)         return bool(str(self))
424) 
425)     def __eq__(self, other: object) -> bool:  # pragma: no cover
426)         return str(self) == other
427) 
428)     def __hash__(self) -> int:  # pragma: no cover
429)         return hash(str(self))
430) 
431)     def __repr__(self) -> str:  # pragma: no cover
432)         return (
433)             f'{self.__class__.__name__}({self.template!r}, '
434)             f'{dict(self.kwargs)!r})'
435)         )
436) 

437)     def __str__(self) -> str:
438)         if self._rendered is None:

439)             # raw str support is currently unneeded, so excluded from coverage
440)             if isinstance(self.template, str):  # pragma: no cover
441)                 context = None
442)                 template = self.template
443)             else:
444)                 context = self.template.l10n_context
445)                 template = self.template.singular

446)             if context is not None:
447)                 template = translation.pgettext(context, template)

448)             else:  # pragma: no cover

449)                 template = translation.gettext(template)

450)             kwargs = {
451)                 k: str(v) if isinstance(v, TranslatedString) else v
452)                 for k, v in self.kwargs.items()
453)             }
454)             self._rendered = template.format(**kwargs)

455)         return self._rendered
456) 
457)     def maybe_without_filename(self) -> Self:

458)         """Return a new string without the "filename" field.
459) 
460)         Only acts upon translated strings containing the exact contents
461)         `": {filename!r}"`.  The specified part will be removed.  This
462)         acts upon the string *before* translation, i.e., the string
463)         without the filename will be used as a translation base.
464) 
465)         """
466)         new_template = (
467)             self.template.maybe_without_filename()
468)             if not isinstance(self.template, str)
469)             else self.template
470)         )

471)         if (

472)             not isinstance(new_template, str)

473)             and self.kwargs.get('filename') is None

474)             and new_template != self.template

475)         ):

476)             return self.__class__(new_template, self.kwargs)

477)         return self
478) 
479) 

480) class _TranslatedStringConstructor(Protocol):
481)     def __call__(
482)         self,
483)         context: str,
484)         single: str,
485)         # /,
486)         flags: Iterable[str] = (),
487)         plural: str = '',
488)         comments: str = '',
489)     ) -> TranslatableString: ...
490) 
491) 
492) def _Commented(  # noqa: N802
493)     comments: str = '',
494)     # /
495) ) -> _TranslatedStringConstructor:
496)     """A "decorator" for readably constructing commented enum values.
497) 
498)     This is geared towards the quirks of the API documentation extractor
499)     `mkdocstrings-python`/`griffe`, which reformat and trim enum value
500)     declarations in somewhat weird ways.  Chains of function calls are
501)     preserved, though, so use this to our advantage to suggest
502)     a specific formatting.
503) 
504)     This is not necessarily good code style, and it is
505)     (quasi-)unnecessarily heavyweight.
506) 
507)     """  # noqa: DOC201
508)     return functools.partial(translatable, comments=comments)
509) 
510) 

511) class Label(enum.Enum):

512)     DEPRECATION_WARNING_LABEL = _Commented(

513)         comments=r"""
514)         TRANSLATORS: This is a short label that will be prepended to
515)         a warning message, e.g., "Deprecation warning: A subcommand will
516)         be required in v1.0."
517)         """,

518)     )(

519)         context='Label :: Diagnostics :: Marker',

520)         single='Deprecation warning',

521)     )

522)     WARNING_LABEL = _Commented(

523)         comments=r"""
524)         TRANSLATORS: This is a short label that will be prepended to
525)         a warning message, e.g., "Warning: An empty service name is not
526)         supported by vault(1)."
527)         """,

528)     )(

529)         context='Label :: Diagnostics :: Marker',

530)         single='Warning',

531)     )

532)     CANNOT_UPDATE_SETTINGS_METAVAR_SETTINGS_TYPE_GLOBAL = (

533)         _Commented(

534)             comments=r"""
535)             TRANSLATORS: This is one of two values of the settings_type
536)             metavar used in the CANNOT_UPDATE_SETTINGS_NO_SETTINGS
537)             entry.  It is only used there.  The full sentence then
538)             reads: "Cannot update the global settings without any given
539)             settings."
540)             """,

541)         )(

542)             context='Label :: Error message :: Metavar',

543)             single='global settings',

544)         )
545)     )
546)     CANNOT_UPDATE_SETTINGS_METAVAR_SETTINGS_TYPE_SERVICE = (

547)         _Commented(

548)             comments=r"""
549)             TRANSLATORS: This is one of two values of the settings_type
550)             metavar used in the CANNOT_UPDATE_SETTINGS_NO_SETTINGS
551)             entry.  It is only used there.  The full sentence then
552)             reads: "Cannot update the service-specific settings without
553)             any given settings."
554)             """,

555)         )(

556)             context='Label :: Error message :: Metavar',

557)             single='service-specific settings',

558)         )
559)     )

560)     DERIVEPASSPHRASE_01 = _Commented(

561)         comments=r"""
562)         TRANSLATORS: This is the first paragraph of the command help
563)         text, but it also appears (in truncated form, if necessary) as
564)         one-line help text for this command.  The translation should
565)         thus be as meaningful as possible even if truncated.
566)         """,

567)     )(

568)         context='Label :: Help text :: Explanation',

569)         single="""

570)         Derive a strong passphrase, deterministically, from a master secret.
571)         """,
572)     )

573)     DERIVEPASSPHRASE_02 = _Commented(

574)         comments='',

575)     )(

576)         context='Label :: Help text :: Explanation',

577)         single="""

578)         The currently implemented subcommands are "vault" (for the
579)         scheme used by vault) and "export" (for exporting foreign
580)         configuration data).  See the respective `--help` output for
581)         instructions.  If no subcommand is given, we default to "vault".
582)         """,
583)     )

584)     DERIVEPASSPHRASE_03 = _Commented(

585)         comments='',

586)     )(

587)         context='Label :: Help text :: Explanation',

588)         single="""

589)         Deprecation notice: Defaulting to "vault" is deprecated.
590)         Starting in v1.0, the subcommand must be specified explicitly.
591)         """,
592)     )

593)     DERIVEPASSPHRASE_EPILOG_01 = _Commented(

594)         comments='',

595)     )(

596)         context='Label :: Help text :: Explanation',

597)         single=r"""

598)         Configuration is stored in a directory according to the
599)         `DERIVEPASSPHRASE_PATH` variable, which defaults to
600)         `~/.derivepassphrase` on UNIX-like systems and
601)         `C:\Users\<user>\AppData\Roaming\Derivepassphrase` on Windows.
602)         """,
603)     )

604)     DERIVEPASSPHRASE_EXPORT_01 = _Commented(

605)         comments=r"""
606)         TRANSLATORS: This is the first paragraph of the command help
607)         text, but it also appears (in truncated form, if necessary) as
608)         one-line help text for this command.  The translation should
609)         thus be as meaningful as possible even if truncated.
610)         """,

611)     )(

612)         context='Label :: Help text :: Explanation',

613)         single="""

614)         Export a foreign configuration to standard output.
615)         """,
616)     )

617)     DERIVEPASSPHRASE_EXPORT_02 = _Commented(

618)         comments='',

619)     )(

620)         context='Label :: Help text :: Explanation',

621)         single="""

622)         The only available subcommand is "vault", which implements the
623)         vault-native configuration scheme.  If no subcommand is given,
624)         we default to "vault".
625)         """,
626)     )
627)     DERIVEPASSPHRASE_EXPORT_03 = DERIVEPASSPHRASE_03

628)     DERIVEPASSPHRASE_EXPORT_VAULT_01 = _Commented(

629)         comments=r"""
630)         TRANSLATORS: This is the first paragraph of the command help
631)         text, but it also appears (in truncated form, if necessary) as
632)         one-line help text for this command.  The translation should
633)         thus be as meaningful as possible even if truncated.
634)         """,

635)     )(

636)         context='Label :: Help text :: Explanation',

637)         single="""

638)         Export a vault-native configuration to standard output.
639)         """,
640)     )

641)     DERIVEPASSPHRASE_EXPORT_VAULT_02 = _Commented(

642)         comments='',

643)     )(

644)         context='Label :: Help text :: Explanation',

645)         single="""

646)         Depending on the configuration format, {path_metavar!s} may
647)         either be a file or a directory.  We support the vault "v0.2",
648)         "v0.3" and "storeroom" formats.
649)         """,
650)         flags='python-brace-format',
651)     )

652)     DERIVEPASSPHRASE_EXPORT_VAULT_03 = _Commented(

653)         comments='',

654)     )(

655)         context='Label :: Help text :: Explanation',

656)         single="""

657)         If {path_metavar!s} is explicitly given as `VAULT_PATH`, then
658)         use the `VAULT_PATH` environment variable to determine the
659)         correct path.  (Use `./VAULT_PATH` or similar to indicate
660)         a file/directory actually named `VAULT_PATH`.)
661)         """,
662)         flags='python-brace-format',
663)     )

664)     DERIVEPASSPHRASE_VAULT_01 = _Commented(

665)         comments=r"""
666)         TRANSLATORS: This is the first paragraph of the command help
667)         text, but it also appears (in truncated form, if necessary) as
668)         one-line help text for this command.  The translation should
669)         thus be as meaningful as possible even if truncated.
670)         """,

671)     )(

672)         context='Label :: Help text :: Explanation',

673)         single="""

674)         Derive a passphrase using the vault derivation scheme.
675)         """,
676)     )

677)     DERIVEPASSPHRASE_VAULT_02 = _Commented(

678)         comments='',

679)     )(

680)         context='Label :: Help text :: Explanation',

681)         single="""

682)         If operating on global settings, or importing/exporting
683)         settings, then {service_metavar!s} must be omitted.  Otherwise
684)         it is required.
685)         """,
686)         flags='python-brace-format',
687)     )

688)     DERIVEPASSPHRASE_VAULT_EPILOG_01 = _Commented(

689)         comments='',

690)     )(

691)         context='Label :: Help text :: Explanation',

692)         single="""

693)         WARNING: There is NO WAY to retrieve the generated passphrases
694)         if the master passphrase, the SSH key, or the exact passphrase
695)         settings are lost, short of trying out all possible
696)         combinations.  You are STRONGLY advised to keep independent
697)         backups of the settings and the SSH key, if any.
698)         """,
699)     )

700)     DERIVEPASSPHRASE_VAULT_EPILOG_02 = _Commented(

701)         comments='',

702)     )(

703)         context='Label :: Help text :: Explanation',

704)         single="""

705)         The configuration is NOT encrypted, and you are STRONGLY
706)         discouraged from using a stored passphrase.
707)         """,
708)     )

709)     DEPRECATED_COMMAND_LABEL = _Commented(

710)         comments=r"""
711)         TRANSLATORS: We use this format string to indicate, at the
712)         beginning of a command's help text, that this command is
713)         deprecated.
714)         """,

715)     )(

716)         context='Label :: Help text :: Marker',

717)         single='(Deprecated) {text}',

718)         flags='python-brace-format',
719)     )

720)     DEBUG_OPTION_HELP_TEXT = _Commented(

721)         comments='',

722)     )(

723)         context='Label :: Help text :: One-line description',

724)         single='also emit debug information (implies --verbose)',

725)     )

726)     EXPORT_VAULT_FORMAT_HELP_TEXT = _Commented(

727)         comments=r"""

728)         TRANSLATORS: The defaults_hint is
729)         Label.EXPORT_VAULT_FORMAT_DEFAULTS_HELP_TEXT, the metavar is
730)         Label.EXPORT_VAULT_FORMAT_METAVAR_FMT.

731)         """,

732)     )(

733)         context='Label :: Help text :: One-line description',

734)         single=r"""

735)         try the following storage format {metavar!s}; may be
736)         specified multiple times, formats will be tried in order
737)         {defaults_hint!s}
738)         """,
739)         flags='python-brace-format',
740)     )

741)     EXPORT_VAULT_FORMAT_DEFAULTS_HELP_TEXT = _Commented(

742)         comments=r"""
743)         TRANSLATORS: See EXPORT_VAULT_FORMAT_HELP_TEXT.  The format
744)         names/labels "v0.3", "v0.2" and "storeroom" should not be
745)         translated.
746)         """,

747)     )(

748)         context='Label :: Help text :: One-line description',

749)         single=r"""

750)         (default: v0.3, v0.2, storeroom)
751)         """,
752)     )

753)     EXPORT_VAULT_KEY_HELP_TEXT = _Commented(

754)         comments=r"""

755)         TRANSLATORS: The defaults_hint is
756)         Label.EXPORT_VAULT_KEY_DEFAULTS_HELP_TEXT, the metavar is
757)         Label.EXPORT_VAULT_KEY_METAVAR_K.

758)         """,

759)     )(

760)         context='Label :: Help text :: One-line description',

761)         single=r"""

762)         use {metavar!s} as the storage master key {defaults_hint!s}
763)         """,
764)         flags='python-brace-format',
765)     )

766)     EXPORT_VAULT_KEY_DEFAULTS_HELP_TEXT = _Commented(

767)         comments=r"""
768)         TRANSLATORS: See EXPORT_VAULT_KEY_HELP_TEXT.
769)         """,

770)     )(

771)         context='Label :: Help text :: One-line description',

772)         single=r"""

773)         (default: check the `VAULT_KEY`, `LOGNAME`, `USER`, or
774)         `USERNAME` environment variables)
775)         """,
776)     )

777)     HELP_OPTION_HELP_TEXT = _Commented(

778)         comments='',

779)     )(

780)         context='Label :: Help text :: One-line description',

781)         single='show this help text, then exit',

782)     )

783)     QUIET_OPTION_HELP_TEXT = _Commented(

784)         comments='',

785)     )(

786)         context='Label :: Help text :: One-line description',

787)         single='suppress even warnings, emit only errors',

788)     )

789)     VERBOSE_OPTION_HELP_TEXT = _Commented(

790)         comments='',

791)     )(

792)         context='Label :: Help text :: One-line description',

793)         single='emit extra/progress information to standard error',

794)     )

795)     VERSION_OPTION_HELP_TEXT = _Commented(

796)         comments='',

797)     )(

798)         context='Label :: Help text :: One-line description',

799)         single='show applicable version information, then exit',

800)     )

801) 

802)     DERIVEPASSPHRASE_VAULT_PHRASE_HELP_TEXT = _Commented(

803)         comments='',

804)     )(

805)         context='Label :: Help text :: One-line description',

806)         single='prompt for a master passphrase',

807)     )

808)     DERIVEPASSPHRASE_VAULT_KEY_HELP_TEXT = _Commented(

809)         comments='',

810)     )(

811)         context='Label :: Help text :: One-line description',

812)         single='select a suitable SSH key from the SSH agent',

813)     )

814)     DERIVEPASSPHRASE_VAULT_LENGTH_HELP_TEXT = _Commented(

815)         comments=r"""

816)         TRANSLATORS: The metavar is
817)         Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.

818)         """,

819)     )(

820)         context='Label :: Help text :: One-line description',

821)         single='ensure a passphrase length of {metavar!s} characters',

822)         flags='python-brace-format',
823)     )

824)     DERIVEPASSPHRASE_VAULT_REPEAT_HELP_TEXT = _Commented(

825)         comments=r"""

826)         TRANSLATORS: The metavar is
827)         Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.

828)         """,

829)     )(

830)         context='Label :: Help text :: One-line description',

831)         single='forbid any run of {metavar!s} identical characters',

832)         flags='python-brace-format',
833)     )

834)     DERIVEPASSPHRASE_VAULT_LOWER_HELP_TEXT = _Commented(

835)         comments=r"""

836)         TRANSLATORS: The metavar is
837)         Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.

838)         """,

839)     )(

840)         context='Label :: Help text :: One-line description',

841)         single='ensure at least {metavar!s} lowercase characters',

842)         flags='python-brace-format',
843)     )

844)     DERIVEPASSPHRASE_VAULT_UPPER_HELP_TEXT = _Commented(

845)         comments=r"""

846)         TRANSLATORS: The metavar is
847)         Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.

848)         """,

849)     )(

850)         context='Label :: Help text :: One-line description',

851)         single='ensure at least {metavar!s} uppercase characters',

852)         flags='python-brace-format',
853)     )

854)     DERIVEPASSPHRASE_VAULT_NUMBER_HELP_TEXT = _Commented(

855)         comments=r"""

856)         TRANSLATORS: The metavar is
857)         Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.

858)         """,

859)     )(

860)         context='Label :: Help text :: One-line description',

861)         single='ensure at least {metavar!s} digits',

862)         flags='python-brace-format',
863)     )

864)     DERIVEPASSPHRASE_VAULT_SPACE_HELP_TEXT = _Commented(

865)         comments=r"""

866)         TRANSLATORS: The metavar is
867)         Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.

868)         """,

869)     )(

870)         context='Label :: Help text :: One-line description',

871)         single='ensure at least {metavar!s} spaces',

872)         flags='python-brace-format',
873)     )

874)     DERIVEPASSPHRASE_VAULT_DASH_HELP_TEXT = _Commented(

875)         comments=r"""

876)         TRANSLATORS: The metavar is
877)         Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.

878)         """,

879)     )(

880)         context='Label :: Help text :: One-line description',

881)         single='ensure at least {metavar!s} "-" or "_" characters',

882)         flags='python-brace-format',
883)     )

884)     DERIVEPASSPHRASE_VAULT_SYMBOL_HELP_TEXT = _Commented(

885)         comments=r"""

886)         TRANSLATORS: The metavar is
887)         Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.

888)         """,

889)     )(

890)         context='Label :: Help text :: One-line description',

891)         single='ensure at least {metavar!s} symbol characters',

892)         flags='python-brace-format',
893)     )
894) 

895)     DERIVEPASSPHRASE_VAULT_NOTES_HELP_TEXT = _Commented(

896)         comments='',

897)     )(

898)         context='Label :: Help text :: One-line description',

899)         single='spawn an editor to edit notes for {service_metavar!s}',

900)         flags='python-brace-format',
901)     )

902)     DERIVEPASSPHRASE_VAULT_CONFIG_HELP_TEXT = _Commented(

903)         comments='',

904)     )(

905)         context='Label :: Help text :: One-line description',

906)         single='save the given settings for {service_metavar!s}, or global',

907)         flags='python-brace-format',
908)     )

909)     DERIVEPASSPHRASE_VAULT_DELETE_HELP_TEXT = _Commented(

910)         comments='',

911)     )(

912)         context='Label :: Help text :: One-line description',

913)         single='delete the settings for {service_metavar!s}',

914)         flags='python-brace-format',
915)     )

916)     DERIVEPASSPHRASE_VAULT_DELETE_GLOBALS_HELP_TEXT = _Commented(

917)         comments='',

918)     )(

919)         context='Label :: Help text :: One-line description',

920)         single='delete the global settings',

921)     )

922)     DERIVEPASSPHRASE_VAULT_DELETE_ALL_HELP_TEXT = _Commented(

923)         comments='',

924)     )(

925)         context='Label :: Help text :: One-line description',

926)         single='delete all settings',

927)     )

928)     DERIVEPASSPHRASE_VAULT_EXPORT_HELP_TEXT = _Commented(

929)         comments="""

930)         TRANSLATORS: The metavar is
931)         Label.STORAGE_MANAGEMENT_METAVAR_SERVICE.

932)         """,

933)     )(

934)         context='Label :: Help text :: One-line description',

935)         single='export all saved settings to {metavar!s}',

936)         flags='python-brace-format',
937)     )

938)     DERIVEPASSPHRASE_VAULT_IMPORT_HELP_TEXT = _Commented(

939)         comments="""

940)         TRANSLATORS: The metavar is
941)         Label.STORAGE_MANAGEMENT_METAVAR_SERVICE.

942)         """,

943)     )(

944)         context='Label :: Help text :: One-line description',

945)         single='import saved settings from {metavar!s}',

946)         flags='python-brace-format',
947)     )

948)     DERIVEPASSPHRASE_VAULT_OVERWRITE_HELP_TEXT = _Commented(

949)         comments="""
950)         TRANSLATORS: The corresponding option is displayed as
951)         "--overwrite-existing / --merge-existing", so you may want to
952)         hint that the default (merge) is the second of those options.
953)         """,

954)     )(

955)         context='Label :: Help text :: One-line description',

956)         single='overwrite or merge (default) the existing configuration',

957)     )

958)     DERIVEPASSPHRASE_VAULT_UNSET_HELP_TEXT = _Commented(

959)         comments="""
960)         TRANSLATORS: The corresponding option is displayed as
961)         "--unset=phrase|key|...|symbol", so the "given setting" is
962)         referring to "phrase", "key", "lower", ..., or "symbol",
963)         respectively.  "with --config" here means that the user must
964)         also specify "--config" for this option to have any effect.
965)         """,

966)     )(

967)         context='Label :: Help text :: One-line description',

968)         single="""

969)         with --config, also unsets the given setting; may be specified
970)         multiple times
971)         """,
972)     )

973)     DERIVEPASSPHRASE_VAULT_EXPORT_AS_HELP_TEXT = _Commented(

974)         comments="""
975)         TRANSLATORS: The corresponding option is displayed as
976)         "--export-as=json|sh", so json refers to the JSON format
977)         (default) and sh refers to the POSIX sh format.
978)         """,

979)     )(

980)         context='Label :: Help text :: One-line description',

981)         single='when exporting, export as JSON (default) or POSIX sh',

982)     )
983) 

984)     EXPORT_VAULT_FORMAT_METAVAR_FMT = _Commented(

985)         comments='',

986)     )(

987)         context='Label :: Help text :: Metavar :: export vault',

988)         single='FMT',

989)     )

990)     EXPORT_VAULT_KEY_METAVAR_K = _Commented(

991)         comments=r"""

992)         TRANSLATORS: See Label.EXPORT_VAULT_KEY_HELP_TEXT.

993)         """,

994)     )(

995)         context='Label :: Help text :: Metavar :: export vault',

996)         single='K',

997)     )

998)     EXPORT_VAULT_METAVAR_PATH = _Commented(

999)         comments=r"""

1000)         TRANSLATORS: Used as "path_metavar" in
1001)         Label.DERIVEPASSPHRASE_EXPORT_VAULT_02 and others.

1002)         """,

1003)     )(

1004)         context='Label :: Help text :: Metavar :: export vault',

1005)         single='PATH',

1006)     )

1007)     PASSPHRASE_GENERATION_METAVAR_NUMBER = _Commented(

1008)         comments=r"""
1009)         TRANSLATORS: This metavar is also used in a matching epilog.
1010)         """,

1011)     )(

1012)         context='Label :: Help text :: Metavar :: vault',

1013)         single='NUMBER',

1014)     )

1015)     STORAGE_MANAGEMENT_METAVAR_PATH = _Commented(

1016)         comments=r"""
1017)         TRANSLATORS: This metavar is also used in multiple one-line help
1018)         texts.
1019)         """,

1020)     )(

1021)         context='Label :: Help text :: Metavar :: vault',

1022)         single='PATH',

1023)     )

1024)     VAULT_METAVAR_SERVICE = _Commented(

1025)         comments=r"""
1026)         TRANSLATORS: This metavar is also used in multiple one-line help
1027)         texts, as "service_metavar".
1028)         """,

1029)     )(

1030)         context='Label :: Help text :: Metavar :: vault',

1031)         single='SERVICE',

1032)     )

1033)     CONFIGURATION_EPILOG = _Commented(

1034)         comments='',

1035)     )(

1036)         context='Label :: Help text :: Explanation',

1037)         single='Use $VISUAL or $EDITOR to configure the spawned editor.',

1038)     )

1039)     PASSPHRASE_GENERATION_EPILOG = _Commented(

1040)         comments=r"""

1041)         TRANSLATORS: The metavar is
1042)         Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.

1043)         """,

1044)     )(

1045)         context='Label :: Help text :: Explanation',

1046)         single=r"""

1047)         Use {metavar!s}=0 to exclude a character type from the output.
1048)         """,
1049)         flags='python-brace-format',
1050)     )

1051)     STORAGE_MANAGEMENT_EPILOG = _Commented(

1052)         comments=r"""

1053)         TRANSLATORS: The metavar is
1054)         Label.STORAGE_MANAGEMENT_METAVAR_PATH.

1055)         """,

1056)     )(

1057)         context='Label :: Help text :: Explanation',

1058)         single=r"""

1059)         Using "-" as {metavar!s} for standard input/standard output
1060)         is supported.
1061)         """,
1062)         flags='python-brace-format',
1063)     )

1064)     COMMANDS_LABEL = _Commented(

1065)         comments='',

1066)     )(

1067)         context='Label :: Help text :: Option group name',

1068)         single='Commands',

1069)     )

1070)     COMPATIBILITY_OPTION_LABEL = _Commented(

1071)         comments='',

1072)     )(

1073)         context='Label :: Help text :: Option group name',

1074)         single='Compatibility and extension options',

1075)     )

1076)     CONFIGURATION_LABEL = _Commented(

1077)         comments='',

1078)     )(

1079)         context='Label :: Help text :: Option group name',

1080)         single='Configuration',

1081)     )

1082)     LOGGING_LABEL = _Commented(

1083)         comments='',

1084)     )(

1085)         context='Label :: Help text :: Option group name',

1086)         single='Logging',

1087)     )

1088)     OPTIONS_LABEL = _Commented(

1089)         comments='',

1090)     )(

1091)         context='Label :: Help text :: Option group name',

1092)         single='Options',

1093)     )

1094)     OTHER_OPTIONS_LABEL = _Commented(

1095)         comments='',

1096)     )(

1097)         context='Label :: Help text :: Option group name',

1098)         single='Other options',

1099)     )

1100)     PASSPHRASE_GENERATION_LABEL = _Commented(

1101)         comments='',

1102)     )(

1103)         context='Label :: Help text :: Option group name',

1104)         single='Passphrase generation',

1105)     )

1106)     STORAGE_MANAGEMENT_LABEL = _Commented(

1107)         comments='',

1108)     )(

1109)         context='Label :: Help text :: Option group name',

1110)         single='Storage management',

1111)     )

1112)     VERSION_INFO_TEXT = _Commented(

1113)         comments='',

1114)     )(

1115)         context='Label :: Info Message',

1116)         single=r"""
1117)         {PROG_NAME!s} {__version__}
1118)         """,  # noqa: RUF027

1119)         flags='python-brace-format',
1120)     )

1121)     CONFIRM_THIS_CHOICE_PROMPT_TEXT = _Commented(

1122)         comments=r"""
1123)         TRANSLATORS: There is no support for "yes" or "no" in other
1124)         languages than English, so it is advised that your translation
1125)         makes it clear that only the strings "y", "yes", "n" or "no" are
1126)         supported, even if the prompt becomes a bit longer.
1127)         """,

1128)     )(

1129)         context='Label :: Interactive prompt',

1130)         single='Confirm this choice? (y/N)',

1131)     )

1132)     SUITABLE_SSH_KEYS_LABEL = _Commented(

1133)         comments=r"""
1134)         TRANSLATORS: This label is the heading of the list of suitable
1135)         SSH keys.
1136)         """,

1137)     )(

1138)         context='Label :: Interactive prompt',

1139)         single='Suitable SSH keys:',

1140)     )

1141)     YOUR_SELECTION_PROMPT_TEXT = _Commented(

1142)         comments='',

1143)     )(

1144)         context='Label :: Interactive prompt',

1145)         single='Your selection? (1-{n}, leave empty to abort)',

1146)         flags='python-brace-format',
1147)     )

1148) 
1149) 

1150) class DebugMsgTemplate(enum.Enum):

1151)     BUCKET_ITEM_FOUND = _Commented(

1152)         comments=r"""
1153)         TRANSLATORS: This message is emitted by the vault configuration
1154)         exporter for "storeroom"-type configuration directories.  The
1155)         system stores entries in different "buckets" of a hash table.
1156)         Here, we report on a single item (path and value) we discovered
1157)         after decrypting the whole bucket.  (We ensure the path and
1158)         value are printable as-is.)
1159)         """,

1160)     )(

1161)         context='Debug message',

1162)         single='Found bucket item: {path} -> {value}',

1163)         flags='python-brace-format',
1164)     )

1165)     DECRYPT_BUCKET_ITEM_INFO = _Commented(

1166)         comments=r"""
1167)         TRANSLATORS: "AES256-CBC" and "PKCS#7" are, in essence, names of
1168)         formats, and should not be translated.  "IV" means
1169)         "initialization vector", and is specifically a cryptographic
1170)         term, as are "plaintext" and "ciphertext".
1171)         """,

1172)     )(

1173)         context='Debug message',

1174)         single="""

1175)         Decrypt bucket item contents:
1176) 
1177)           \b
1178)           Encryption key (master key): {enc_key}
1179)           Encryption cipher: AES256-CBC with PKCS#7 padding
1180)           Encryption IV: {iv}
1181)           Encrypted ciphertext: {ciphertext}
1182)           Plaintext: {plaintext}
1183)         """,
1184)         flags='python-brace-format',
1185)     )

1186)     DECRYPT_BUCKET_ITEM_KEY_INFO = _Commented(

1187)         comments='',

1188)     )(

1189)         context='Debug message',

1190)         single="""

1191)         Decrypt bucket item:
1192) 
1193)           \b
1194)           Plaintext: {plaintext}
1195)           Encryption key (master key): {enc_key}
1196)           Signing key (master key): {sign_key}
1197)         """,
1198)         flags='python-brace-format',
1199)     )

1200)     DECRYPT_BUCKET_ITEM_MAC_INFO = _Commented(

1201)         comments=r"""
1202)         TRANSLATORS: The MAC stands for "message authentication code",
1203)         which guarantees the authenticity of the message to anyone who
1204)         holds the corresponding key, similar to a digital signature.
1205)         The acronym "MAC" is assumed to be well-known to the English
1206)         target audience, or at least discoverable by them; they *are*
1207)         asking for debug output, after all.  Please use your judgement
1208)         as to whether to translate this term or not, expanded or not.
1209)         """,

1210)     )(

1211)         context='Debug message',

1212)         single="""

1213)         Decrypt bucket item contents:
1214) 
1215)           \b
1216)           MAC key: {sign_key}
1217)           Authenticated content: {ciphertext}
1218)           Claimed MAC value: {claimed_mac}
1219)           Computed MAC value: {actual_mac}
1220)         """,
1221)         flags='python-brace-format',
1222)     )

1223)     DECRYPT_BUCKET_ITEM_SESSION_KEYS_INFO = _Commented(

1224)         comments=r"""
1225)         TRANSLATORS: "AES256-CBC" and "PKCS#7" are, in essence, names of
1226)         formats, and should not be translated.  "IV" means
1227)         "initialization vector", and is specifically a cryptographic
1228)         term, as are "plaintext" and "ciphertext".
1229)         """,

1230)     )(

1231)         context='Debug message',

1232)         single="""

1233)         Decrypt bucket item session keys:
1234) 
1235)           \b
1236)           Encryption key (master key): {enc_key}
1237)           Encryption cipher: AES256-CBC with PKCS#7 padding
1238)           Encryption IV: {iv}
1239)           Encrypted ciphertext: {ciphertext}
1240)           Plaintext: {plaintext}
1241)           Parsed plaintext: {code}
1242)         """,
1243)         flags='python-brace-format',
1244)     )

1245)     DECRYPT_BUCKET_ITEM_SESSION_KEYS_MAC_INFO = _Commented(

1246)         comments=r"""
1247)         TRANSLATORS: The MAC stands for "message authentication code",
1248)         which guarantees the authenticity of the message to anyone who
1249)         holds the corresponding key, similar to a digital signature.
1250)         The acronym "MAC" is assumed to be well-known to the English
1251)         target audience, or at least discoverable by them; they *are*
1252)         asking for debug output, after all.  Please use your judgement
1253)         as to whether to translate this term or not, expanded or not.
1254)         """,

1255)     )(

1256)         context='Debug message',

1257)         single="""

1258)         Decrypt bucket item session keys:
1259) 
1260)           \b
1261)           MAC key (master key): {sign_key}
1262)           Authenticated content: {ciphertext}
1263)           Claimed MAC value: {claimed_mac}
1264)           Computed MAC value: {actual_mac}
1265)         """,
1266)         flags='python-brace-format',
1267)     )

1268)     DERIVED_MASTER_KEYS_KEYS = _Commented(

1269)         comments='',

1270)     )(

1271)         context='Debug message',

1272)         single="""

1273)         Derived master keys' keys:
1274) 
1275)           \b
1276)           Encryption key: {enc_key}
1277)           Signing key: {sign_key}
1278)           Password: {pw_bytes}
1279)           Function call: pbkdf2(algorithm={algorithm!r}, length={length!r}, salt={salt!r}, iterations={iterations!r})
1280) 
1281)         """,  # noqa: E501
1282)         flags='python-brace-format',
1283)     )

1284)     DIRECTORY_CONTENTS_CHECK_OK = _Commented(

1285)         comments=r"""
1286)         TRANSLATORS: This message is emitted by the vault configuration
1287)         exporter for "storeroom"-type configuration directories, while
1288)         "assembling" the items stored in the configuration according to
1289)         the item's "path".  Each "directory" in the path contains a list
1290)         of children it claims to contain, and this list must be matched
1291)         against the actual discovered items.  Now, at the end, we
1292)         actually confirm the claim.  (We would have already thrown an
1293)         error here otherwise.)
1294)         """,

1295)     )(

1296)         context='Debug message',

1297)         single='Directory contents check OK: {path} -> {contents}',

1298)         flags='python-brace-format',
1299)     )

1300)     MASTER_KEYS_DATA_MAC_INFO = _Commented(

1301)         comments=r"""
1302)         TRANSLATORS: The MAC stands for "message authentication code",
1303)         which guarantees the authenticity of the message to anyone who
1304)         holds the corresponding key, similar to a digital signature.
1305)         The acronym "MAC" is assumed to be well-known to the English
1306)         target audience, or at least discoverable by them; they *are*
1307)         asking for debug output, after all.  Please use your judgement
1308)         as to whether to translate this term or not, expanded or not.
1309)         """,

1310)     )(

1311)         context='Debug message',

1312)         single="""

1313)         Master keys data:
1314) 
1315)           \b
1316)           MAC key: {sign_key}
1317)           Authenticated content: {ciphertext}
1318)           Claimed MAC value: {claimed_mac}
1319)           Computed MAC value: {actual_mac}
1320)         """,
1321)         flags='python-brace-format',
1322)     )

1323)     POSTPONING_DIRECTORY_CONTENTS_CHECK = _Commented(

1324)         comments=r"""
1325)         TRANSLATORS: This message is emitted by the vault configuration
1326)         exporter for "storeroom"-type configuration directories, while
1327)         "assembling" the items stored in the configuration according to
1328)         the item's "path".  Each "directory" in the path contains a list
1329)         of children it claims to contain, and this list must be matched
1330)         against the actual discovered items.  When emitting this
1331)         message, we merely indicate that we saved the "claimed" list for
1332)         this directory for later.
1333)         """,

1334)     )(

1335)         context='Debug message',

1336)         single='Postponing directory contents check: {path} -> {contents}',

1337)         flags='python-brace-format',
1338)     )

1339)     SETTING_CONFIG_STRUCTURE_CONTENTS = _Commented(

1340)         comments=r"""
1341)         TRANSLATORS: This message is emitted by the vault configuration
1342)         exporter for "storeroom"-type configuration directories, while
1343)         "assembling" the items stored in the configuration according to
1344)         the item's "path".  We confirm that we set the entry at the
1345)         given path to the given value.
1346)         """,

1347)     )(

1348)         context='Debug message',

1349)         single='Setting contents: {path} -> {value}',

1350)         flags='python-brace-format',
1351)     )

1352)     SETTING_CONFIG_STRUCTURE_CONTENTS_EMPTY_DIRECTORY = _Commented(

1353)         comments=r"""
1354)         TRANSLATORS: This message is emitted by the vault configuration
1355)         exporter for "storeroom"-type configuration directories, while
1356)         "assembling" the items stored in the configuration according to
1357)         the item's "path".  We confirm that we set up a currently empty
1358)         directory at the given path.
1359)         """,

1360)     )(

1361)         context='Debug message',

1362)         single='Setting contents (empty directory): {path}',

1363)         flags='python-brace-format',
1364)     )

1365)     VAULT_NATIVE_EVP_BYTESTOKEY_INIT = _Commented(

1366)         comments=r"""
1367)         TRANSLATORS: This message is emitted by the vault configuration
1368)         exporter for "native"-type configuration directories: in v0.2,
1369)         the non-standard and deprecated "EVP_bytestokey" function from
1370)         OpenSSL must be reimplemented from scratch.  The terms "salt"
1371)         and "IV" (initialization vector) are cryptographic terms.
1372)         """,

1373)     )(

1374)         context='Debug message',

1375)         single="""

1376)         evp_bytestokey_md5 (initialization):
1377) 
1378)           \b
1379)           Input: {data}
1380)           Salt: {salt}
1381)           Key size: {key_size}
1382)           IV size: {iv_size}
1383)           Buffer length: {buffer_length}
1384)           Buffer: {buffer}
1385)         """,
1386)         flags='python-brace-format',
1387)     )

1388)     VAULT_NATIVE_EVP_BYTESTOKEY_RESULT = _Commented(

1389)         comments=r"""
1390)         TRANSLATORS: This message is emitted by the vault configuration
1391)         exporter for "native"-type configuration directories: in v0.2,
1392)         the non-standard and deprecated "EVP_bytestokey" function from
1393)         OpenSSL must be reimplemented from scratch.  The terms "salt"
1394)         and "IV" (initialization vector) are cryptographic terms.
1395)         This function reports on the updated buffer length and contents
1396)         after executing one round of hashing.
1397)         """,

1398)     )(

1399)         context='Debug message',

1400)         single="""

1401)         evp_bytestokey_md5 (result):
1402) 
1403)           \b
1404)           Encryption key: {enc_key}
1405)           IV: {iv}
1406)         """,
1407)         flags='python-brace-format',
1408)     )

1409)     VAULT_NATIVE_EVP_BYTESTOKEY_ROUND = _Commented(

1410)         comments=r"""
1411)         TRANSLATORS: This message is emitted by the vault configuration
1412)         exporter for "native"-type configuration directories: in v0.2,
1413)         the non-standard and deprecated "EVP_bytestokey" function from
1414)         OpenSSL must be reimplemented from scratch.  The terms "salt"
1415)         and "IV" (initialization vector) are cryptographic terms.
1416)         This function reports on the updated buffer length and contents
1417)         after executing one round of hashing.
1418)         """,

1419)     )(

1420)         context='Debug message',

1421)         single="""

1422)         evp_bytestokey_md5 (round update):
1423) 
1424)           \b
1425)           Buffer length: {buffer_length}
1426)           Buffer: {buffer}
1427)         """,
1428)         flags='python-brace-format',
1429)     )

1430)     VAULT_NATIVE_CHECKING_MAC_DETAILS = _Commented(

1431)         comments=r"""
1432)         TRANSLATORS: This message is emitted by the vault configuration
1433)         exporter for "native"-type configuration directories.  It is
1434)         preceded by the info message PARSING_IV_PAYLOAD_MAC; see the
1435)         commentary there concerning the terms and thoughts on
1436)         translating them.
1437)         """,

1438)     )(

1439)         context='Debug message',

1440)         single="""

1441)         MAC details:
1442) 
1443)           \b
1444)           MAC input: {mac_input}
1445)           Expected MAC: {mac}
1446)         """,
1447)         flags='python-brace-format',
1448)     )

1449)     VAULT_NATIVE_PADDED_PLAINTEXT = _Commented(

1450)         comments=r"""
1451)         TRANSLATORS: This message is emitted by the vault configuration
1452)         exporter for "native"-type configuration directories.  "padding"
1453)         and "plaintext" are cryptographic terms.
1454)         """,

1455)     )(

1456)         context='Debug message',

1457)         single='Padded plaintext: {contents}',

1458)         flags='python-brace-format',
1459)     )

1460)     VAULT_NATIVE_PARSE_BUFFER = _Commented(

1461)         comments=r"""
1462)         TRANSLATORS: This message is emitted by the vault configuration
1463)         exporter for "native"-type configuration directories.  It is
1464)         preceded by the info message PARSING_IV_PAYLOAD_MAC; see the
1465)         commentary there concerning the terms and thoughts on
1466)         translating them.
1467)         """,

1468)     )(

1469)         context='Debug message',

1470)         single="""

1471)         Buffer: {contents}
1472) 
1473)           \b
1474)           IV: {iv}
1475)           Payload: {payload}
1476)           MAC: {mac}
1477)         """,
1478)         flags='python-brace-format',
1479)     )

1480)     VAULT_NATIVE_PLAINTEXT = _Commented(

1481)         comments=r"""
1482)         TRANSLATORS: This message is emitted by the vault configuration
1483)         exporter for "native"-type configuration directories.
1484)         "plaintext" is a cryptographic term.
1485)         """,

1486)     )(

1487)         context='Debug message',

1488)         single='Plaintext: {contents}',

1489)         flags='python-brace-format',
1490)     )

1491)     VAULT_NATIVE_PBKDF2_CALL = _Commented(

1492)         comments='',

1493)     )(

1494)         context='Debug message',

1495)         single="""

1496)         Master key derivation:
1497) 
1498)           \b
1499)           PBKDF2 call: PBKDF2-HMAC(password={password!r}, salt={salt!r}, iterations={iterations!r}, key_size={key_size!r}, algorithm={algorithm!r})
1500)           Result (binary): {raw_result}
1501)           Result (hex key): {result_key!r}
1502)         """,  # noqa: E501
1503)         flags='python-brace-format',
1504)     )

1505)     VAULT_NATIVE_V02_PAYLOAD_MAC_POSTPROCESSING = _Commented(

1506)         comments=r"""
1507)         TRANSLATORS: This message is emitted by the vault configuration
1508)         exporter for "native"-type configuration directories.  It is
1509)         preceded by the info message PARSING_IV_PAYLOAD_MAC and the
1510)         debug message PARSING_NATIVE_PARSE_BUFFER; see the commentary
1511)         there concerning the terms and thoughts on translating them.
1512)         """,

1513)     )(
1514)         context='Debug message',
1515)         single="""

1516)         Postprocessing buffer (v0.2):
1517) 
1518)           \b
1519)           Payload: {payload} (decoded from base64)
1520)           MAC: {mac} (decoded from hex)
1521)         """,
1522)         flags='python-brace-format',
1523)     )
1524) 
1525) 

1526) class InfoMsgTemplate(enum.Enum):

1527)     ASSEMBLING_CONFIG_STRUCTURE = _Commented(

1528)         comments=r"""
1529)         TRANSLATORS: This message is emitted by the vault configuration
1530)         exporter for "storeroom"-type configuration directories.  The
1531)         system stores entries in different "buckets" of a hash table.
1532)         After the respective items in the buckets have been decrypted,
1533)         we then have a list of item paths plus contents to populate.
1534)         This must be done in a certain order (we don't yet have an
1535)         existing directory tree to rely on, but rather must build it
1536)         on-the-fly), hence the term "assembling".
1537)         """,

1538)     )(

1539)         context='Info message',

1540)         single='Assembling config structure',

1541)     )

1542)     CANNOT_LOAD_AS_VAULT_CONFIG = _Commented(

1543)         comments=r"""
1544)         TRANSLATORS: "fmt" is a string such as "v0.2" or "storeroom",
1545)         indicating the format which we tried to load the vault
1546)         configuration as.
1547)         """,

1548)     )(

1549)         context='Info message',

1550)         single='Cannot load {path!r} as a {fmt!s} vault configuration.',

1551)         flags='python-brace-format',
1552)     )

1553)     CHECKING_CONFIG_STRUCTURE_CONSISTENCY = _Commented(

1554)         comments=r"""
1555)         TRANSLATORS: This message is emitted by the vault configuration
1556)         exporter for "storeroom"-type configuration directories.  Having
1557)         "assembled" the configuration items according to their claimed
1558)         paths and contents, we then check if the assembled structure is
1559)         internally consistent.
1560)         """,

1561)     )(

1562)         context='Info message',

1563)         single='Checking config structure consistency',

1564)     )

1565)     DECRYPTING_BUCKET = _Commented(

1566)         comments=r"""
1567)         TRANSLATORS: This message is emitted by the vault configuration
1568)         exporter for "storeroom"-type configuration directories.  The
1569)         system stores entries in different "buckets" of a hash table.
1570)         We parse the directory bucket by bucket.  All buckets are
1571)         numbered in hexadecimal, and typically there are 32 buckets, so
1572)         2-digit hex numbers.
1573)         """,

1574)     )(

1575)         context='Info message',

1576)         single='Decrypting bucket {bucket_number}',

1577)         flags='python-brace-format',
1578)     )

1579)     PARSING_MASTER_KEYS_DATA = _Commented(

1580)         comments=r"""
1581)         TRANSLATORS: This message is emitted by the vault configuration
1582)         exporter for "storeroom"-type configuration directories.
1583)         `.keys` is a filename, from which data about the master keys for
1584)         this configuration are loaded.
1585)         """,

1586)     )(

1587)         context='Info message',

1588)         single='Parsing master keys data from .keys',

1589)     )

1590)     PIP_INSTALL_EXTRA = _Commented(

1591)         comments=r"""
1592)         TRANSLATORS: This message immediately follows an error message
1593)         about a missing library that needs to be installed.  The Python
1594)         Package Index (PyPI) supports declaring sets of optional
1595)         dependencies as "extras", so users installing from PyPI can
1596)         request reinstallation with a named "extra" being enabled.  This
1597)         would then let the installer take care of the missing libraries
1598)         automatically, hence this suggestion to PyPI users.
1599)         """,

1600)     )(

1601)         context='Info message',

1602)         single="""
1603)         (For users installing from PyPI, see the {extra_name!r} extra.)
1604)         """,

1605)         flags='python-brace-format',
1606)     )

1607)     SUCCESSFULLY_MIGRATED = _Commented(

1608)         comments=r"""
1609)         TRANSLATORS: This info message immediately follows the "Using
1610)         deprecated v0.1-style ..." deprecation warning.
1611)         """,

1612)     )(

1613)         context='Info message',

1614)         single='Successfully migrated to {path!r}.',

1615)         flags='python-brace-format',
1616)     )

1617)     VAULT_NATIVE_CHECKING_MAC = _Commented(

1618)         comments='',

1619)     )(

1620)         context='Info message',

1621)         single='Checking MAC',

1622)     )

1623)     VAULT_NATIVE_DECRYPTING_CONTENTS = _Commented(

1624)         comments='',

1625)     )(

1626)         context='Info message',

1627)         single='Decrypting contents',

1628)     )

1629)     VAULT_NATIVE_DERIVING_KEYS = _Commented(

1630)         comments='',

1631)     )(

1632)         context='Info message',

1633)         single='Deriving an encryption and signing key',

1634)     )

1635)     VAULT_NATIVE_PARSING_IV_PAYLOAD_MAC = _Commented(

1636)         comments=r"""
1637)         TRANSLATORS: This message is emitted by the vault configuration
1638)         exporter for "native"-type configuration directories.  "IV"
1639)         means "initialization vector", and "MAC" means "message
1640)         authentication code".  They are specifically cryptographic
1641)         terms, as is "payload".  The acronyms "IV" and "MAC" are assumed
1642)         to be well-known to the English target audience, or at least
1643)         discoverable by them; they *are* asking for debug output, after
1644)         all.  Please use your judgement as to whether to translate this
1645)         term or not, expanded or not.
1646)         """,

1647)     )(

1648)         context='Info message',

1649)         single='Parsing IV, payload and MAC from the file contents',

1650)     )

1651) 
1652) 
1653) class WarnMsgTemplate(enum.Enum):

1654)     EMPTY_SERVICE_NOT_SUPPORTED = _Commented(

1655)         comments='',

1656)     )(

1657)         context='Warning message',

1658)         single="""

1659)         An empty {service_metavar!s} is not supported by vault(1).
1660)         For compatibility, this will be treated as if SERVICE was not
1661)         supplied, i.e., it will error out, or operate on global settings.
1662)         """,
1663)         flags='python-brace-format',

1664)     )

1665)     EMPTY_SERVICE_SETTINGS_INACCESSIBLE = _Commented(

1666)         comments='',

1667)     )(

1668)         context='Warning message',

1669)         single="""

1670)         An empty {service_metavar!s} is not supported by vault(1).
1671)         The empty-string service settings will be inaccessible and
1672)         ineffective.  To ensure that vault(1) and {PROG_NAME!s} see the
1673)         settings, move them into the "global" section.
1674)         """,
1675)         flags='python-brace-format',

1676)     )

1677)     FAILED_TO_MIGRATE_CONFIG = _Commented(

1678)         comments=r"""

1679)         TRANSLATORS: "error" is supplied by the operating system
1680)         (errno/strerror).

1681)         """,

1682)     )(

1683)         context='Warning message',

1684)         single='Failed to migrate to {path!r}: {error!s}: {filename!r}.',

1685)         flags='python-brace-format',
1686)     )

1687)     GLOBAL_PASSPHRASE_INEFFECTIVE = _Commented(

1688)         comments='',

1689)     )(

1690)         context='Warning message',

1691)         single=r"""

1692)         Setting a global passphrase is ineffective
1693)         because a key is also set.
1694)         """,

1695)     )

1696)     PASSPHRASE_NOT_NORMALIZED = _Commented(

1697)         comments=r"""
1698)         TRANSLATORS: The key is a (vault) configuration key, in JSONPath
1699)         syntax, typically "$.global" for the global passphrase or
1700)         "$.services.service_name" or "$.services["service with spaces"]"
1701)         for the services "service_name" and "service with spaces",
1702)         respectively.  The form is one of the four Unicode normalization
1703)         forms: NFC, NFD, NFKC, NFKD.
1704) 
1705)         The asterisks are not special.  Please feel free to substitute
1706)         any other appropriate way to mark up emphasis of the word
1707)         "displays".
1708)         """,

1709)     )(

1710)         context='Warning message',

1711)         single=r"""

1712)         The {key!s} passphrase is not {form!s}-normalized.  Its
1713)         serialization as a byte string may not be what you expect it to
1714)         be, even if it *displays* correctly.  Please make sure to
1715)         double-check any derived passphrases for unexpected results.
1716)         """,

1717)         flags='python-brace-format',
1718)     )

1719)     SERVICE_NAME_INCOMPLETABLE = _Commented(

1720)         comments='',

1721)     )(

1722)         context='Warning message',

1723)         single="""

1724)         The service name {service!r} contains an ASCII control
1725)         character, which is not supported by our shell completion code.
1726)         This service name will therefore not be available for completion
1727)         on the command-line.  You may of course still type it in
1728)         manually in whatever format your shell accepts, but we highly
1729)         recommend choosing a different service name instead.
1730)         """,
1731)         flags='python-brace-format',
1732)     )

1733)     SERVICE_PASSPHRASE_INEFFECTIVE = _Commented(

1734)         comments=r"""
1735)         TRANSLATORS: The key that is set need not necessarily be set at
1736)         the service level; it may be a global key as well.
1737)         """,

1738)     )(

1739)         context='Warning message',

1740)         single=r"""

1741)         Setting a service passphrase is ineffective because a key is
1742)         also set: {service!s}.
1743)         """,

1744)         flags='python-brace-format',
1745)     )

1746)     STEP_REMOVE_INEFFECTIVE_VALUE = _Commented(

1747)         comments='',

1748)     )(

1749)         context='Warning message',

1750)         single='Removing ineffective setting {path!s} = {old!s}.',

1751)         flags='python-brace-format',
1752)     )

1753)     STEP_REPLACE_INVALID_VALUE = _Commented(

1754)         comments='',

1755)     )(

1756)         context='Warning message',

1757)         single="""
1758)         Replacing invalid value {old!s} for key {path!s} with {new!s}.
1759)         """,

1760)         flags='python-brace-format',
1761)     )

1762)     V01_STYLE_CONFIG = _Commented(

1763)         comments='',

1764)     )(

1765)         context='Warning message :: Deprecation',

1766)         single=r"""

1767)         Using deprecated v0.1-style config file {old!r}, instead of
1768)         v0.2-style {new!r}.  Support for v0.1-style config filenames

1769)         will be removed in v1.0.

1770)         """,

1771)         flags='python-brace-format',
1772)     )

1773)     V10_SUBCOMMAND_REQUIRED = _Commented(

1774)         comments=r"""
1775)         TRANSLATORS: This deprecation warning may be issued at any
1776)         level, i.e. we may actually be talking about subcommands, or
1777)         sub-subcommands, or sub-sub-subcommands, etc., which is what the
1778)         "here" is supposed to indicate.
1779)         """,

1780)     )(

1781)         context='Warning message :: Deprecation',

1782)         single="""

1783)         A subcommand will be required here in v1.0.  See --help for
1784)         available subcommands.  Defaulting to subcommand "vault".
1785)         """,

1786)     )
1787) 
1788) 
1789) class ErrMsgTemplate(enum.Enum):

1790)     AGENT_REFUSED_LIST_KEYS = _Commented(

1791)         comments=r"""
1792)         TRANSLATORS: "loaded keys" being keys loaded into the agent.
1793)         """,

1794)     )(

1795)         context='Error message',

1796)         single="""

1797)         The SSH agent failed to or refused to supply a list of loaded keys.
1798)         """,
1799)     )

1800)     AGENT_REFUSED_SIGNATURE = _Commented(

1801)         comments=r"""
1802)         TRANSLATORS: The message to be signed is the vault UUID, but
1803)         there's no space to explain that here, so ideally the error
1804)         message does not go into detail.
1805)         """,

1806)     )(

1807)         context='Error message',

1808)         single="""

1809)         The SSH agent failed to or refused to issue a signature with the
1810)         selected key, necessary for deriving a service passphrase.
1811)         """,
1812)     )

1813)     CANNOT_CONNECT_TO_AGENT = _Commented(

1814)         comments=r"""

1815)         TRANSLATORS: "error" is supplied by the operating system
1816)         (errno/strerror).

1817)         """,

1818)     )(

1819)         context='Error message',

1820)         single='Cannot connect to the SSH agent: {error!s}: {filename!r}.',

1821)         flags='python-brace-format',
1822)     )

1823)     CANNOT_DECODEIMPORT_VAULT_SETTINGS = _Commented(

1824)         comments=r"""
1825)         TRANSLATORS: "error" is supplied by the operating system
1826)         (errno/strerror).
1827)         """,

1828)     )(

1829)         context='Error message',

1830)         single='Cannot import vault settings: cannot decode JSON: {error!s}.',

1831)         flags='python-brace-format',
1832)     )

1833)     CANNOT_EXPORT_VAULT_SETTINGS = _Commented(

1834)         comments=r"""

1835)         TRANSLATORS: "error" is supplied by the operating system
1836)         (errno/strerror).

1837)         """,

1838)     )(

1839)         context='Error message',

1840)         single='Cannot export vault settings: {error!s}: {filename!r}.',

1841)         flags='python-brace-format',
1842)     )

1843)     CANNOT_IMPORT_VAULT_SETTINGS = _Commented(

1844)         comments=r"""

1845)         TRANSLATORS: "error" is supplied by the operating system
1846)         (errno/strerror).

1847)         """,

1848)     )(

1849)         context='Error message',

1850)         single='Cannot import vault settings: {error!s}: {filename!r}.',

1851)         flags='python-brace-format',
1852)     )

1853)     CANNOT_LOAD_USER_CONFIG = _Commented(

1854)         comments=r"""

1855)         TRANSLATORS: "error" is supplied by the operating system
1856)         (errno/strerror).

1857)         """,

1858)     )(

1859)         context='Error message',

1860)         single='Cannot load user config: {error!s}: {filename!r}.',

1861)         flags='python-brace-format',
1862)     )

1863)     CANNOT_LOAD_VAULT_SETTINGS = _Commented(

1864)         comments=r"""

1865)         TRANSLATORS: "error" is supplied by the operating system
1866)         (errno/strerror).

1867)         """,

1868)     )(

1869)         context='Error message',

1870)         single='Cannot load vault settings: {error!s}: {filename!r}.',

1871)         flags='python-brace-format',
1872)     )

1873)     CANNOT_PARSE_AS_VAULT_CONFIG = _Commented(

1874)         comments=r"""
1875)         TRANSLATORS: Unlike the "Cannot load {path!r} as a {fmt!s} vault
1876)         configuration." message, *this* error message is emitted when we
1877)         have tried loading the path in each of our supported formats,
1878)         and failed.  The user will thus see the above "Cannot load ..."
1879)         warning message potentially multiple times, and this error
1880)         message at the very bottom.
1881)         """,

1882)     )(

1883)         context='Error message',

1884)         single=r"""

1885)         Cannot parse {path!r} as a valid vault-native configuration
1886)         file/directory.
1887)         """,

1888)         flags='python-brace-format',
1889)     )

1890)     CANNOT_PARSE_AS_VAULT_CONFIG_OSERROR = _Commented(

1891)         comments=r"""
1892)         TRANSLATORS: "error" is supplied by the operating system
1893)         (errno/strerror).
1894)         """,

1895)     )(

1896)         context='Error message',

1897)         single=r"""

1898)         Cannot parse {path!r} as a valid vault-native configuration
1899)         file/directory: {error!s}: {filename!r}.
1900)         """,
1901)         flags='python-brace-format',
1902)     )

1903)     CANNOT_STORE_VAULT_SETTINGS = _Commented(

1904)         comments=r"""

1905)         TRANSLATORS: "error" is supplied by the operating system
1906)         (errno/strerror).

1907)         """,

1908)     )(

1909)         context='Error message',

1910)         single='Cannot store vault settings: {error!s}: {filename!r}.',

1911)         flags='python-brace-format',
1912)     )

1913)     CANNOT_UNDERSTAND_AGENT = _Commented(

1914)         comments=r"""
1915)         TRANSLATORS: This error message is used whenever we cannot make
1916)         any sense of a response from the SSH agent because the response
1917)         is ill-formed (truncated, improperly encoded, etc.) or otherwise
1918)         violates the communications protocol.  Well-formed responses
1919)         that adhere to the protocol, even if they indicate that the
1920)         requested operation failed, are handled with a different error
1921)         message.
1922)         """,

1923)     )(

1924)         context='Error message',

1925)         single="""

1926)         Cannot understand the SSH agent's response because it violates
1927)         the communications protocol.
1928)         """,
1929)     )

1930)     CANNOT_UPDATE_SETTINGS_NO_SETTINGS = _Commented(

1931)         comments=r"""
1932)         TRANSLATORS: The settings_type metavar contains translations for
1933)         either "global settings" or "service-specific settings"; see the
1934)         CANNOT_UPDATE_SETTINGS_METAVAR_SETTINGS_TYPE_GLOBAL and
1935)         CANNOT_UPDATE_SETTINGS_METAVAR_SETTINGS_TYPE_SERVICE entries.
1936)         The first sentence will thus read either "Cannot update the
1937)         global settings without any given settings." or "Cannot update
1938)         the service-specific settings without any given settings.".  You
1939)         may update this entry, and the two metavar entries, in any way
1940)         you see fit that achieves the desired translations of the first
1941)         sentence.
1942)         """,

1943)     )(

1944)         context='Error message',

1945)         single=r"""

1946)         Cannot update the {settings_type!s} without any given settings.
1947)         You must specify at least one of --lower, ..., --symbol, or
1948)         --phrase or --key.

1949)         """,

1950)         flags='python-brace-format',
1951)     )

1952)     INVALID_USER_CONFIG = _Commented(

1953)         comments=r"""

1954)         TRANSLATORS: "error" is supplied by the operating system
1955)         (errno/strerror).

1956)         """,

1957)     )(

1958)         context='Error message',

1959)         single=r"""

1960)         The user configuration file is invalid.  {error!s}: {filename!r}.
1961)         """,
1962)         flags='python-brace-format',
1963)     )

1964)     INVALID_VAULT_CONFIG = _Commented(

1965)         comments=r"""
1966)         TRANSLATORS: This error message is a reaction to a validator
1967)         function saying *that* the configuration is not valid, but not
1968)         *how* it is not valid.  The configuration file is principally
1969)         parsable, however.
1970)         """,

1971)     )(

1972)         context='Error message',

1973)         single='Invalid vault config: {config!r}.',

1974)         flags='python-brace-format',
1975)     )

1976)     MISSING_MODULE = _Commented(

1977)         comments='',

1978)     )(

1979)         context='Error message',

1980)         single='Cannot load the required Python module {module!r}.',

1981)         flags='python-brace-format',
1982)     )

1983)     NO_AF_UNIX = _Commented(

1984)         comments='',

1985)     )(

1986)         context='Error message',

1987)         single=r"""

1988)         Cannot connect to an SSH agent because this Python version does
1989)         not support UNIX domain sockets.
1990)         """,

1991)     )

1992)     NO_KEY_OR_PHRASE = _Commented(

1993)         comments='',

1994)     )(

1995)         context='Error message',

1996)         single=r"""

1997)         No passphrase or key was given in the configuration.  In this
1998)         case, the --phrase or --key argument is required.
1999)         """,

2000)     )

2001)     NO_SSH_AGENT_FOUND = _Commented(

2002)         comments='',

2003)     )(

2004)         context='Error message',

2005)         single="""

2006)         Cannot find any running SSH agent because SSH_AUTH_SOCK is not set.
2007)         """,

2008)     )

2009)     NO_SUITABLE_SSH_KEYS = _Commented(

2010)         comments='',

2011)     )(

2012)         context='Error message',

2013)         single="""

2014)         The SSH agent contains no keys suitable for {PROG_NAME!s}.
2015)         """,  # noqa: RUF027
2016)         flags='python-brace-format',
2017)     )

2018)     PARAMS_MUTUALLY_EXCLUSIVE = _Commented(

2019)         comments=r"""
2020)         TRANSLATORS: The params are long-form command-line option names.
2021)         Typical example: "--key is mutually exclusive with --phrase."
2022)         """,

2023)     )(

2024)         context='Error message',

2025)         single='{param1!s} is mutually exclusive with {param2!s}.',

2026)         flags='python-brace-format',
2027)     )

2028)     PARAMS_NEEDS_SERVICE_OR_CONFIG = _Commented(

2029)         comments=r"""
2030)         TRANSLATORS: The param is a long-form command-line option name,

2031)         the metavar is Label.VAULT_METAVAR_SERVICE.

2032)         """,

2033)     )(

2034)         context='Error message',

2035)         single='{param!s} requires a {service_metavar!s} or --config.',

2036)         flags='python-brace-format',
2037)     )

2038)     PARAMS_NEEDS_SERVICE = _Commented(

2039)         comments=r"""
2040)         TRANSLATORS: The param is a long-form command-line option name,

2041)         the metavar is Label.VAULT_METAVAR_SERVICE.

2042)         """,

2043)     )(

2044)         context='Error message',

2045)         single='{param!s} requires a {service_metavar!s}.',

2046)         flags='python-brace-format',
2047)     )

2048)     PARAMS_NO_SERVICE = _Commented(

2049)         comments=r"""
2050)         TRANSLATORS: The param is a long-form command-line option name,

2051)         the metavar is Label.VAULT_METAVAR_SERVICE.

2052)         """,

2053)     )(

2054)         context='Error message',

2055)         single='{param!s} does not take a {service_metavar!s} argument.',

2056)         flags='python-brace-format',
2057)     )

2058)     SERVICE_REQUIRED = _Commented(

2059)         comments=r"""

2060)         TRANSLATORS: The metavar is Label.VAULT_METAVAR_SERVICE.

2061)         """,

2062)     )(

2063)         context='Error message',

2064)         single='Deriving a passphrase requires a {service_metavar!s}.',

2065)         flags='python-brace-format',
2066)     )

2067)     SET_AND_UNSET_SAME_SETTING = _Commented(

2068)         comments=r"""
2069)         TRANSLATORS: The rephrasing "Attempted to unset and set the same
2070)         setting (--unset={setting!s} --{setting!s}=...) at the same
2071)         time." may or may not be more suitable as a basis for
2072)         translation instead.
2073)         """,

2074)     )(

2075)         context='Error message',

2076)         single='Attempted to unset and set --{setting!s} at the same time.',

2077)         flags='python-brace-format',

2078)     )

2079)     SSH_KEY_NOT_LOADED = _Commented(

2080)         comments='',

2081)     )(

2082)         context='Error message',

2083)         single='The requested SSH key is not loaded into the agent.',