U
    ]=                     @   s   d Z ddlZddlZddlZddlZddlZddlmZmZm	Z	m
Z
 eeZG dd deZG dd dejZeeG dd	 d	e
je	jZd
d ZdddZdd ZdddZdd Zdd Zdd Zdd ZG dd deZdS )zJSON (de)serialization framework.

The framework presented here is somewhat based on `Go's "json" package`_
(especially the ``omitempty`` functionality).

.. _`Go's "json" package`: http://golang.org/pkg/encoding/json/

    N)b64errors
interfacesutilc                   @   sr   e Zd ZdZdZdddZedd Zd	d
 Zdd Z	dd Z
dd Zdd Zdd Zedd Zedd ZdS )Fielda  JSON object field.

    :class:`Field` is meant to be used together with
    :class:`JSONObjectWithFields`.

    ``encoder`` (``decoder``) is a callable that accepts a single
    parameter, i.e. a value to be encoded (decoded), and returns the
    serialized (deserialized) value. In case of errors it should raise
    :class:`~josepy.errors.SerializationError`
    (:class:`~josepy.errors.DeserializationError`).

    Note, that ``decoder`` should perform partial serialization only.

    :ivar str json_name: Name of the field when encoded to JSON.
    :ivar default: Default value (used when not present in JSON object).
    :ivar bool omitempty: If ``True`` and the field value is empty, then
        it will not be included in the serialized JSON object, and
        ``default`` will be used for deserialization. Otherwise, if ``False``,
        field is considered as required, value will always be included in the
        serialized JSON objected, and it must also be present when
        deserializing.

    )	json_namedefault	omitemptyfdecfencNFc                 C   s>   || _ || _|| _|d kr | jn|| _|d kr4| jn|| _d S N)r   r   r	   default_decoderr
   default_encoderr   )selfr   r   r	   decoderencoder r   2/usr/lib/python3/dist-packages/josepy/json_util.py__init__/   s
    zField.__init__c                 C   s   t |t o| S )zIs the provided value considered "empty" for this field?

        This is useful for subclasses that might want to override the
        definition of being empty, e.g. for some more exotic data types.

        )
isinstanceboolclsvaluer   r   r   _empty9   s    zField._emptyc                 C   s   |  |o| jS )zOmit the value in output?)r   r	   r   r   r   r   r   omitC   s    z
Field.omitc                 K   s4   t | j| j| j| j| jd}|| t| f |S )N)r   r   r	   r   r   )dictr   r   r	   r
   r   updatetype)r   kwargsZcurrentr   r   r   _update_paramsG   s    
 
zField._update_paramsc                 C   s   | j |dS )z6Descriptor to change the decoder on JSON object field.)r   r!   )r   r
   r   r   r   r   N   s    zField.decoderc                 C   s   | j |dS )z6Descriptor to change the encoder on JSON object field.)r   r"   )r   r   r   r   r   r   R   s    zField.encoderc                 C   s
   |  |S )z4Decode a value, optionally with context JSON object.)r
   r   r   r   r   decodeV   s    zField.decodec                 C   s
   |  |S )z4Encode a value, optionally with context JSON object.)r   r   r   r   r   encodeZ   s    zField.encodec                    sT   t |tr t fdd|D S t |trLtt fddt|D S |S dS )zDefault decoder.

        Recursively deserialize into immutable types (
        :class:`josepy.util.frozendict` instead of
        :func:`dict`, :func:`tuple` instead of :func:`list`).

        c                 3   s   | ]}  |V  qd S r   r   ).0Zsubvaluer   r   r   	<genexpr>i   s     z(Field.default_decoder.<locals>.<genexpr>c                 3   s&   | ]\}}  |  |fV  qd S r   r%   )r&   keyr   r'   r   r   r(   l   s   N)r   listtupler   r   Z
frozendictsix	iteritemsr   r   r'   r   r   ^   s    


