Spade

Mini Shell

Directory:~$ /lib/python2.7/site-packages/certbot/
Upload File
[Home] [System Details] [Kill Me]
Current File:~$ //lib/python2.7/site-packages/certbot/interfaces.pyo

�
d�_ac@s�dZddlZddlZddlZejej�defd��Y�Zdej	j
fd��YZdej	j
fd��YZd	efd
��YZ
dej	j
fd��YZd
efd��YZdej	j
fd��YZdej	j
fd��YZejej�defd��Y�Zejej�defd��Y�Zejej�defd��Y�ZdS(sCertbot
client
interfaces.i����NtAccountStoragecBsDeZdZejd��Zejd��Zejd��ZRS(sAccounts
storage interface.cCs
t��dS(sXFind all accounts.

        :returns: All found accounts.
        :rtype: list

       
N(tNotImplementedError(tself((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytfind_allscCs
t��dS(s�Load
an account by its id.

        :raises .AccountNotFound: if account could not be found
        :raises .AccountStorageError: if account could not be loaded

        N(R(Rt
account_id((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytloadscCs
t��dS(s\Save
account.

        :raises .AccountStorageError: if account could not be saved

       
N(R(Rtaccounttclient((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytsave"s(t__name__t
__module__t__doc__tabctabstractmethodRRR(((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyR
s

tIPluginFactorycBs2eZdZejjd�Zd�Zd�ZRS(s.IPlugin
factory.

    Objects providing this interface will be called without satisfying
    any entry point "extras" (extra dependencies) you might have
defined
    for your plugin, e.g (excerpt from ``setup.py`` script)::

      setup(
          ...
          entry_points={
              'certbot.plugins': [
                  'name=example_project.plugin[plugin_deps]',
              ],
          },
          extras_require={
              'plugin_deps': ['dep1',
'dep2'],
          }
      )

    Therefore, make sure such objects are importable and usable without
    extras. This is necessary, because CLI does the following operations
    (in order):

      - loads an entry point,
      - calls `inject_parser_options`,
      - requires an entry point,
      - creates plugin instance (`__call__`).

    sShort plugin descriptioncCsdS(s{Create new `IPlugin`.

        :param IConfig config: Configuration.
        :param str name: Unique plugin name.

       
N((tconfigtname((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyt__call__LscCsdS(s�Inject
argument parser options (flags).

        1. Be nice and prepend all options and destinations with
        `~.common.option_namespace` and `~common.dest_namespace`.

        2. Inject options (flags) only. Positional arguments are not
        allowed, as this would break the CLI.

        :param ArgumentParser parser: (Almost) top-level CLI parser.
        :param str name: Unique plugin name.

       
N((tparserR((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytinject_parser_optionsTs(	R	R
Rtzopet	interfacet	AttributetdescriptionRR(((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyR,s	tIPlugincBs
eZdZd�Zd�ZRS(sCertbot plugin.cCsdS(s�Prepare the plugin.

        Finish up any additional initialization.

        :raises .PluginError:
            when full initialization cannot be completed.
        :raises .MisconfigurationError:
            when full initialization cannot be completed. Plugin will
            be displayed on a list of available plugins.
        :raises .NoInstallationError:
            when the necessary programs/files cannot be located. Plugin
            will NOT be displayed on a list of available plugins.
        :raises .NotSupportedError:
            when the installation is recognized, but the version is not
            currently supported.

       
N((((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytpreparefscCsdS(s�Human-readable
string to help the user.

        Should describe the steps taken and any relevant info to help the
user
        decide which plugin to use.

        :rtype str:

       
N((((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyt	more_infoys(R	R
RRR(((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyRcs	tIAuthenticatorcBs)eZdZd�Zd�Zd�ZRS(s�Generic
Certbot Authenticator.

    Class represents all possible tools processes that have the
    ability to perform challenges and attain a certificate.

    cCsdS(s�Return `collections.Iterable` of challenge
preferences.

        :param str domain: Domain for which challenge preferences are
sought.

        :returns: `collections.Iterable` of challenge types (subclasses of
            :class:`acme.challenges.Challenge`) with the most
            preferred challenges first. If a type is not specified, it
means the
            Authenticator cannot perform the challenge.
        :rtype: `collections.Iterable`

       
N((tdomain((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytget_chall_pref�scCsdS(s�Perform
the given challenge.

        :param list achalls: Non-empty (guaranteed) list of
            :class:`~certbot.achallenges.AnnotatedChallenge`
            instances, such that it contains types found within
            :func:`get_chall_pref` only.

        :returns: `collections.Iterable` of ACME
            :class:`~acme.challenges.ChallengeResponse` instances
corresponding to each provided
            :class:`~acme.challenges.Challenge`.
        :rtype: :class:`collections.Iterable` of
            :class:`acme.challenges.ChallengeResponse`,
            where responses are required to be returned in
            the same order as corresponding input challenges

        :raises .PluginError: If some or all challenges cannot be performed

       
N((tachalls((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytperform�scCsdS(s�Revert
changes and shutdown after challenges complete.

        This method should be able to revert all changes made by
        perform, even if perform exited abnormally.

        :param list achalls: Non-empty (guaranteed) list of
            :class:`~certbot.achallenges.AnnotatedChallenge`
            instances, a subset of those previously passed to
:func:`perform`.

        :raises PluginError: if original configuration cannot be restored

       
N((R((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytcleanup�s(R	R
RRRR
(((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyR�s	
	tIConfigcBs�eZdZejjd�Zejjd�Zejjd�Zejjd�Z	ejjd�Z
ejjd�Zejjd�Zejjd�Z
ejjd	�Zejjd
�Zejjd�Zejjd�Zejjd
�Zejjd�Zejjd�Zejjd�Zejjd�Zejjd�Zejjd�Zejjd�Zejjd�Zejjd�Zejjd�ZRS(s�Certbot
user-supplied configuration.

    .. warning:: The values stored in the configuration have not been
        filtered, stripped or sanitized.

    sACME Directory Resource URI.s�Email used for registration and
recovery contact. Use comma to register multiple emails, ex:
u1@example.com,u2@example.com. (default: Ask).sSize of the RSA key.sNThe
SECG elliptic curve name to use. Please see RFC 8446 for supported
values.sUType of generated private key(Only *ONE* per invocation can be
provided at this time)s�Adds the OCSP Must Staple extension to the
certificate. Autoconfigures OCSP Stapling for supported setups (Apache
version >= 2.3.3 ).sConfiguration directory.sWorking
directory.s2Directory where all account information is stored.s
Configuration backups directory.sNDirectory where newly generated
Certificate Signing Requests (CSRs) are saved.s:Directory used before a
permanent checkpoint is finalized.s
Keys storage.sTemporary checkpoint
directory.s6Disable verification of the ACME server's
certificate.s�Port used in the http-01 challenge. This only affects the
port Certbot listens on. A conforming ACME server will still attempt to
connect on port 80.s;The address the server listens to during http-01
challenge.skPort used to serve HTTPS. This affects which port Nginx will
listen on after a LE certificate is installed.seSorted user specified
preferred challengestype strings with the most preferred challenge listed
firsts#When performing domain validation, do not consider it a failure if
authorizations can not be obtained for a strict subset of the requested
domains. This may be useful for allowing renewals for multiple domains to
succeed even if some domains no longer point at this system. This is a
booleans�Require that all configuration files are owned by the current
user; only needed if your config is somewhere unsafe like /tmp/.This is a
booleansmIf updates provided by installer enhancements when Certbot is
being run with "renew" verb should be disabled.s�If the CA
offers multiple certificate chains, prefer the chain whose topmost
certificate was issued from this Subject Common Name. If no match, the
default offered chain will be used.(R	R
RRRRtservertemailtrsa_key_sizetelliptic_curvetkey_typetmust_staplet
config_dirtwork_dirtaccounts_dirt
backup_dirtcsr_dirtin_progress_dirtkey_dirttemp_checkpoint_dirt
no_verify_sslthttp01_portthttp01_addresst
https_porttpref_challstallow_subset_of_nameststrict_permissionstdisable_renew_updatestpreferred_chain(((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyR!�sR																																	t
IInstallercBskeZdZd�Zd�Zdd�Zd�Zded�Z	dd�Z
d�Zd	�Zd
�Z
RS(s�Generic Certbot Installer Interface.

    Represents any server that an X509 certificate can be placed.

    It is assumed that :func:`save` is the only method that finalizes a
    checkpoint. This is important to ensure that checkpoints are
    restored in a consistent manner if requested by the user or in case
    of an error.

    Using :class:`certbot.reverter.Reverter` to implement checkpoints,
    rollback, and recovery can dramatically simplify plugin development.

    cCsdS(sgReturns all names that may be authenticated.

        :rtype: `collections.Iterable` of `str`

       
N((((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyt
get_all_namesscCsdS(s�Deploy
certificate.

        :param str domain: domain to deploy certificate file
        :param str cert_path: absolute path to the certificate file
        :param str key_path: absolute path to the private key file
        :param str chain_path: absolute path to the certificate chain file
        :param str fullchain_path: absolute path to the certificate
fullchain
            file (cert plus chain)

        :raises .PluginError: when cert cannot be deployed

        N((Rt	cert_pathtkey_patht
chain_pathtfullchain_path((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytdeploy_cert%scCsdS(sGPerform
a configuration enhancement.

        :param str domain: domain for which to provide enhancement
        :param str enhancement: An enhancement as defined in
            :const:`~certbot.plugins.enhancements.ENHANCEMENTS`
        :param options: Flexible options parameter for enhancement.
            Check documentation of
            :const:`~certbot.plugins.enhancements.ENHANCEMENTS`
            for expected options for each enhancement.

        :raises .PluginError: If Enhancement is not supported, or if
            an error occurs during the enhancement.

       
N((Rtenhancementtoptions((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytenhance3scCsdS(s	Returns
a `collections.Iterable` of supported enhancements.

        :returns: supported enhancements which should be a subset of
            :const:`~certbot.plugins.enhancements.ENHANCEMENTS`
        :rtype: :class:`collections.Iterable` of :class:`str`

       
N((((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytsupported_enhancementsCscCsdS(s1Saves
all changes to the configuration files.

        Both title and temporary are needed because a save may be
        intended to be permanent, but the save is not ready to be a full
        checkpoint.

        It is assumed that at most one checkpoint is finalized by this
        method. Additionally, if an exception is raised, it is assumed a
        new checkpoint was not finalized.

        :param str title: The title of the save. If a title is given, the
            configuration will be saved as a new checkpoint and put in a
            timestamped directory. `title` has no effect if temporary is
true.

        :param bool temporary: Indicates whether the changes made will
            be quickly reversed in the future (challenges)

        :raises .PluginError: when save is unsuccessful

       
N((ttitlet	temporary((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyRLsicCsdS(s�Revert
`rollback` number of configuration checkpoints.

        :raises .PluginError: when configuration cannot be fully reverted

       
N((trollback((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytrollback_checkpointsbscCsdS(sARevert
configuration to most recent finalized checkpoint.

        Remove all changes (temporary and permanent) that have not been
        finalized. This is useful to protect against crashes and other
        execution interruptions.

        :raises .errors.PluginError: If unable to recover the configuration

       
N((((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytrecovery_routineiscCsdS(s�Make
sure the configuration is valid.

        :raises .MisconfigurationError: when the config is not in a usable
state

       
N((((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytconfig_testtscCsdS(soRestart
or refresh the server content.

        :raises .PluginError: when server cannot be restarted

       
N((((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytrestart{sN(R	R
RR:R?tNoneRBRCtFalseRRGRHRIRJ(((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyR9s
						tIDisplaycBs�eZdZeed�Zd	d	d	d	d	ed�Zd	d	ed�Zddd	d	ed�Z	d	d	ed�Z
d	d	ed�ZRS(
sGeneric display.cCsdS(s�Displays a string message

        :param str message: Message to display
        :param bool pause: Whether or not the application should pause for
            confirmation (if available)
        :param bool wrap: Whether or not the application should wrap text
        :param bool force_interactive: True if it's safe to prompt the
user
            because it won't cause any workflow regressions

       
N((tmessagetpausetwraptforce_interactive((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytnotification�scCsdS(s�Displays
a generic menu.

        When not setting force_interactive=True, you must provide a
        default value.

        :param str message: message to display

        :param choices: choices
        :type choices: :class:`list` of :func:`tuple` or :class:`str`

        :param str ok_label: label for OK button (UNUSED)
        :param str cancel_label: label for Cancel button (UNUSED)
        :param str help_label: label for Help button (UNUSED)
        :param int default: default (non-interactive) choice from the menu
        :param str cli_flag: to automate choice from the menu, eg
"--keep"
        :param bool force_interactive: True if it's safe to prompt the
user
            because it won't cause any workflow regressions

        :returns: tuple of (`code`, `index`) where
            `code` - str display exit code
            `index` - int index of the user's selection

        :raises errors.MissingCommandlineFlag: if called in non-interactive
            mode without a default set

        N((RNtchoicestok_labeltcancel_labelt
help_labeltdefaulttcli_flagRQ((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytmenu�scCsdS(s�Accept
input from the user.

        When not setting force_interactive=True, you must provide a
        default value.

        :param str message: message to display to the user
        :param str default: default (non-interactive) response to prompt
        :param bool force_interactive: True if it's safe to prompt the
user
            because it won't cause any workflow regressions

        :returns: tuple of (`code`, `input`) where
            `code` - str display exit code
            `input` - str of the user's input
        :rtype: tuple

        :raises errors.MissingCommandlineFlag: if called in non-interactive
            mode without a default set

       
N((RNRWtcli_argsRQ((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytinput�stYestNocCsdS(s�Query
the user with a yes/no question.

        Yes and No label must begin with different letters.

        When not setting force_interactive=True, you must provide a
        default value.

        :param str message: question for the user
        :param str default: default (non-interactive) choice from the menu
        :param str cli_flag: to automate choice from the menu, eg
"--redirect / --no-redirect"
        :param bool force_interactive: True if it's safe to prompt the
user
            because it won't cause any workflow regressions

        :returns: True for "Yes", False for "No"
        :rtype: bool

        :raises errors.MissingCommandlineFlag: if called in non-interactive
            mode without a default set

       
N((RNt	yes_labeltno_labelRWRZRQ((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytyesno�scCsdS(slAllow
for multiple selections from a menu.

        When not setting force_interactive=True, you must provide a
        default value.

        :param str message: message to display to the user
        :param list tags: where each is of type :class:`str` len(tags) >
0
        :param str default: default (non-interactive) state of the
checklist
        :param str cli_flag: to automate choice from the menu, eg
"--domains"
        :param bool force_interactive: True if it's safe to prompt the
user
            because it won't cause any workflow regressions

        :returns: tuple of the form (code, list_tags) where
            `code` - int display exit code
            `list_tags` - list of str tags selected by the user
        :rtype: tuple

        :raises errors.MissingCommandlineFlag: if called in non-interactive
            mode without a default set

       
N((RNttagsRWRZRQ((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyt	checklist�scCsdS(sDisplay
a directory selection screen.

        When not setting force_interactive=True, you must provide a
        default value.

        :param str message: prompt to give the user
        :param default: the default value to return, if one exists, when
            using the NoninteractiveDisplay
        :param str cli_flag: option used to set this value with the CLI,
            if one exists, to be included in error messages given by
            NoninteractiveDisplay
        :param bool force_interactive: True if it's safe to prompt the
user
            because it won't cause any workflow regressions

        :returns: tuple of the form (`code`, `string`) where
            `code` - int display exit code
            `string` - input entered by the user

       
N((RRNRWRXRQ((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytdirectory_select�sN(R	R
RtTrueRLRRRKRYR[R`RbRc(((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyRM�s	t	IReportercBsYeZdZejjd�Zejjd�Zejjd�Ze	d�Z
d�ZRS(s9Interface to collect and display information to the
user.s%Used to denote high priority messagess'Used to denote medium
priority messagess$Used to denote low priority messagescCsdS(sRAdds
msg to the list of messages to be printed.

        :param str msg: Message to be displayed to the user.

        :param int priority: One of HIGH_PRIORITY, MEDIUM_PRIORITY, or
            LOW_PRIORITY.

        :param bool on_crash: Whether or not the message should be printed
if
            the program exits abnormally.

       
N((Rtmsgtpriorityton_crash((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytadd_messagescCsdS(s9Prints
messages to the user and clears the message
queue.N((R((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytprint_messages"s(R	R
RRRRt
HIGH_PRIORITYtMEDIUM_PRIORITYtLOW_PRIORITYRdRiRj(((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyRes						
t
RenewableCertcBszeZdZejd��Zejd��Zejd��Zejd��Zejd��Z	ej
d��ZRS(s#Interface to a certificate lineage.cCsdS(s<Path
to the certificate file.

        :rtype: str

       
N((R((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyR;*scCsdS(s<Path
to the private key file.

        :rtype: str

       
N((R((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyR<2scCsdS(sBPath
to the certificate chain file.

        :rtype: str

       
N((R((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyR=:scCsdS(s�Path
to the full chain file.

        The full chain is the certificate file plus the chain file.

        :rtype: str

       
N((R((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyR>BscCsdS(sEName
given to the certificate lineage.

        :rtype: str

       
N((R((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytlineagenameLscCsdS(s�What
are the subject names of this certificate?

        :returns: the subject names
        :rtype: `list` of `str`
        :raises .CertStorageError: if could not find cert file.

       
N((R((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytnamesTs(R	R
RRtabstractpropertyR;R<R=R>RoR
Rp(((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyRn&s
tGenericUpdatercBs eZdZejd��ZRS(sJInterface for update
types not currently specified by Certbot.

    This class allows plugins to perform types of updates that Certbot
hasn't
    defined (yet).

    To make use of this interface, the installer should implement the
interface
    methods, and interfaces.GenericUpdater.register(InstallerClass) should
    be called from the installer code.

    The plugins implementing this enhancement are responsible of handling
    the saving of configuration checkpoints as well as other calls to
    interface methods of `interfaces.IInstaller` such as prepare() and
restart()
    cOsdS(s�Perform any update types defined by the installer.

        If an installer is a subclass of the class containing this method,
this
        function will always be called when "certbot renew" is
run. If the
        update defined by the installer should be run conditionally, the
        installer needs to handle checking the conditions itself.

        This method is called once for each lineage.

        :param lineage: Certificate lineage object
        :type lineage: RenewableCert

       
N((Rtlineagetargstkwargs((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytgeneric_updatesxs(R	R
RRR
Rv(((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyRrhst
RenewDeployercBs
eZdZejd��ZRS(s�Interface for update types run when a lineage
is renewed

    This class allows plugins to perform types of updates that need to run
at
    lineage renewal that Certbot hasn't defined (yet).

    To make use of this interface, the installer should implement the
interface
    methods, and interfaces.RenewDeployer.register(InstallerClass) should
    be called from the installer code.
    cOsdS(sPerform updates defined by installer when a certificate
has been renewed

        If an installer is a subclass of the class containing this method,
this
        function will always be called when a certficate has been renewed
by
        running "certbot renew". For example if a plugin needs to
copy a
        certificate over, or change configuration based on the new
certificate.

        This method is called once for each lineage renewed

        :param lineage: Certificate lineage object
        :type lineage: RenewableCert

       
N((RRsRtRu((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pytrenew_deploy�s(R	R
RRR
Rx(((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyRw�s
(RRtsixtzope.interfaceRt
add_metaclasstABCMetatobjectRRt	InterfaceRRRR!R9RMReRnRrRw(((s6/usr/lib/python2.7/site-packages/certbot/interfaces.pyt<module>s$!7!8St�A