Google
Edit File: totp.cpython-39.pyc
a f�WcI � @ s� d Z ddlmZmZmZ ddlmZ ddlZddlZddl Z ddl Z e � e �Z ddlZddlZddlZddlZddlZer�ddlmZmZmZmZ n ddlmZmZ ddlmZmZ ddlmZ z.dd l m Z ddl Z ddl!Z dd l"m#Z$ [ W n& e%�y e �&d � d Z$Z Y n0 dd l'm(Z( dd l)m*Z*m+Z+m,Z,m-Z- ddl.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6 ddl7m8Z8m9Z9m:Z: ddlm;Z;m<Z<m=Z=m>Z>m?Z?m@Z@mAZAmBZBmCZCmDZD ddlEmFZFmGZG ddlHmIZImJZJmKZK ddlLmMZM g d�ZNejOdk �rddlmPZP dePv�reP�Qd� e �&d� [Pe�Re;d�ejS�ZTg d�ZUdd � ZVd2d d �ZWd d!� ZXeYe$�ZZe�Rd"�Z[G d#d$� d$e\�Z]e�^d%�j_Z`e�^d&�jaZbd'ZcG d(d)� d)e\�ZdG d*d+� d+e4�ZeG d,d-� d-e4�Zfd.e8dd/� fd0d1�ZgdS )3z@passlib.totp -- TOTP / RFC6238 / Google Authenticator utilities.� )�absolute_import�division�print_function)�PY3N)�urlparse� parse_qsl�quote�unquote)r r )r r )�warn)�default_backend)�ciphersz=can't import 'cryptography' package, totp encryption disabled)�exc)� TokenError�MalformedTokenError�InvalidTokenError�UsedTokenError)� to_unicode�to_bytes�consteq� getrandbytes�rng� SequenceMixin� xor_bytes� getrandstr)� BASE64_CHARS� b32encode� b32decode) �u�unicode�native_string_types� bascii_to_str� int_types� num_types�irange�byte_elem_value� UnicodeIO�suppress_cause)� hybrid_method�memoized_property)� lookup_hash� compile_hmac� pbkdf2_hmac)� pbkdf2_sha256)� AppWallet�TOTPr r r r � TotpToken� TotpMatch)� � � )� uses_query�otpauthz4registered 'otpauth' scheme with urlparse.uses_queryz\s|[-=])r3 � � c C sL t D ]}| | s| S qt d }d}t D ] }| | |kr*|}| | }q*|S )zb helper for group_string() -- calculates optimal size of group for given string size. r )� _chunk_sizes)�klen�sizeZbestZrem� r; �0/usr/lib/python3.9/site-packages/passlib/totp.py�_get_group_sizeY s r= �-c s2 t ��}t|�� |�� �fdd�td|� �D ��S )z� reformat string into (roughly) evenly-sized groups, separated by **sep**. useful for making tokens & keys easier to read by humans. c 3 s | ]}�||� � V qd S �Nr; )�.0�o�r: �valuer; r< � <genexpr>s � z group_string.<locals>.<genexpr>r )�lenr= �joinr# )rC �sepr9 r; rB r< � group_stringl s rI c C s� |dkr$t | t�s t�| dd��| S t| dd�} t�d| ��d�} |dksR|dkr`t� | � � �S |d krpt | �S t d |f ��d S ) zR internal TOTP() helper -- decodes key according to specified format. �raw�bytes�key��param� zutf-8�hex�base16�base32� unknown byte-encoding format: %rN) � isinstancerK r �ExpectedTypeErrorr � _clean_re�sub�encode�base64Z b16decode�upperr � ValueError�rL �formatr; r; r< � _decode_bytesy s r^ z(?i)^[a-z0-9][a-z0-9_.-]*$c @ sl e Zd ZdZdZdZdZdZddd�Zdd� Z d d � Z e d d � �Z d d� Z eddd��Zdd� Zdd� ZdS )r- a� This class stores application-wide secrets that can be used to encrypt & decrypt TOTP keys for storage. It's mostly an internal detail, applications usually just need to pass ``secrets`` or ``secrets_path`` to :meth:`TOTP.using`. .. seealso:: :ref:`totp-storing-instances` for more details on this workflow. Arguments ========= :param secrets: Dict of application secrets to use when encrypting/decrypting stored TOTP keys. This should include a secret to use when encrypting new keys, but may contain additional older secrets to decrypt existing stored keys. The dict should map tags -> secrets, so that each secret is identified by a unique tag. This tag will be stored along with the encrypted key in order to determine which secret should be used for decryption. Tag should be string that starts with regex range ``[a-z0-9]``, and the remaining characters must be in ``[a-z0-9_.-]``. It is recommended to use something like a incremental counter ("1", "2", ...), an ISO date ("2016-01-01", "2016-05-16", ...), or a timestamp ("19803495", "19813495", ...) when assigning tags. This mapping be provided in three formats: * A python dict mapping tag -> secret * A JSON-formatted string containing the dict * A multiline string with the format ``"tag: value\ntag: value\n..."`` (This last format is mainly useful when loading from a text file via **secrets_path**) .. seealso:: :func:`generate_secret` to create a secret with sufficient entropy :param secrets_path: Alternately, callers can specify a separate file where the application-wide secrets are stored, using either of the string formats described in **secrets**. :param default_tag: Specifies which tag in **secrets** should be used as the default for encrypting new keys. If omitted, the tags will be sorted, and the largest tag used as the default. if all tags are numeric, they will be sorted numerically; otherwise they will be sorted alphabetically. this permits tags to be assigned numerically, or e.g. using ``YYYY-MM-DD`` dates. :param encrypt_cost: Optional time-cost factor for key encryption. This value corresponds to log2() of the number of PBKDF2 rounds used. .. warning:: The application secret(s) should be stored in a secure location by your application, and each secret should contain a large amount of entropy (to prevent brute-force attacks if the encrypted keys are leaked). :func:`generate_secret` is provided as a convenience helper to generate a new application secret of suitable size. Best practice is to load these values from a file via **secrets_path**, and then have your application give up permission to read this file once it's running. Public Methods ============== .. autoattribute:: has_secrets .. autoattribute:: default_tag Semi-Private Methods ==================== The following methods are used internally by the :class:`TOTP` class in order to encrypt & decrypt keys using the provided application secrets. They will generally not be publically useful, and may have their API changed periodically. .. automethod:: get_secret .. automethod:: encrypt_key .. automethod:: decrypt_key � � Nc C s� |d ur,t |t�rt|�}|dks&J �|| _|d urR|d urDtd��t|d��� }| �|� }| _|r�|d urz| � |� n(t dd� |D ��r�t |td�}nt |�}|| _ d S )Nr z3'secrets' and 'secrets_path' are mutually exclusiveZrtc s s | ]}|� � V qd S r? )�isdigit)r@ �tagr; r; r< rD ) rE z%AppWallet.__init__.<locals>.<genexpr>)rL ) rT r �int� encrypt_cost� TypeError�open�read�_parse_secrets�_secrets� get_secret�all�max� default_tag)�self�secretsrm rd Z secrets_pathr; r; r< �__init__ s" zAppWallet.__init__c s� d}t |t�rV|�� �d�r(t�|�}n.d|v rNd|v rNdd� }||�}d}ntd��|d u rbi S t |t�rv|�� }n |r�t d ��t� fd d �|D ��S ) zf parse 'secrets' parameter :returns: Dict[tag:str, secret:bytes] T)�[�{� �:c s sJ | � � D ]<}|�� }|r|�d�s|�dd�\}}|�� |�� fV qd S )N�#rt � )� splitlines�strip� startswith�split)�source�linerb �secretr; r; r< � iter_pairsA s z,AppWallet._parse_secrets.<locals>.iter_pairsFz"unrecognized secrets string formatNz+'secrets' must be mapping, or list of itemsc 3 s | ]\}}� � ||�V qd S r? )�_parse_secret_pair)r@ rb rC �rn r; r< rD W s �z+AppWallet._parse_secrets.<locals>.<genexpr>) rT r �lstripry �json�loadsr[ �dict�itemsre )rn r{ Z check_typer~ r; r� r< rh / s$ �zAppWallet._parse_secretsc C s| t |t�r n"t |t�r t|�}ntd|f ��t�|�sFtd|f ��t |t�sbt |d|f d�}|sttd|f ��||fS )Nz tag must be unicode/string: %rz#tag contains invalid characters: %rz secret %rrM z tag contains empty secret: %r) rT r rc �strre �_tag_re�matchr[ rK r )rn rb rC r; r; r< r Z s z AppWallet._parse_secret_pairc C s | j duS )z2whether at least one application secret is presentN)rm r� r; r; r< � has_secretsm s zAppWallet.has_secretsc C sF | j }|std��z || W S ty@ ttd|f ���Y n0 dS )zh resolve a secret tag to the secret (as bytes). throws a KeyError if not found. z!no application secrets configuredzunknown secret tag: %rN)ri �KeyErrorr& )rn rb ro r; r; r< rj r s zAppWallet.get_secretFc C s| t du rtd��td||d|> dd�}t �t j�|dd� �t j�|dd� �t� �}|rb|� � n|� � }|� | �|� � S )a& Internal helper for :meth:`encrypt_key` -- handles lowlevel encryption/decryption. Algorithm details: This function uses PBKDF2-HMAC-SHA256 to generate a 32-byte AES key and a 16-byte IV from the application secret & random salt. It then uses AES-256-CTR to encrypt/decrypt the TOTP key. CTR mode was chosen over CBC because the main attack scenario here is that the attacker has stolen the database, and is trying to decrypt a TOTP key (the plaintext value here). To make it hard for them, we want every password to decrypt to a potentially valid key -- thus need to avoid any authentication or padding oracle attacks. While some random padding construction could be devised to make this work for CBC mode, a stream cipher mode is just plain simpler. OFB/CFB modes would also work here, but seeing as they have malleability and cyclic issues (though remote and barely relevant here), CTR was picked as the best overall choice. NzITOTP encryption requires 'cryptography' package (https://cryptography.io)Zsha256rv �0 )�salt�roundsZkeylen� ) � _cg_ciphers� RuntimeErrorr+ ZCipherZ algorithmsZAESZmodesZCTR�_cg_default_backendZ decryptorZ encryptor�update�finalize)rC r} r� �costZdecryptZkeyivZcipher�ctxr; r; r< �_cipher_aes_key� s �zAppWallet._cipher_aes_keyc C s` |s t d��tt| j�}| j}| j}|s0td��| �|| �|�||�}t d||t |�t |�d�S )a0 Helper used to encrypt TOTP keys for storage. :param key: TOTP key to encrypt, as raw bytes. :returns: dict containing encrypted TOTP key & configuration parameters. this format should be treated as opaque, and potentially subject to change, though it is designed to be easily serialized/deserialized (e.g. via JSON). .. note:: This function requires installation of the external `cryptography <https://cryptography.io>`_ package. To give some algorithm details: This function uses AES-256-CTR to encrypt the provided data. It takes the application secret and randomly generated salt, and uses PBKDF2-HMAC-SHA256 to combine them and generate the AES key & IV. zno key providedz8no application secrets configured, can't encrypt OTP keyrv )�v�c�t�s�k) r[ r r � salt_sizerd rm re r� rj r� r )rn rL r� r� rb Zckeyr; r; r< � encrypt_key� s zAppWallet.encrypt_keyc C s� t |t�std��|�dd�}d}|dkr2| j}ntd|f ��|d }|d }|t|d �| �|�t|d �|d �}|| jks�|| j kr�d }||fS ) a� Helper used to decrypt TOTP keys from storage format. Consults configured secrets to decrypt key. :param source: source object, as returned by :meth:`encrypt_key`. :returns: ``(key, needs_recrypt)`` -- **key** will be the decrypted key, as bytes. **needs_recrypt** will be a boolean flag indicating whether encryption cost or default tag is too old, and henace that key needs re-encrypting before storing. .. note:: This function requires installation of the external `cryptography <https://cryptography.io>`_ package. z'enckey' must be dictionaryr� NFrv z+missing / unrecognized 'enckey' version: %rr� r� r� r� )rC r} r� r� T) rT r� re �getr� r[ r rj rd rm )rn �enckey�version� needs_recryptZ _cipher_keyrb r� rL r; r; r< � decrypt_key� s$ �zAppWallet.decrypt_key)NNNN)F)�__name__� __module__� __qualname__�__doc__r� rd ri rm rp rh r �propertyr� rj � staticmethodr� r� r� r; r; r; r< r- � s" ] � )+ %!r- z>Qz>Is c s� e Zd ZdZdZd ZZdZej Z dZ dZ dZ dZdZdZdZdZdZedTd d ��Zed d � �ZdU� fdd� ZedVdd��Zedd� �Zedd� �Ze dd� �Z e j dd� �Z e dd� �Z e j d d� �Z e d d � �Z e d d � �Z!dWd"d#�Z"ed$d%� �Z#d&d'� Z$d(d)� Z%e&d*d+� �Z'dXd,d-�Z(d.d/� Z)ed0d1� �Z*dYd2d3�Z+dZd4d5�Z,ed6d7� �Z-ed8d9� �Z.ed:d;� �Z/ed<d=� �Z0ed[d>d?��Z1ed@dA� �Z2edBdC� �Z3d\dDdE�Z4dFdG� Z5edHdI� �Z6d]dJdK�Z7edLdM� �Z8edNdO� �Z9edPdQ� �Z:d^dRdS�Z;� Z<S )_r. a9 Helper for generating and verifying TOTP codes. Given a secret key and set of configuration options, this object offers methods for token generation, token validation, and serialization. It can also be used to track important persistent TOTP state, such as the last counter used. This class accepts the following options (only **key** and **format** may be specified as positional arguments). :arg str key: The secret key to use. By default, should be encoded as a base32 string (see **format** for other encodings). Exactly one of **key** or ``new=True`` must be specified. :arg str format: The encoding used by the **key** parameter. May be one of: ``"base32"`` (base32-encoded string), ``"hex"`` (hexadecimal string), or ``"raw"`` (raw bytes). Defaults to ``"base32"``. :param bool new: If ``True``, a new key will be generated using :class:`random.SystemRandom`. Exactly one ``new=True`` or **key** must be specified. :param str label: Label to associate with this token when generating a URI. Displayed to user by most OTP client applications (e.g. Google Authenticator), and typically has format such as ``"John Smith"`` or ``"jsmith@webservice.example.org"``. Defaults to ``None``. See :meth:`to_uri` for details. :param str issuer: String identifying the token issuer (e.g. the domain name of your service). Used internally by some OTP client applications (e.g. Google Authenticator) to distinguish entries which otherwise have the same label. Optional but strongly recommended if you're rendering to a URI. Defaults to ``None``. See :meth:`to_uri` for details. :param int size: Number of bytes when generating new keys. Defaults to size of hash algorithm (e.g. 20 for SHA1). .. warning:: Overriding the default values for ``digits``, ``period``, or ``alg`` may cause problems with some OTP client programs (such as Google Authenticator), which may have these defaults hardcoded. :param int digits: The number of digits in the generated / accepted tokens. Defaults to ``6``. Must be in range [6 .. 10]. .. rst-class:: inline-title .. caution:: Due to a limitation of the HOTP algorithm, the 10th digit can only take on values 0 .. 2, and thus offers very little extra security. :param str alg: Name of hash algorithm to use. Defaults to ``"sha1"``. ``"sha256"`` and ``"sha512"`` are also accepted, per :rfc:`6238`. :param int period: The time-step period to use, in integer seconds. Defaults to ``30``. .. See the passlib documentation for a full list of attributes & methods. � rv Nr6 �sha1� Fc s� t d| fi �� � fdd�}|dur.|d|�� _|durB|d|�� _|durV|d|�� _|durj|d|�� _|r�tf i |��� _|r�td ��n&|dur�t|t�s�t � |td ��|� _|dur�t|� t �r�|� d ks�J d ��t |�� _ � S ) a: Dynamically create subtype of :class:`!TOTP` class which has the specified defaults set. :parameters: **digits, alg, period, issuer**: All these options are the same as in the :class:`TOTP` constructor, and the resulting class will use any values you specify here as the default for all TOTP instances it creates. :param wallet: Optional :class:`AppWallet` that will be used for encrypting/decrypting keys. :param secrets, secrets_path, encrypt_cost: If specified, these options will be passed to the :class:`AppWallet` constructor, allowing you to directly specify the secret keys that should be used to encrypt & decrypt stored keys. :returns: subclass of :class:`!TOTP`. This method is useful for creating a TOTP class configured to use your application's secrets for encrypting & decrypting keys, as well as create new keys using it's desired configuration defaults. As an example:: >>> # your application can create a custom class when it initializes >>> from passlib.totp import TOTP, generate_secret >>> TotpFactory = TOTP.using(secrets={"1": generate_secret()}) >>> # subsequent TOTP objects created from this factory >>> # will use the specified secrets to encrypt their keys... >>> totp = TotpFactory.new() >>> totp.to_dict() {'enckey': {'c': 14, 'k': 'H77SYXWORDPGVOQTFRR2HFUB3C45XXI7', 's': 'G5DOQPIHIBUM2OOHHADQ', 't': '1', 'v': 1}, 'type': 'totp', 'v': 1} .. seealso:: :ref:`totp-creation` and :ref:`totp-storing-instances` tutorials for a usage example r. c s, t tdd�}||| < � f i |��}t|| �S )z� helper which uses constructor to validate parameter value. it returns corresponding attribute, so we use normalized value. rJ r\ )r� � _DUMMY_KEY�getattr)�attrrC �kwds�obj��subclsr; r< � norm_param� s z TOTP.using.<locals>.norm_paramN�digits�alg�period�issuerz6'wallet' and 'secrets' keywords are mutually exclusive�walletr z1now() function must return non-negative int/float)�typer� r� r� r� r- r� re rT r rU r" r� �now) �clsr� r� r� r� r� r� r� r� r; r� r< �using� s0 8 � z TOTP.usingc K s | f ddi|��S )zY convenience alias for creating new TOTP key, same as ``TOTP(new=True)`` �newTr; )r� r� r; r; r< r� � s zTOTP.newrR c s� t t| �jf i | �� | r | | _t|p*| j�} | j| _| j} | dk rPtd| ��|r�|r`t d��|d u rn| }n|| kr�t d| ��t t |�| _ n.|s�t d��n |dkr�|| _n|r�t||�| _ t| j �| jk r�d| j }|r�t |��nt|tjdd � |d u �r| j}t|t��s"t d t|� ��|d k �s6|d k�r>t d ��|| _|�rZ| �|� || _| �rp| �| � | | _ |d u�r�| j |ddd� || _ d S )Nr3 z%r hash digest too smallz+'key' and 'new=True' are mutually exclusivez+'size' should be less than digest size (%d)z4must specify either an existing 'key', or 'new=True'� encryptedz5for security purposes, secret key must be >= %d bytesrv )� stacklevelz#digits must be an integer, not a %rr6 r� zdigits must in range(6,11)r� )�minval) �superr. rp �changedr) r� �name� digest_sizer� re r[ r r rL � encrypted_keyr^ rF � _min_key_sizer r ZPasslibSecurityWarningr� rT r! r� � _check_label�label� _check_issuerr� � _check_serialr� )rn rL r] r� r� r� r: r� r� r� r� r� �infor� �msg�� __class__r; r< rp sZ � z TOTP.__init__r c C s4 t | t�st�| d|��| |k r0td||f ��dS )zR check that serial value (e.g. 'counter') is non-negative integer rc z%s must be >= %dN)rT r! r rU r[ )rC rN r� r; r; r< r� O s zTOTP._check_serialc C s | rd| v rt d��dS )zQ check that label doesn't contain chars forbidden by KeyURI spec rt zlabel may not contain ':'N�r[ �r� r; r; r< r� Y s zTOTP._check_labelc C s | rd| v rt d��dS )zR check that issuer doesn't contain chars forbidden by KeyURI spec rt zissuer may not contain ':'Nr� )r� r; r; r< r� a s zTOTP._check_issuerc C s | j S )z) secret key as raw bytes )�_keyr� r; r; r< rL p s zTOTP.keyc C s. t |t�st�|td��|| _d | _| _d S )NrL )rT rK r rU r� �_encrypted_key� _keyed_hmac)rn rC r; r; r< rL w s c C s6 | j }|du r2| j}|s td��|�| j� }| _ |S )z� secret key, encrypted using application secret. this match the output of :meth:`AppWallet.encrypt_key`, and should be treated as an opaque json serializable object. Nz6no application secrets present, can't encrypt TOTP key)r� r� re r� rL )rn r� r� r; r; r< r� � s zTOTP.encrypted_keyc C s8 | j }|std��|�|�\| _}|r.d| _n|| _d S )Nz6no application secrets present, can't decrypt TOTP keyT)r� re r� rL r� r� )rn rC r� r� r; r; r< r� � s c C s t t�| j���� S )z: secret key encoded as hexadecimal string )r rY Z b16encoderL �lowerr� r; r; r< �hex_key� s z TOTP.hex_keyc C s t | j�S )z5 secret key encoded as base32 string )r rL r� r; r; r< � base32_key� s zTOTP.base32_keyr> c C sH |dks|dkr| j }n |dkr(| j}ntd|f ��|rDt||�}|S )a� pretty-print the secret key. This is mainly useful for situations where the user cannot get the qrcode to work, and must enter the key manually into their TOTP client. It tries to format the key in a manner that is easier for humans to read. :param format: format to output secret key. ``"hex"`` and ``"base32"`` are both accepted. :param sep: separator to insert to break up key visually. can be any of ``"-"`` (the default), ``" "``, or ``False`` (no separator). :return: key as native string. Usage example:: >>> t = TOTP('s3jdvb7qd2r7jpxx') >>> t.pretty_key() 'S3JD-VB7Q-D2R7-JPXX' rP rQ rR rS )r� r� r[ rI )rn r] rH rL r; r; r< � pretty_key� s zTOTP.pretty_keyc C s^ t |t�r|S t |t�r t|�S |du r4t| �� �S t|d�rLt�|�� �S t � |dd��dS )as Normalize time value to unix epoch seconds. :arg time: Can be ``None``, :class:`!datetime`, or unix epoch timestamp as :class:`!float` or :class:`!int`. If ``None``, uses current system time. Naive datetimes are treated as UTC. :returns: unix epoch timestamp as :class:`int`. N� utctimetuplezint, float, or datetime�time) rT r! �floatrc r� �hasattr�calendarZtimegmr� r rU )r� r� r; r; r< �normalize_time� s zTOTP.normalize_timec C s || j S )zI convert timestamp to HOTP counter using :attr:`period`. �r� )rn r� r; r; r< �_time_to_counter� s zTOTP._time_to_counterc C s || j S )zI convert HOTP counter to timestamp using :attr:`period`. r� )rn �counterr; r; r< �_counter_to_time� s zTOTP._counter_to_timec C sj | j }t|t�r"td�||f }n,t|dd�}t�td�|�}|�� sNtd��t |�|krftd| ��|S )a� Normalize OTP token representation: strips whitespace, converts integers to a zero-padded string, validates token content & number of digits. This is a hybrid method -- it can be called at the class level, as ``TOTP.normalize_token()``, or the instance level as ``TOTP().normalize_token()``. It will normalize to the instance-specific number of :attr:`~TOTP.digits`, or use the class default. :arg token: token as ascii bytes, unicode, or an integer. :raises ValueError: if token has wrong number of digits, or contains non-numeric characters. :returns: token as :class:`!unicode` string, containing only digits 0-9. �%0*d�tokenrM rO z&Token must contain only the digits 0-9z!Token must have exactly %d digits) r� rT r! r r rV rW ra r rF )Z self_or_clsr� r� r; r; r< �normalize_token s zTOTP.normalize_tokenc C s: | � |�}| �|�}|dk r$td��| �|�}t| ||�S )a� Generate token for specified time (uses current time if none specified). :arg time: Can be ``None``, a :class:`!datetime`, or class:`!float` / :class:`!int` unix epoch timestamp. If ``None`` (the default), uses current system time. Naive datetimes are treated as UTC. :returns: A :class:`TotpToken` instance, which can be treated as a sequence of ``(token, expire_time)`` -- see that class for more details. Usage example:: >>> # generate a new token, wrapped in a TotpToken instance... >>> otp = TOTP('s3jdvb7qd2r7jpxx') >>> otp.generate(1419622739) <TotpToken token='897212' expire_time=1419622740> >>> # when you just need the token... >>> otp.generate(1419622739).token '897212' r ztimestamp must be >= 0)r� r� r[ � _generater/ )rn r� r� r� r; r; r< �generate. s z TOTP.generatec C s� t |t�sJ d��|dks"J d��| j}|du rDt| j| j� }| _|t|��}|jj}t |�|kslJ d��|dks|J d��t |d �d @ }t |||d � �d d @ }| j }d| k r�d k s�n J d ��t d�||f | d� S )z� base implementation of HOTP token generation algorithm. :arg counter: HOTP counter, as non-negative integer :returns: token as unicode string zcounter must be integerr z counter must be non-negativeNz digest_size: sanity check failed� z"digest_size: sanity check 2 failed���� r3 i���� zdigits: sanity check failedr� )rT r! r� r* r� rL � _pack_uint64Z digest_infor� rF r$ �_unpack_uint32r� r )rn r� Z keyed_hmac�digestr� �offsetrC r� r; r; r< r� Q s zTOTP._generatec K s | � |�j|fi |��S )a� Convenience wrapper around :meth:`TOTP.from_source` and :meth:`TOTP.match`. This parses a TOTP key & configuration from the specified source, and tries and match the token. It's designed to parallel the :meth:`passlib.ifc.PasswordHash.verify` method. :param token: Token string to match. :param source: Serialized TOTP key. Can be anything accepted by :meth:`TOTP.from_source`. :param \\*\\*kwds: All additional keywords passed to :meth:`TOTP.match`. :return: A :class:`TotpMatch` instance, or raises a :exc:`TokenError`. )� from_sourcer� )r� r� r{ r� r; r; r< �verifys s z TOTP.verifyc C s� | � |�}| �|d� || }|du r*d}t|| �|| ��}| �|| �d }| �|||�} | |ksnJ d��| |kr�t|d | j d��t| | ||�S )aP Match TOTP token against specified timestamp. Searches within a window before & after the provided time, in order to account for transmission delay and small amounts of skew in the client's clock. :arg token: Token to validate. may be integer or string (whitespace and hyphens are ignored). :param time: Unix epoch timestamp, can be any of :class:`!float`, :class:`!int`, or :class:`!datetime`. if ``None`` (the default), uses current system time. *this should correspond to the time the token was received from the client*. :param int window: How far backward and forward in time to search for a match. Measured in seconds. Defaults to ``30``. Typically only useful if set to multiples of :attr:`period`. :param int skew: Adjust timestamp by specified value, to account for excessive client clock skew. Measured in seconds. Defaults to ``0``. Negative skew (the common case) indicates transmission delay, and/or that the client clock is running behind the server. Positive skew indicates the client clock is running ahead of the server (and by enough that it cancels out any negative skew added by the transmission delay). You should ensure the server clock uses a reliable time source such as NTP, so that only the client clock's inaccuracy needs to be accounted for. This is an advanced parameter that should usually be left at ``0``; The **window** parameter is usually enough to account for any observed transmission delay. :param last_counter: Optional value of last counter value that was successfully used. If specified, verify will never search earlier counters, no matter how large the window is. Useful when client has previously authenticated, and thus should never provide a token older than previously verified value. :raises ~passlib.exc.TokenError: If the token is malformed, fails to match, or has already been used. :returns TotpMatch: Returns a :class:`TotpMatch` instance on successful match. Can be treated as tuple of ``(counter, time)``. Raises error if token is malformed / can't be verified. Usage example:: >>> totp = TOTP('s3jdvb7qd2r7jpxx') >>> # valid token for this time period >>> totp.match('897212', 1419622729) <TotpMatch counter=47320757 time=1419622729 cache_seconds=60> >>> # token from counter step 30 sec ago (within allowed window) >>> totp.match('000492', 1419622729) <TotpMatch counter=47320756 time=1419622729 cache_seconds=60> >>> # invalid token -- token from 60 sec ago (outside of window) >>> totp.match('760389', 1419622729) Traceback: ... InvalidTokenError: Token did not match �windowNr� rv z*sanity check failed: counter went backward)� expire_time)r� r� rl r� � _find_matchr r� r0 ) rn r� r� r� Zskew� last_counterZ client_time�start�endr� r; r; r< r� � s K z TOTP.matchc C s~ | � |�}|dk rd}||kr$t� �| j}|du sL||k sLt|||��rL|S |}||k rtt|||��rj|S |d7 }qPt� �dS )aw helper for verify() -- returns counter value within specified range that matches token. :arg token: token value to match (will be normalized internally) :arg start: starting counter value to check :arg end: check up to (but not including) this counter value :arg expected: optional expected value where search should start, to help speed up searches. :raises ~passlib.exc.TokenError: If the token is malformed, or fails to verify. :returns: counter value that matched r Nrv )r� r r� r )rn r� r� r� Zexpectedr� r� r; r; r< r� � s zTOTP._find_matchc C sh t |t�r&| j|jkr|S |jdd�}t |t�r:| �|�S t|dd�}|�d�rZ| �|�S | � |�S dS )a� Load / create a TOTP object from a serialized source. This acts as a wrapper for the various deserialization methods: * TOTP URIs are handed off to :meth:`from_uri` * Any other strings are handed off to :meth:`from_json` * Dicts are handed off to :meth:`from_dict` :param source: Serialized TOTP object. :raises ValueError: If the key has been encrypted, but the application secret isn't available; or if the string cannot be recognized, parsed, or decoded. See :meth:`TOTP.using()` for how to configure application secrets. :returns: a :class:`TOTP` instance. F��encryptz totp sourcerM z otpauth://N) rT r. r� �to_dictr� � from_dictr ry �from_uri� from_json�r� r{ r; r; r< r� % s zTOTP.from_sourcec C sB t |dd��� }t|�}|jdkr,| �d��| �|j� | �|�S )a< create an OTP instance from a URI (such as returned by :meth:`to_uri`). :returns: :class:`TOTP` instance. :raises ValueError: if the uri cannot be parsed or contains errors. .. seealso:: :ref:`totp-configuring-clients` tutorial for a usage example �urirM r5 zwrong uri scheme)r rx r �scheme�_uri_parse_error�_check_otp_type�netloc�_from_parsed_uri)r� r� �resultr; r; r< r� M s z TOTP.from_uric C s, |dkr dS |dkr t d��td| ��dS )zg validate otp URI type is supported. returns True or raises appropriate error. �totpTZhotpzHOTP not supportedzunknown otp type: %rN)�NotImplementedErrorr[ )r� r� r; r; r< r d s zTOTP._check_otp_typec C s |j }|�d�r.t|�dkr.t|dd� �}n | �d��d|v rrz|�d�\}}W qv tyn | �d��Y qv0 nd}|r�|�� p�d}t|d�}t |j �D ]&\}}||v r�| �d| ��|||< q�|r�d |vr�||d < n|d |kr�| �d ��| f i | j f i |����S ) z� internal from_uri() helper -- handles parsing a validated TOTP URI :param result: a urlparse() instance :returns: cls instance �/rv Nz missing labelrt zmalformed labelr� zduplicate parameter (%r)r� z conflicting issuer identifiers) �pathry rF r r rz r[ rx r� r �query�_adapt_uri_params)r� r r� r� �paramsr� r� r; r; r< r p s. zTOTP._from_parsed_uric K sz |s J d��|s| � d��t|||dd�}|r>| �|d�|d< |rJ||d< |r^| �|d�|d< |rvtd| |f tj� |S ) zY from_uri() helper -- converts uri params into constructor args. z"from_uri() failed to provide labelzmissing 'secret' parameterrR )r� r� rL r] r� r� r� z4%s: unexpected parameters encountered in otp uri: %r)r r� �_uri_parse_intr r ZPasslibRuntimeWarning) r� r� r} r� r� � algorithmr� Zextrar� r; r; r< r � s" ��zTOTP._adapt_uri_paramsc C s t d| f �S )z8uri parsing helper -- creates preformatted error messagezInvalid otpauth uri: %sr� ��reasonr; r; r< r � s zTOTP._uri_parse_errorc C s0 z t |�W S ty* | �d| ��Y n0 dS )z#uri parsing helper -- int() wrapperzMalformed %r parameterN)rc r[ r )r� r{ rN r; r; r< r � s zTOTP._uri_parse_intc C s� |du r| j }|std��| �|� t|d�}| �� }|du rD| j}|rr| �|� dt|d�|f }|�d|f� td�� dd� |D ��}|s�J d ��td �||f S ) a� Serialize key and configuration into a URI, per Google Auth's `KeyUriFormat <http://code.google.com/p/google-authenticator/wiki/KeyUriFormat>`_. :param str label: Label to associate with this token when generating a URI. Displayed to user by most OTP client applications (e.g. Google Authenticator), and typically has format such as ``"John Smith"`` or ``"jsmith@webservice.example.org"``. Defaults to **label** constructor argument. Must be provided in one or the other location. May not contain ``:``. :param str issuer: String identifying the token issuer (e.g. the domain or canonical name of your service). Optional but strongly recommended if you're rendering to a URI. Used internally by some OTP client applications (e.g. Google Authenticator) to distinguish entries which otherwise have the same label. Defaults to **issuer** constructor argument, or ``None``. May not contain ``:``. :raises ValueError: * if a label was not provided either as an argument, or in the constructor. * if the label or issuer contains invalid characters. :returns: all the configuration information for this OTP token generator, encoded into a URI. These URIs are frequently converted to a QRCode for transferring to a TOTP client application such as Google Auth. Usage example:: >>> from passlib.totp import TOTP >>> tp = TOTP('s3jdvb7qd2r7jpxx') >>> uri = tp.to_uri("user@example.org", "myservice.another-example.org") >>> uri 'otpauth://totp/user@example.org?secret=S3JDVB7QD2R7JPXX&issuer=myservice.another-example.org' .. versionchanged:: 1.7.2 This method now prepends the issuer URI label. This is recommended by the KeyURI specification, for compatibility with older clients. Nz<a label must be specified as argument, or in the constructor�@z%s:%sr� �&c s s( | ] \}}t d �|t|d�f V qdS )z%s=%srO N)r r )r@ rL rC r; r; r< rD rE z TOTP.to_uri.<locals>.<genexpr>z param_str should never be emptyzotpauth://totp/%s?%s) r� r[ r� r �_to_uri_paramsr� r� �appendr rG )rn r� r� r Z param_strr; r; r< �to_uri� s . z TOTP.to_uric C sj d| j fg}| jdkr*|�d| j�� f� | jdkrH|�dt| j�f� | jdkrf|�dt| j�f� |S )z+return list of (key, param) entries for URIr} r� r r6 r� r� r� )r� r� r rZ r� r� r� �rn �argsr; r; r< r s zTOTP._to_uri_paramsc C s t |dd�}| �t�|��S )an Load / create an OTP object from a serialized json string (as generated by :meth:`to_json`). :arg json: Serialized output from :meth:`to_json`, as unicode or ascii bytes. :raises ValueError: If the key has been encrypted, but the application secret isn't available; or if the string cannot be recognized, parsed, or decoded. See :meth:`TOTP.using()` for how to configure application secrets. :returns: a :class:`TOTP` instance. .. seealso:: :ref:`totp-storing-instances` tutorial for a usage example z json sourcerM )r r� r� r� r� r; r; r< r� & s zTOTP.from_jsonc C s | j |d�}tj|ddd�S )a Serialize configuration & internal state to a json string, mainly useful for persisting client-specific state in a database. All keywords passed to :meth:`to_dict`. :returns: json string containing serializes configuration & state. r� T)�,rt )Z sort_keysZ separators)r� r� �dumps)rn r� �stater; r; r< �to_json= s z TOTP.to_jsonc C s6 t |t�rd|vr | �d��| f i | jf i |����S )aU Load / create a TOTP object from a dictionary (as generated by :meth:`to_dict`) :param source: dict containing serialized TOTP key & configuration. :raises ValueError: If the key has been encrypted, but the application secret isn't available; or if the dict cannot be recognized, parsed, or decoded. See :meth:`TOTP.using()` for how to configure application secrets. :returns: A :class:`TOTP` instance. .. seealso:: :ref:`totp-storing-instances` tutorial for a usage example r� zunrecognized format)rT r� �_dict_parse_error�_adapt_dict_kwdsr� r; r; r< r� M s zTOTP.from_dictc K s� | � |�sJ �|�dd�}|r2|| jk s2|| jkrD| �d|f ��n|| jkrVd|d< d|v r�d|vsjJ �|j|�d�dd � nd|vr�| �d ��|�d d� |S ) zt Internal helper for .from_json() -- Adapts serialized json dict into constructor keywords. r� Nz missing/unsupported version (%r)Tr� r� rL r� r\ zmissing 'enckey' / 'key'r� )r �pop�min_json_version� json_versionr r� )r� r� r� Zverr; r; r< r e s zTOTP._adapt_dict_kwdsc C s t d| f �S )z9dict parsing helper -- creates preformatted error messagezInvalid totp data: %sr� r r; r; r< r � s zTOTP._dict_parse_errorc C s� t | jdd�}| jdkr"| j|d< | jdkr6| j|d< | jdkrJ| j|d< | jrZ| j|d < | j}|rz|t| �jkrz||d < |d u r�| j}|o�|j }|r�| j |d < n | j |d < |S )aw Serialize configuration & internal state to a dict, mainly useful for persisting client-specific state in a database. :param encrypt: Whether to output should be encrypted. * ``None`` (the default) -- uses encrypted key if application secrets are available, otherwise uses plaintext key. * ``True`` -- uses encrypted key, or raises TypeError if application secret wasn't provided to OTP constructor. * ``False`` -- uses raw key. :returns: dictionary, containing basic (json serializable) datatypes. r )r� r� r� r� r6 r� r� r� r� r� Nr� rL ) r� r r� r� r� r� r� r� r� r� r� r� )rn r� r r� r� r; r; r< r� � s& z TOTP.to_dict)NNNNNN) NrR FNNNNNNF)r )rR r> )N)Nr� r N)N)NNNNNN)NN)N)N)=r� r� r� r� r� r r r� �_timer� r� r� r� r� r� r� r� r� r� r� � classmethodr� r� rp r� r� r� r� r� rL �setterr� r� r� r� r� r� r� r' r� r� r� r� r� r� r� r� r r r r r r r r� r r� r r r� � __classcell__r; r; r� r< r. s� M � h �M & - #" b 8 ' 0 � M r. c @ sd e Zd ZdZdZdZdZdd� Zedd� �Z edd� �Z e d d � �Z e d d � �Z d d� Zdd� ZdS )r/ a@ Object returned by :meth:`TOTP.generate`. It can be treated as a sequence of ``(token, expire_time)``, or accessed via the following attributes: .. autoattribute:: token .. autoattribute:: expire_time .. autoattribute:: counter .. autoattribute:: remaining .. autoattribute:: valid Nc C s || _ || _|| _dS �zu .. warning:: the constructor signature is an internal detail, and is subject to change. N)r r� r� )rn r r� r� r; r; r< rp � s zTotpToken.__init__c C s | j �| j�S )z9Timestamp marking beginning of period when token is valid�r r� r� r� r; r; r< � start_time� s zTotpToken.start_timec C s | j �| jd �S �z3Timestamp marking end of period when token is validrv r% r� r; r; r< r� � s zTotpToken.expire_timec C s t d| j| j�� �S )z.number of (float) seconds before token expiresr )rl r� r r� r� r; r; r< � remaining� s zTotpToken.remainingc C s t | j�S )z whether token is still valid)�boolr( r� r; r; r< �valid� s zTotpToken.validc C s | j | jfS r? )r� r� r� r; r; r< � _as_tuple� s zTotpToken._as_tuplec C s | j r dnd}d| j| j|f S )NrO z expiredz'<TotpToken token='%s' expire_time=%d%s>)r( r� r� )rn Zexpiredr; r; r< �__repr__� s �zTotpToken.__repr__)r� r� r� r� r r� r� rp r( r& r� r� r( r* r+ r, r; r; r; r< r/ � s r/ c @ sv e Zd ZdZdZdZdZdZddd�Ze dd� �Z e d d � �Z e d d � �Z e d d� �Z e dd� �Zdd� Zdd� ZdS )r0 a� Object returned by :meth:`TOTP.match` and :meth:`TOTP.verify` on a successful match. It can be treated as a sequence of ``(counter, time)``, or accessed via the following attributes: .. autoattribute:: counter :annotation: = 0 .. autoattribute:: time :annotation: = 0 .. autoattribute:: expected_counter :annotation: = 0 .. autoattribute:: skipped :annotation: = 0 .. autoattribute:: expire_time :annotation: = 0 .. autoattribute:: cache_seconds :annotation: = 60 .. autoattribute:: cache_time :annotation: = 0 This object will always have a ``True`` boolean value. Nr r� c C s || _ || _|| _|| _dS r$ )r r� r� r� )rn r r� r� r� r; r; r< rp & s zTotpMatch.__init__c C s | j �| j�S )z7 Counter value expected for timestamp. )r r� r� r� r; r; r< �expected_counter0 s zTotpMatch.expected_counterc C s | j | j S )z� How many steps were skipped between expected and actual matched counter value (may be positive, zero, or negative). )r� r- r� r; r; r< �skipped7 s zTotpMatch.skippedc C s | j �| jd �S r' r% r� r; r; r< r� D s zTotpMatch.expire_timec C s | j j| j S )z� Number of seconds counter should be cached before it's guaranteed to have passed outside of verification window. )r r� r� r� r; r; r< � cache_secondsI s zTotpMatch.cache_secondsc C s | j | j S )z[ Timestamp marking when counter has passed outside of verification window. )r� r� r� r; r; r< � cache_timeS s zTotpMatch.cache_timec C s | j | jfS r? )r� r� r� r; r; r< r+ Z s zTotpMatch._as_tuplec C s | j | j| jf}d| S )Nz/<TotpMatch counter=%d time=%d cache_seconds=%d>)r� r� r/ r r; r; r< r, ] s zTotpMatch.__repr__)r� )r� r� r� r� r r� r� r� rp r( r- r. r� r/ r0 r+ r, r; r; r; r< r0 � s$ r0 � ���c C sF | dks J �t |�dks J �tt�| t�dt |�� ��}tt||�S )z� generate a random string suitable for use as an :class:`AppWallet` application secret. :param entropy: number of bits of entropy (controls size/complexity of password). r rv r1 )rF rc �mathZceil�logr r )Zentropy�charset�countr; r; r< �generate_secrete s r7 )r> )hr� Z __future__r r r Zpasslib.utils.compatr rY r� r� ZloggingZ getLoggerr� r4 r3 �struct�sysr� r �re� urllib.parser r r r Zurllib�warningsr Z cryptography.hazmat.backendsr r� Z1cryptography.hazmat.primitives.ciphers.algorithmsZ cryptographyZ,cryptography.hazmat.primitives.ciphers.modesZ cryptography.hazmat.primitivesr r� � ImportError�debugZpasslibr Z passlib.excr r r r Z passlib.utilsr r r r r r r r Zpasslib.utils.binaryr r r r r r r r! r" r# r$ r% r& Zpasslib.utils.decorr' r( Zpasslib.crypto.digestr) r* r+ Z passlib.hashr, �__all__� version_infor4 r �compile�UrV r8 r= rI r^ r) Z AES_SUPPORTr� �objectr- �Struct�packr� �unpackr� r� r. r/ r0 r7 r; r; r; r< �<module> s� (0 g B;l