zField.default_decoderc                 C   s   |S )zDefault (passthrough) encoder.r   r   r   r   r   r   q   s    zField.default_encoder)NFNN)__name__
__module____qualname____doc__	__slots__r   classmethodr   r   r!   r   r   r#   r$   r   r   r   r   r   r   r      s$       


	
r   c                   @   s   e Zd ZdZdd ZdS )JSONObjectWithFieldsMetaa  Metaclass for :class:`JSONObjectWithFields` and its subclasses.

    It makes sure that, for any class ``cls`` with ``__metaclass__``
    set to ``JSONObjectWithFieldsMeta``:

    1. All fields (attributes of type :class:`Field`) in the class
       definition are moved to the ``cls._fields`` dictionary, where
       keys are field attribute names and values are fields themselves.

    2. ``cls.__slots__`` is extended by all field attribute names
       (i.e. not :attr:`Field.json_name`). Original ``cls.__slots__``
       are stored in ``cls._orig_slots``.

    In a consequence, for a field attribute name ``some_field``,
    ``cls.some_field`` will be a slot descriptor and not an instance
    of :class:`Field`. For example::

      some_field = Field('someField', default=())

      class Foo(object):
          __metaclass__ = JSONObjectWithFieldsMeta
          __slots__ = ('baz',)
          some_field = some_field

      assert Foo.__slots__ == ('some_field', 'baz')
      assert Foo._orig_slots == ()
      assert Foo.some_field is not Field

      assert Foo._fields.keys() == ['some_field']
      assert Foo._fields['some_field'] is some_field

    As an implementation note, this metaclass inherits from
    :class:`abc.ABCMeta` (and not the usual :class:`type`) to mitigate
    the metaclass conflict (:class:`ImmutableMap` and
    :class:`JSONDeSerializable`, parents of :class:`JSONObjectWithFields`,
    use :class:`abc.ABCMeta` as its metaclass).

    c                 C   s   i }|D ]}| t|di  qtt|D ] \}}t|tr.||||< q.|dd|d< tt	|d t	t
| |d< ||d< tj| |||S )N_fieldsr2   r   Z_orig_slots)r   getattrr+   r,   r-   r   r   popgetr*   ZiterkeysabcABCMeta__new__)ZmcsnamebasesZdiktfieldsbaser)   r   r   r   r   r;      s    
z JSONObjectWithFieldsMeta.__new__N)r.   r/   r0   r1   r;   r   r   r   r   r4   y   s   'r4   c                       sh   e Zd ZdZedd Z fddZdd Zdd	 Zd
d Z	edd Z
edd Zedd Z  ZS )JSONObjectWithFieldsa  JSON object with fields.

    Example::

      class Foo(JSONObjectWithFields):
          bar = Field('Bar')
          empty = Field('Empty', omitempty=True)

          @bar.encoder
          def bar(value):
              return value + 'bar'

          @bar.decoder
          def bar(value):
              if not value.endswith('bar'):
                  raise errors.DeserializationError('No bar suffix!')
              return value[:-3]

      assert Foo(bar='baz').to_partial_json() == {'Bar': 'bazbar'}
      assert Foo.from_json({'Bar': 'bazbar'}) == Foo(bar='baz')
      assert (Foo.from_json({'Bar': 'bazbar', 'Empty': '!'})
              == Foo(bar='baz', empty='!'))
      assert Foo(bar='baz').bar == 'baz'

    c                 C   s   t dd t| jD S )zGet default fields values.c                 S   s   g | ]\}}||j fqS r   )r   )r&   slotfieldr   r   r   
