diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/development/test-vectors.rst | 5 | ||||
-rw-r--r-- | docs/hazmat/primitives/asymmetric/dsa.rst | 47 | ||||
-rw-r--r-- | docs/hazmat/primitives/asymmetric/ec.rst | 40 | ||||
-rw-r--r-- | docs/hazmat/primitives/asymmetric/rsa.rst | 54 | ||||
-rw-r--r-- | docs/installation.rst | 17 | ||||
-rw-r--r-- | docs/spelling_wordlist.txt | 1 | ||||
-rw-r--r-- | docs/x509.rst | 4 |
7 files changed, 49 insertions, 119 deletions
diff --git a/docs/development/test-vectors.rst b/docs/development/test-vectors.rst index fe64fe1a..ea44a46c 100644 --- a/docs/development/test-vectors.rst +++ b/docs/development/test-vectors.rst @@ -104,6 +104,10 @@ X.509 cryptography website. * ``wildcard_san.pem`` - A leaf certificate issued by a public CA for ``langui.sh`` that contains wildcard entries in the SAN extension. +* ``san_edipartyname.der`` - A DSA certificate from a `Mozilla bug`_ + containing a SAN extension with an ``ediPartyName`` general name. +* ``san_x400address.der`` - A DSA certificate from a `Mozilla bug`_ containing + a SAN extension with an ``x400Address`` general name. Custom X.509 Vectors ~~~~~~~~~~~~~~~~~~~~ @@ -412,3 +416,4 @@ header format (substituting the correct information): .. _`DigiCert Global Root G3`: http://cacerts.digicert.com/DigiCertGlobalRootG3.crt .. _`root data`: https://hg.mozilla.org/projects/nss/file/25b2922cc564/security/nss/lib/ckfw/builtins/certdata.txt#l2053 .. _`asymmetric/public/PKCS1/dsa.pub.pem`: https://github.com/ruby/ruby/blob/4ccb387f3bc436a08fc6d72c4931994f5de95110/test/openssl/test_pkey_dsa.rb#L53 +.. _`Mozilla bug`: https://bugzilla.mozilla.org/show_bug.cgi?id=233586 diff --git a/docs/hazmat/primitives/asymmetric/dsa.rst b/docs/hazmat/primitives/asymmetric/dsa.rst index 179bb8d1..2ceb7d7d 100644 --- a/docs/hazmat/primitives/asymmetric/dsa.rst +++ b/docs/hazmat/primitives/asymmetric/dsa.rst @@ -284,23 +284,6 @@ Key interfaces The bit length of the modulus. -.. class:: DSAPrivateKeyWithNumbers - - .. versionadded:: 0.5 - - Extends :class:`DSAPrivateKey`. - - .. method:: private_numbers() - - Create a - :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateNumbers` - object. - - :returns: A - :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateNumbers` - instance. - - .. class:: DSAPrivateKeyWithSerialization .. versionadded:: 0.8 @@ -384,29 +367,6 @@ Key interfaces :returns: :class:`~cryptography.hazmat.primitives.asymmetric.AsymmetricVerificationContext` - -.. class:: DSAPublicKeyWithNumbers - - .. versionadded:: 0.5 - - Extends :class:`DSAPublicKey`. - - .. method:: public_numbers() - - Create a - :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicNumbers` - object. - - :returns: A - :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicNumbers` - instance. - -.. class:: DSAPublicKeyWithSerialization - - .. versionadded:: 0.8 - - Extends :class:`DSAPublicKey`. - .. method:: public_numbers() Create a @@ -435,6 +395,13 @@ Key interfaces :return bytes: Serialized key. +.. class:: DSAPublicKeyWithSerialization + + .. versionadded:: 0.8 + + Alias for :class:`DSAPublicKey`. + + .. _`DSA`: https://en.wikipedia.org/wiki/Digital_Signature_Algorithm .. _`public-key`: https://en.wikipedia.org/wiki/Public-key_cryptography .. _`FIPS 186-4`: http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-4.pdf diff --git a/docs/hazmat/primitives/asymmetric/ec.rst b/docs/hazmat/primitives/asymmetric/ec.rst index 71f6e6fd..e0abe0ab 100644 --- a/docs/hazmat/primitives/asymmetric/ec.rst +++ b/docs/hazmat/primitives/asymmetric/ec.rst @@ -321,19 +321,6 @@ Key Interfaces The EllipticCurvePublicKey object for this private key. -.. class:: EllipticCurvePrivateKeyWithNumbers - - .. versionadded:: 0.6 - - Extends :class:`EllipticCurvePrivateKey`. - - .. method:: private_numbers() - - Create a :class:`EllipticCurvePrivateNumbers` object. - - :returns: An :class:`EllipticCurvePrivateNumbers` instance. - - .. class:: EllipticCurvePrivateKeyWithSerialization .. versionadded:: 0.8 @@ -399,26 +386,6 @@ Key Interfaces The elliptic curve for this key. - -.. class:: EllipticCurvePublicKeyWithNumbers - - .. versionadded:: 0.6 - - Extends :class:`EllipticCurvePublicKey`. - - .. method:: public_numbers() - - Create a :class:`EllipticCurvePublicNumbers` object. - - :returns: An :class:`EllipticCurvePublicNumbers` instance. - - -.. class:: EllipticCurvePublicKeyWithSerialization - - .. versionadded:: 0.6 - - Extends :class:`EllipticCurvePublicKey`. - .. method:: public_numbers() Create a :class:`EllipticCurvePublicNumbers` object. @@ -443,6 +410,13 @@ Key Interfaces :return bytes: Serialized key. +.. class:: EllipticCurvePublicKeyWithSerialization + + .. versionadded:: 0.6 + + Alias for :class:`EllipticCurvePublicKey`. + + .. _`FIPS 186-3`: http://csrc.nist.gov/publications/fips/fips186-3/fips_186-3.pdf .. _`FIPS 186-4`: http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-4.pdf .. _`some concern`: https://crypto.stackexchange.com/questions/10263/should-we-trust-the-nist-recommended-ecc-parameters diff --git a/docs/hazmat/primitives/asymmetric/rsa.rst b/docs/hazmat/primitives/asymmetric/rsa.rst index 3b5b677b..e8bbf5ce 100644 --- a/docs/hazmat/primitives/asymmetric/rsa.rst +++ b/docs/hazmat/primitives/asymmetric/rsa.rst @@ -113,10 +113,8 @@ It is also possible to serialize without encryption using >>> pem.splitlines()[0] '-----BEGIN RSA PRIVATE KEY-----' -Similarly, if your public key implements -:class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKeyWithSerialization` -interface you can use -:meth:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKeyWithSerialization.public_bytes` +For public keys you can use +:meth:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey.public_bytes` to serialize the key. .. doctest:: @@ -518,23 +516,6 @@ Key interfaces The bit length of the modulus. -.. class:: RSAPrivateKeyWithNumbers - - .. versionadded:: 0.5 - - Extends :class:`RSAPrivateKey`. - - .. method:: private_numbers() - - Create a - :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateNumbers` - object. - - :returns: An - :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateNumbers` - instance. - - .. class:: RSAPrivateKeyWithSerialization .. versionadded:: 0.8 @@ -625,30 +606,6 @@ Key interfaces The bit length of the modulus. - -.. class:: RSAPublicKeyWithNumbers - - .. versionadded:: 0.5 - - Extends :class:`RSAPublicKey`. - - .. method:: public_numbers() - - Create a - :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicNumbers` - object. - - :returns: An - :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicNumbers` - instance. - - -.. class:: RSAPublicKeyWithSerialization - - .. versionadded:: 0.8 - - Extends :class:`RSAPublicKey`. - .. method:: public_numbers() Create a @@ -679,6 +636,13 @@ Key interfaces :return bytes: Serialized key. +.. class:: RSAPublicKeyWithSerialization + + .. versionadded:: 0.8 + + Alias for :class:`RSAPublicKey`. + + .. _`RSA`: https://en.wikipedia.org/wiki/RSA_(cryptosystem) .. _`public-key`: https://en.wikipedia.org/wiki/Public-key_cryptography .. _`specific mathematical properties`: https://en.wikipedia.org/wiki/RSA_(cryptosystem)#Key_generation diff --git a/docs/installation.rst b/docs/installation.rst index 1c25ff78..96e1e8de 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -125,8 +125,23 @@ You'll also need to generate your own ``openssl.ld`` file. For example:: You should replace the version string on the first line as appropriate for your build. +Building cryptography on OS X +----------------------------- + +Building cryptography requires the presence of a C compiler and development +headers. On OS X this is typically provided by Apple's Xcode development tools. +To install the Xcode command line tools on open a terminal window and run: + +.. code-block:: console + + $ xcode-select --install + +This will install a compiler (clang) along with the required development +headers. If you wish to compile against a more recent OpenSSL than the +version shipped with OS X see the next section. + Using your own OpenSSL on OS X ------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To link cryptography against a custom version of OpenSSL you'll need to set ``ARCHFLAGS``, ``LDFLAGS``, and ``CFLAGS``. OpenSSL can be installed via diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 235e08d4..1eed7c7a 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -63,3 +63,4 @@ unpadded unpadding Verisign wildcard +Xcode diff --git a/docs/x509.rst b/docs/x509.rst index f94f50eb..a3cf7e25 100644 --- a/docs/x509.rst +++ b/docs/x509.rst @@ -328,6 +328,8 @@ X.509 Certificate Object .. method:: public_bytes(encoding) + .. versionadded:: 1.0 + :param encoding: The :class:`~cryptography.hazmat.primitives.serialization.Encoding` that will be used to serialize the certificate. @@ -435,6 +437,8 @@ X.509 CSR (Certificate Signing Request) Object .. method:: public_bytes(encoding) + .. versionadded:: 1.0 + :param encoding: The :class:`~cryptography.hazmat.primitives.serialization.Encoding` that will be used to serialize the certificate request. |