<listcomp>   s     z2JSONObjectWithFields._defaults.<locals>.<listcomp>)r   r,   r-   r5   r'   r   r   r   	_defaults   s    
zJSONObjectWithFields._defaultsc                    s"   t t| jf t|  f| d S r   )superr@   r   r   rD   )r   r    	__class__r   r   r      s    zJSONObjectWithFields.__init__c                 C   sD   z| j | }W n$ tk
r2   td|Y nX |t| |S )zEncode a single field.

        :param str name: Name of the field to be encoded.

        :raises errors.SerializationError: if field cannot be serialized
        :raises errors.Error: if field could not be found

        zField not found: {0})r5   KeyErrorr   Errorformatr$   r6   )r   r<   rB   r   r   r   r$      s
    	zJSONObjectWithFields.encodec                 C   s   i }t  }t| jD ]z\}}t| |}||rB|||f qz||||j< W q t	j
k
r } zt	
d|||W 5 d}~X Y qX q|S )zSerialize fields to JSON.zCould not encode {0} ({1}): {2}N)setr,   r-   r5   r6   r   addr$   r   r   ZSerializationErrorrJ   )r   jobjZomittedrA   rB   r   errorr   r   r   fields_to_partial_json   s"    

  z+JSONObjectWithFields.fields_to_partial_jsonc                 C   s   |   S r   )rO   )r   r   r   r   to_partial_json   s    z$JSONObjectWithFields.to_partial_jsonc                 C   sV   t  }t| jD ]$\}}|js|j|kr||j q|rRtd	d
|d S )Nz&The following fields are required: {0},)rK   r,   r-   r5   r	   r   rL   r   DeserializationErrorrJ   join)r   rM   Zmissing_rB   r   r   r   _check_required  s    z$JSONObjectWithFields._check_requiredc                 C   s   |  | i }t| jD ]z\}}|j|kr>|jr>|j||< q||j }z||||< W q tj	k
r } zt	d
|||W 5 d}~X Y qX q|S )zDeserialize fields from JSON.z#Could not decode {0!r} ({1!r}): {2}N)rU   r,   r-   r5   r   r	   r   r#   r   rR   rJ   )r   rM   r>   rA   rB   r   rN   r   r   r   fields_from_json  s"    

  z%JSONObjectWithFields.fields_from_jsonc                 C   s   | f |  |S r   )rV   )r   rM   r   r   r   	from_json  s    zJSONObjectWithFields.from_json)r.   r/   r0   r1   r3   rD   r   r$   rO   rP   rU   rV   rW   __classcell__r   r   rF   r   r@      s   


r@   c                 C   s   t | dS )zNEncode JOSE Base-64 field.

    :param bytes data:
    :rtype: `unicode`

    ascii)r   Z	b64encoder#   )datar   r   r   encode_b64jose$  s    r[   Fc              
   C   s   t jr
tntj}zt|  }W n, |k
rN } zt	|W 5 d}~X Y nX |dk	r|sht
||ksx|rt
||k rt	d||S )a  Decode JOSE Base-64 field.

    :param unicode data:
    :param int size: Required length (after decoding).
    :param bool minimum: If ``True``, then `size` will be treated as
        minimum required length, as opposed to exact equality.

    :rtype: bytes

    Nz&Expected at least or exactly {0} bytes)r,   PY2	TypeErrorbinasciirI   r   Z	b64decoder$   r   rR   lenrJ   )rZ   sizeminimum	error_clsZdecodedrN   r   r   r   decode_b64jose/  s    
rc   c                 C   s   t |  S )z;Hexlify.

    :param bytes value:
    :rtype: unicode

    )r^   Zhexlifyr#   )r   r   r   r   encode_hex16H  s    rd   c              
   C   s   |   } |dk	r@|s$t| |d ks8|r@t| |d k r@t tjrJtntj}zt	| W S  |k
r } zt|W 5 d}~X Y nX dS )a  Decode hexlified field.

    :param unicode value:
    :param int size: Required length (after decoding).
    :param bool minimum: If ``True``, then `size` will be treated as
        minimum required length, as opposed to exact equality.

    :rtype: bytes

    N   )
r$   r_   r   rR   r,   r\   r]   r^   rI   Z	unhexlify)r   r`   ra   rb   rN   r   r   r   decode_hex16R  s    rf   c                 C   s   t tjtjj| jS )zEncode certificate as JOSE Base-64 DER.

    :type cert: `OpenSSL.crypto.X509` wrapped in `.ComparableX509`
    :rtype: unicode

    )r[   OpenSSLcryptoZdump_certificateFILETYPE_ASN1wrapped)Zcertr   r   r   encode_certh  s     rk   c              
   C   sT   zt tjtjjt| W S  tjjk
rN } zt	|W 5 d}~X Y nX dS )zDecode JOSE Base-64 DER-encoded certificate.

    :param unicode b64der:
    :rtype: `OpenSSL.crypto.X509` wrapped in `.ComparableX509`

    N)
r   ComparableX509rg   rh   Zload_certificateri   rc   rI   r   rR   Zb64derrN   r   r   r   decode_certs  s    
 rn   c                 C   s   t tjtjj| jS )zEncode CSR as JOSE Base-64 DER.

    :type csr: `OpenSSL.crypto.X509Req` wrapped in `.ComparableX509`
    :rtype: unicode

    )r[   rg   rh   Zdump_certificate_requestri   rj   )Zcsrr   r   r   
encode_csr  s     ro   c              
   C   sT   zt tjtjjt| W S  tjjk
rN } zt	|W 5 d}~X Y nX dS )zDecode JOSE Base-64 DER-encoded CSR.

    :param unicode b64der:
    :rtype: `OpenSSL.crypto.X509Req` wrapped in `.ComparableX509`

    N)
r   rl   rg   rh   Zload_certificate_requestri   rc   rI   r   rR   rm   r   r   r   
decode_csr  s    
 rp   c                   @   sJ   e Zd ZdZeZdZeZedddZ	edd Z
dd	 Zed
d ZdS )TypedJSONObjectWithFieldszJSON object with type.r   Nc                 C   s    |dkr|j n|}|| j|< |S )z(Register class for JSON deserialization.N)typTYPES)r   type_clsrr   r   r   r   register  s    
z"TypedJSONObjectWithFields.registerc                 C   s   | t | jkr0| j|kr,td| j| S t|tsJtd|z|| j }W n t	k
rv   tdY nX z| j| W S  t	k
r   t
||Y nX dS )z&Get the registered class for ``jobj``.zMissing type field ({0})z{0} is not a dictionary objectzmissing type fieldN)r,   Z
itervaluesrs   type_field_namer   rR   rJ   r   r   rH   ZUnrecognizedTypeError)r   rM   rr   r   r   r   get_type_cls  s$    


z&TypedJSONObjectWithFields.get_type_clsc                 C   s   |   }| j|| j< |S )a  Get JSON serializable object.

        :returns: Serializable JSON object representing ACME typed object.
            :meth:`validate` will almost certainly not work, due to reasons
            explained in :class:`josepy.interfaces.IJSONSerializable`.
        :rtype: dict

        )rO   rr   rv   )r   rM   r   r   r   rP     s    	z)TypedJSONObjectWithFields.to_partial_jsonc                 C   s   |  |}|f ||S )zDeserialize ACME object from valid JSON object.

        :raises josepy.errors.UnrecognizedTypeError: if type
            of the ACME object has not been registered.

        )rw   rV   )r   rM   rt   r   r   r   rW     s    	
z#TypedJSONObjectWithFields.from_json)N)r.   r/   r0   r1   NotImplementedrr   rv   rs   r3   ru   rw   rP   rW   r   r   r   r   rq     s   
rq   )NF)NF)r1   r9   r^   Zloggingrg   r,   Zjosepyr   r   r   r   Z	getLoggerr.   Zloggerobjectr   r:   r4   Zadd_metaclassZImmutableMapZJSONDeSerializabler@   r[   rc   rd   rf   rk   rn   ro   rp   rq   r   r   r   r   <module>   s(   
d;o


