cryptography.x509
pem_crl_data = b""" -----BEGIN X509 CRL-----MIIBtDCBnQIBAjANBgkqhkiG9w0BAQsFADAnMQswCQYDVQQGEwJVUzEYMBYGA1UE AwwPY3J5cHRvZ3JhcGh5LmlvGA8yMDE1MDEwMTAwMDAwMFoYDzIwMTYwMTAxMDAw MDAwWjA+MDwCAQAYDzIwMTUwMTAxMDAwMDAwWjAmMBgGA1UdGAQRGA8yMDE1MDEw MTAwMDAwMFowCgYDVR0VBAMKAQEwDQYJKoZIhvcNAQELBQADggEBABRA4ww50Lz5 zk1j2+aluC4HPHqb7o06h4pTDcCGeXUKXIGeP5ntGGmIoxa26sNoLeOr8+5b43Gf yWraHertllOwaOpNFEe+YZFaE9femtoDbf+GLMvRx/0wDfd3KxPoXnXKMXb2d1w4 RCLgmkYx6JyvS+5ciuLQVIKC+l7jwIUeZFLJMUJ8msM4pFYoGameeZmtjMbd/TNg cVBfmZxNMHuLladJxvSo2esARo0TYPhYsgrREKoHwhpzSxdynjn4bOVkILfguwsN qtEEMZFEv5Kb0GqRp2+Iagv2S6dg9JGvxVdsoGjaB6EbYSZ3Psx4aODasIn11uwo X4B9vUQNXqc= -----END X509 CRL-----""".strip()
pem_req_data = b""" -----BEGIN CERTIFICATE REQUEST-----MIICcDCCAVgCAQAwDTELMAkGA1UEBhMCVVMwggEiMA0GCSqGSIb3DQEBAQUAA4IB DwAwggEKAoIBAQCb+ec0zYAYLzk/MDdDJYvzdvEO2ZUrBYM6z1r8NedwpJfxUWqC hvK1cpc9EbQeCwS1eooTIGoNveeCrwL+pWdmf1sh6gz7SsxdN/07nyhSM8M6Xkec +tGrjyi1H/N1afwWXox3WcvBNbxu3Df5RKLDb0yt9aqhmJylbl/tbvgJesXymwmp Rc1vXL0fOedUtuAJ3xQ15M0pgLF8qDn4lySJz25x76pMYPeN5/a7x+SR/jj81kep VaVpuh/2hePV5uwUX3uWoj5sAkrBCifi4NPge0Npd6KeKVvXytLOymH/4+WvV719 wCO+MyrkhpdHSakJDTIaQIxsqVeVVKdPLAPJAgMBAAGgHjAcBgkqhkiG9w0BCQcx DwwNY2hhbGxlbmdlIG1lITANBgkqhkiG9w0BAQsFAAOCAQEAMmgeSa8szbjPFD/4 vcPBr/vBEROFGgL8mX3o5pF9gpr7nRjhLKBkgJvlRm6Ma3Xvdfc/r5Hp2ZBTA7sZ ZYhyeezGfCQN/Qhda1v+sCwG58IjvGfCSS7Y5tGlEBQ4MDf0Q7PYPSxaNUEBH7vo +M7U+nFuNSmyWlt6SFBSkohZkWoVSGx3KsAO+SAHYZ7JtqsAS/dm7Dflp8KxeDg7 wzGBDQRpGF4CpI1VQjGSJQXSEdD+J7mtvBEOD34abRfV6zOUGzOOo3NWE6wNpYgt 0A7gVlzSYpdwqjBdvACfXR2r/mu+4KkAvYh8WwCiTcYgGjl2pT1bO4hEmcJ0RSWy /fGD8Q== -----END CERTIFICATE REQUEST-----""".strip()
pem_data = b""" -----BEGIN CERTIFICATE-----MIIDfDCCAmSgAwIBAgIBAjANBgkqhkiG9w0BAQsFADBFMQswCQYDVQQGEwJVUzEf MB0GA1UEChMWVGVzdCBDZXJ0aWZpY2F0ZXMgMjAxMTEVMBMGA1UEAxMMVHJ1c3Qg QW5jaG9yMB4XDTEwMDEwMTA4MzAwMFoXDTMwMTIzMTA4MzAwMFowQDELMAkGA1UE BhMCVVMxHzAdBgNVBAoTFlRlc3QgQ2VydGlmaWNhdGVzIDIwMTExEDAOBgNVBAMT B0dvb2QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCQWJpHYo37 Xfb7oJSPe+WvfTlzIG21WQ7MyMbGtK/m8mejCzR6c+f/pJhEH/OcDSMsXq8h5kXa BGqWK+vSwD/Pzp5OYGptXmGPcthDtAwlrafkGOS4GqIJ8+k9XGKs+vQUXJKsOk47 RuzD6PZupq4s16xaLVqYbUC26UcY08GpnoLNHJZS/EmXw1ZZ3d4YZjNlpIpWFNHn UGmdiGKXUPX/9H0fVjIAaQwjnGAbpgyCumWgzIwPpX+ElFOUr3z7BoVnFKhIXze+ VmQGSWxZxvWDUN90Ul0tLEpLgk3OVxUB4VUGuf15OJOpgo1xibINPmWt14Vda2N9 yrNKloJGZNqLAgMBAAGjfDB6MB8GA1UdIwQYMBaAFOR9X9FclYYILAWuvnW2ZafZ XahmMB0GA1UdDgQWBBRYAYQkG7wrUpRKPaUQchRR9a86yTAOBgNVHQ8BAf8EBAMC AQYwFwYDVR0gBBAwDjAMBgpghkgBZQMCATABMA8GA1UdEwEB/wQFMAMBAf8wDQYJ KoZIhvcNAQELBQADggEBADWHlxbmdTXNwBL/llwhQqwnazK7CC2WsXBBqgNPWj7m tvQ+aLG8/50Qc2Sun7o2VnwF9D18UUe8Gj3uPUYH+oSI1vDdyKcjmMbKRU4rk0eo 3UHNDXwqIVc9CQS9smyV+x1HCwL4TTrq+LXLKx/qVij0Yqk+UJfAtrg2jnYKXsCu FMBQQnWCGrwa1g1TphRp/RmYHnMynYFmZrXtzFz+U9XEA7C+gPq4kqDI/iVfIT1s 6lBtdB50lrDVwl2oYfAvW/6sC2se2QleZidUmrziVNP4oEeXINokU6T6p//HM1FG QYw2jOvpKcKtWCSAnegEbgsGYzATKjmPJPJ0npHFqzM= -----END CERTIFICATE-----""".strip()
cryptography_cert_pem = b""" -----BEGIN CERTIFICATE-----MIIFvTCCBKWgAwIBAgICPyAwDQYJKoZIhvcNAQELBQAwRzELMAkGA1UEBhMCVVMx FjAUBgNVBAoTDUdlb1RydXN0IEluYy4xIDAeBgNVBAMTF1JhcGlkU1NMIFNIQTI1 NiBDQSAtIEczMB4XDTE0MTAxNTEyMDkzMloXDTE4MTExNjAxMTUwM1owgZcxEzAR BgNVBAsTCkdUNDg3NDI5NjUxMTAvBgNVBAsTKFNlZSB3d3cucmFwaWRzc2wuY29t L3Jlc291cmNlcy9jcHMgKGMpMTQxLzAtBgNVBAsTJkRvbWFpbiBDb250cm9sIFZh bGlkYXRlZCAtIFJhcGlkU1NMKFIpMRwwGgYDVQQDExN3d3cuY3J5cHRvZ3JhcGh5 LmlvMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAom/FebKJIot7Sp3s itG1sicpe3thCssjI+g1JDAS7I3GLVNmbms1DOdIIqwf01gZkzzXBN2+9sOnyRaR PPfCe1jTr3dk2y6rPE559vPa1nZQkhlzlhMhlPyjaT+S7g4Tio4qV2sCBZU01DZJ CaksfohN+5BNVWoJzTbOcrHOEJ+M8B484KlBCiSxqf9cyNQKru4W3bHaCVNVJ8eu 6i6KyhzLa0L7yK3LXwwXVs583C0/vwFhccGWsFODqD/9xHUzsBIshE8HKjdjDi7Y 3BFQzVUQFjBB50NSZfAA/jcdt1blxJouc7z9T8Oklh+V5DDBowgAsrT4b6Z2Fq6/ r7D1GqivLK/ypUQmxq2WXWAUBb/Q6xHgxASxI4Br+CByIUQJsm8L2jzc7k+mF4hW ltAIUkbo8fGiVnat0505YJgxWEDKOLc4Gda6d/7GVd5AvKrz242bUqeaWo6e4MTx diku2Ma3rhdcr044Qvfh9hGyjqNjvhWY/I+VRWgihU7JrYvgwFdJqsQ5eiKT4OHi gsejvWwkZzDtiQ+aQTrzM1FsY2swJBJsLSX4ofohlVRlIJCn/ME+XErj553431Lu YQ5SzMd3nXzN78Vj6qzTfMUUY72UoT1/AcFiUMobgIqrrmwuNxfrkbVE2b6Bga74 FsJX63prvrJ41kuHK/16RQBM7fcCAwEAAaOCAWAwggFcMB8GA1UdIwQYMBaAFMOc 8/zTRgg0u85Gf6B8W/PiCMtZMFcGCCsGAQUFBwEBBEswSTAfBggrBgEFBQcwAYYT aHR0cDovL2d2LnN5bWNkLmNvbTAmBggrBgEFBQcwAoYaaHR0cDovL2d2LnN5bWNi LmNvbS9ndi5jcnQwDgYDVR0PAQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMB BggrBgEFBQcDAjAvBgNVHREEKDAmghN3d3cuY3J5cHRvZ3JhcGh5Lmlvgg9jcnlw dG9ncmFwaHkuaW8wKwYDVR0fBCQwIjAgoB6gHIYaaHR0cDovL2d2LnN5bWNiLmNv bS9ndi5jcmwwDAYDVR0TAQH/BAIwADBFBgNVHSAEPjA8MDoGCmCGSAGG+EUBBzYw LDAqBggrBgEFBQcCARYeaHR0cHM6Ly93d3cucmFwaWRzc2wuY29tL2xlZ2FsMA0G CSqGSIb3DQEBCwUAA4IBAQAzIYO2jx7h17FBT74tJ2zbV9OKqGb7QF8y3wUtP4xc dH80vprI/Cfji8s86kr77aAvAqjDjaVjHn7UzebhSUivvRPmfzRgyWBacomnXTSt Xlt2dp2nDQuwGyK2vB7dMfKnQAkxwq1sYUXznB8i0IhhCAoXp01QGPKq51YoIlnF 7DRMk6iEaL1SJbkIrLsCQyZFDf0xtfW9DqXugMMLoxeCsBhZJQzNyS2ryirrv9LH aK3+6IZjrcyy9bkpz/gzJucyhU+75c4My/mnRCrtItRbCQuiI5pd5poDowm+HH9i GVI9+0lAFwxOUnOnwsoI40iOoxjLMGB+CgFLKCGUcWxP -----END CERTIFICATE-----""".strip()
pem_issuer_public_key = b""" -----BEGIN RSA PUBLIC KEY-----MIICCgKCAgEAyYcqyuT6oQxpvg/VSn2Zc68wZ823D0VAJ2woramFx+2KPWB7B7Ot tVSNRfm0OxJOU3TFAoep54Z2wgOoz0zRmeW6/7gvIuBKp2TW0qZAt3l9sgpE29iw CsoZQlMrLKiDPzCC6Fptk+YPSST9sqwhWDKK1QvOg68DKRxTpEek1hBpC0XRsnuX fvJJQqP39vxzpA0PsicI/wrvWX3vO8z+j9+botPerbeamoeHCsc0xgTLyIygWysB rNskxlzC2U4Kw6mQhGghlLReo1rFsO2/hLTnvLs+Y1lQhnFeOKCx1WVXhzBIyO9B dVVH5Cinb5wBNKvxbevRf4icdWcwtknmgKf69xj7yvFjt/vft74BB1Y5ltLYFmEb 0JBxm5MAJfW4YnMQr0AxdjOhjHq4MN7X4ZzwEpJaYJdRmvMsMGN88cyjYPxsaOG+ dZ/E9MmTjh0gnTjyD4gmsvR/gtTR/XFJ2wkbnnL1RyxNi6j2UW8C7tpNv0TIuArx 3SHGPZN0WsaKTxZPb0L/ob1WBT0mhiq1GzB431cXgbxyh8EdKk+xSptA3V+ca2V2 NuXlJIJaOoPMj/qjDW4I/peKGnk9tLknJ0hpRzz11j77pJsV0dGoGKVHIR2oZqT5 0ZJJb5DXNbiTnspKLNmBt0YlNiXtlCIPxVUkhL141FuCLc8h6FjD6E0CAwEAAQ== -----END RSA PUBLIC KEY-----""".strip()
pem_data_to_check = b""" -----BEGIN CERTIFICATE-----MIIErjCCApagAwIBAgIUUrUZsZrrBmRD2hvRuspp+lPsZXcwDQYJKoZIhvcNAQEN BQAwETEPMA0GA1UEAwwGSXNzdWVyMB4XDTE4MTAwODEzNDg1NFoXDTE4MTAxODEz NDg1NFowETEPMA0GA1UEAwwGSXNzdWVyMIICIjANBgkqhkiG9w0BAQEFAAOCAg8A MIICCgKCAgEAyYcqyuT6oQxpvg/VSn2Zc68wZ823D0VAJ2woramFx+2KPWB7B7Ot tVSNRfm0OxJOU3TFAoep54Z2wgOoz0zRmeW6/7gvIuBKp2TW0qZAt3l9sgpE29iw CsoZQlMrLKiDPzCC6Fptk+YPSST9sqwhWDKK1QvOg68DKRxTpEek1hBpC0XRsnuX fvJJQqP39vxzpA0PsicI/wrvWX3vO8z+j9+botPerbeamoeHCsc0xgTLyIygWysB rNskxlzC2U4Kw6mQhGghlLReo1rFsO2/hLTnvLs+Y1lQhnFeOKCx1WVXhzBIyO9B dVVH5Cinb5wBNKvxbevRf4icdWcwtknmgKf69xj7yvFjt/vft74BB1Y5ltLYFmEb 0JBxm5MAJfW4YnMQr0AxdjOhjHq4MN7X4ZzwEpJaYJdRmvMsMGN88cyjYPxsaOG+ dZ/E9MmTjh0gnTjyD4gmsvR/gtTR/XFJ2wkbnnL1RyxNi6j2UW8C7tpNv0TIuArx 3SHGPZN0WsaKTxZPb0L/ob1WBT0mhiq1GzB431cXgbxyh8EdKk+xSptA3V+ca2V2 NuXlJIJaOoPMj/qjDW4I/peKGnk9tLknJ0hpRzz11j77pJsV0dGoGKVHIR2oZqT5 0ZJJb5DXNbiTnspKLNmBt0YlNiXtlCIPxVUkhL141FuCLc8h6FjD6E0CAwEAATAN BgkqhkiG9w0BAQ0FAAOCAgEAVFzNKhEpkH8V8l0NEBAZHNi1e+lcg35fZZ9plqcw Pvk+6M7LW0KD0QWYQWm/dJme4DFsM7lh5u4/m+H4yS7/RP9pads9YwBudchvGR1c S4CCrRAmO8/A0vpQJcEwdS7fdYShBsqMrZ2TvzceVn2dvQbxB6pLkK7KIbDPVJA2 HXFFXe2npHmdc80iTz2ShbdVSvyPvk6vc6NFFCg6lSQFuif3vV0+aYqi6DXv4h92 9qAdES8ZLDfDulxyajyPbtF35f2Of99CumP5UzG4RQbvtI8gShuK1YFYe2sWJFE0 MgSsqGCbl5mcrWxm9YxysRKMZ+Hc4tnkvfmG6GsKtp8u/5pG11XgxXaQl4fZ7JNa QFuD5gEXkEC1mCnhWlnguJgjQlpKadMOORmVTqG9dNQ6GEsha+XWpinm5L9fEZuA F88nNyubKLwEl68N7WWWKQlIl4q8Pe5FEp1pd9rLjOW4gzgYBccIfBK3oMC7uFJg a/9GeOKPiq90UMrCI+CAsIbzuPOaAp3g69JonuDwcs4cu8ui1udxs9q7ox3qSWGZ G1U/hmwvZH9kfIv5BKIzNLy4oxXPDJ7MZIBsxVxaNv8KUQ/JLtpVJa3oYqEx18+V JNr8Pr3y61X8pLmJnaCu+ixshiy2gjxXxDFBVEEt1G9JHrSs3R+yvcHxCrM3+ian Nh4= -----END CERTIFICATE-----""".strip()
load_pem_x509_certificate(data, backend=None)
0.7
Deserialize a certificate from PEM encoded data. PEM certificates are base64 decoded and have delimiters that look like -----BEGIN CERTIFICATE-----
.
- param bytes data
The PEM encoded certificate data.
- param backend
An optional backend supporting the
~cryptography.hazmat.backends.interfaces.X509Backend
interface.- returns
An instance of
~cryptography.x509.Certificate
.
>>> from cryptography import x509 >>> from cryptography.hazmat.backends import default_backend >>> cert = x509.load_pem_x509_certificate(pem_data, default_backend()) >>> cert.serial_number 2
load_der_x509_certificate(data, backend=None)
0.7
Deserialize a certificate from DER encoded data. DER is a binary format and is commonly found in files with the .cer
extension (although file extensions are not a guarantee of encoding type).
- param bytes data
The DER encoded certificate data.
- param backend
An optional backend supporting the
~cryptography.hazmat.backends.interfaces.X509Backend
interface.- returns
An instance of
~cryptography.x509.Certificate
.
load_pem_x509_crl(data, backend=None)
1.1
Deserialize a certificate revocation list (CRL) from PEM encoded data. PEM requests are base64 decoded and have delimiters that look like -----BEGIN X509 CRL-----
.
- param bytes data
The PEM encoded request data.
- param backend
An optional backend supporting the
~cryptography.hazmat.backends.interfaces.X509Backend
interface.- returns
An instance of
~cryptography.x509.CertificateRevocationList
.
>>> from cryptography import x509 >>> from cryptography.hazmat.backends import default_backend >>> from cryptography.hazmat.primitives import hashes >>> crl = x509.load_pem_x509_crl(pem_crl_data, default_backend()) >>> isinstance(crl.signature_hash_algorithm, hashes.SHA256) True
load_der_x509_crl(data, backend=None)
1.1
Deserialize a certificate revocation list (CRL) from DER encoded data. DER is a binary format.
- param bytes data
The DER encoded request data.
- param backend
An optional backend supporting the
~cryptography.hazmat.backends.interfaces.X509Backend
interface.- returns
An instance of
~cryptography.x509.CertificateRevocationList
.
load_pem_x509_csr(data, backend=None)
0.9
Deserialize a certificate signing request (CSR) from PEM encoded data. PEM requests are base64 decoded and have delimiters that look like -----BEGIN CERTIFICATE REQUEST-----
. This format is also known as PKCS#10.
- param bytes data
The PEM encoded request data.
- param backend
An optional backend supporting the
~cryptography.hazmat.backends.interfaces.X509Backend
interface.- returns
An instance of
~cryptography.x509.CertificateSigningRequest
.
>>> from cryptography import x509 >>> from cryptography.hazmat.backends import default_backend >>> from cryptography.hazmat.primitives import hashes >>> csr = x509.load_pem_x509_csr(pem_req_data, default_backend()) >>> isinstance(csr.signature_hash_algorithm, hashes.SHA256) True
load_der_x509_csr(data, backend=None)
0.9
Deserialize a certificate signing request (CSR) from DER encoded data. DER is a binary format and is not commonly used with CSRs.
- param bytes data
The DER encoded request data.
- param backend
An optional backend supporting the
~cryptography.hazmat.backends.interfaces.X509Backend
interface.- returns
An instance of
~cryptography.x509.CertificateSigningRequest
.
0.7
version
- type
:class:~cryptography.x509.Version
The certificate version as an enumeration. Version 3 certificates are the latest version and also the only type you should see in practice.
- raises cryptography.x509.InvalidVersion
If the version in the certificate is not a known
X.509 version <cryptography.x509.Version>
.
>>> cert.version <Version.v3: 2>
fingerprint(algorithm)
- param algorithm
The
~cryptography.hazmat.primitives.hashes.HashAlgorithm
that will be used to generate the fingerprint.- return bytes
The fingerprint using the supplied hash algorithm, as bytes.
>>> from cryptography.hazmat.primitives import hashes >>> cert.fingerprint(hashes.SHA256()) b'x86xd2x187Gcxfcxe7}[+E9x8dxb4x8fx10xe5Sxdax18uxbe}ax03x08[xacxa04?'
serial_number
- type
int
The serial as a Python integer.
>>> cert.serial_number 2
public_key()
The public key associated with the certificate.
- returns
One of
~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey
,~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey
,~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey
,~cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PublicKey
or~cryptography.hazmat.primitives.asymmetric.ed448.Ed448PublicKey
>>> from cryptography.hazmat.primitives.asymmetric import rsa >>> public_key = cert.public_key() >>> isinstance(public_key, rsa.RSAPublicKey) True
not_valid_before
- type
datetime.datetime
A naïve datetime representing the beginning of the validity period for the certificate in UTC. This value is inclusive.
>>> cert.not_valid_before datetime.datetime(2010, 1, 1, 8, 30)
not_valid_after
- type
datetime.datetime
A naïve datetime representing the end of the validity period for the certificate in UTC. This value is inclusive.
>>> cert.not_valid_after datetime.datetime(2030, 12, 31, 8, 30)
issuer
0.8
- type
Name
The Name
of the issuer.
subject
0.8
- type
:class:Name
The Name
of the subject.
signature_hash_algorithm
- type
~cryptography.hazmat.primitives.hashes.HashAlgorithm
Returns the ~cryptography.hazmat.primitives.hashes.HashAlgorithm
which was used in signing this certificate. Can be None
if signature did not use separate hash (~cryptography.x509.oid.SignatureAlgorithmOID.ED25519
, ~cryptography.x509.oid.SignatureAlgorithmOID.ED448
).
>>> from cryptography.hazmat.primitives import hashes >>> isinstance(cert.signature_hash_algorithm, hashes.SHA256) True
signature_algorithm_oid
1.6
- type
ObjectIdentifier
Returns the ObjectIdentifier
of the signature algorithm used to sign the certificate. This will be one of the OIDs from ~cryptography.x509.oid.SignatureAlgorithmOID
.
>>> cert.signature_algorithm_oid <ObjectIdentifier(oid=1.2.840.113549.1.1.11, name=sha256WithRSAEncryption)>
extensions
- type
Extensions
The extensions encoded in the certificate.
- raises cryptography.x509.DuplicateExtension
If more than one extension of the same type is found within the certificate.
- raises cryptography.x509.UnsupportedGeneralNameType
If an extension contains a general name that is not supported.
>>> for ext in cert.extensions: ... print(ext) <Extension(oid=<ObjectIdentifier(oid=2.5.29.35, name=authorityKeyIdentifier)>, critical=False, value=<AuthorityKeyIdentifier(key_identifier=b'xe4}_xd1\x95x86x08,x05xaexbeuxb6exa7xd9]xa8f', authority_cert_issuer=None, authority_cert_serial_number=None)>)> <Extension(oid=<ObjectIdentifier(oid=2.5.29.14, name=subjectKeyIdentifier)>, critical=False, value=<SubjectKeyIdentifier(digest=b'Xx01x84$x1bxbc+Rx94J=xa5x10rx14Qxf5xaf:xc9')>)> <Extension(oid=<ObjectIdentifier(oid=2.5.29.15, name=keyUsage)>, critical=True, value=<KeyUsage(digital_signature=False, content_commitment=False, key_encipherment=False, data_encipherment=False, key_agreement=False, key_cert_sign=True, crl_sign=True, encipher_only=False, decipher_only=False)>)> <Extension(oid=<ObjectIdentifier(oid=2.5.29.32, name=certificatePolicies)>, critical=False, value=<CertificatePolicies([<PolicyInformation(policy_identifier=<ObjectIdentifier(oid=2.16.840.1.101.3.2.1.48.1, name=Unknown OID)>, policy_qualifiers=None)>])>)> <Extension(oid=<ObjectIdentifier(oid=2.5.29.19, name=basicConstraints)>, critical=True, value=<BasicConstraints(ca=True, path_length=None)>)>
signature
1.2
- type
bytes
The bytes of the certificate's signature.
tbs_certificate_bytes
1.2
- type
bytes
The DER encoded bytes payload (as defined by 5280
) that is hashed and then signed by the private key of the certificate's issuer. This data may be used to validate a signature, but use extreme caution as certificate validation is a complex problem that involves much more than just signature checks.
To validate the signature on a certificate you can do the following. Note: This only verifies that the certificate was signed with the private key associated with the public key provided and does not perform any of the other checks needed for secure certificate validation. Additionally, this example will only work for RSA public keys with PKCS1v15
signatures, and so it can't be used for general purpose signature verification.
>>> from cryptography.hazmat.primitives.serialization import load_pem_public_key >>> from cryptography.hazmat.primitives.asymmetric import padding >>> issuer_public_key = load_pem_public_key(pem_issuer_public_key, default_backend()) >>> cert_to_check = x509.load_pem_x509_certificate(pem_data_to_check, default_backend()) >>> issuer_public_key.verify( ... cert_to_check.signature, ... cert_to_check.tbs_certificate_bytes, ... # Depends on the algorithm used to create the certificate ... padding.PKCS1v15(), ... cert_to_check.signature_hash_algorithm, ... )
An ~cryptography.exceptions.InvalidSignature
exception will be raised if the signature fails to verify.
public_bytes(encoding)
1.0
- param encoding
The
~cryptography.hazmat.primitives.serialization.Encoding
that will be used to serialize the certificate.- return bytes
The data that can be written to a file or sent over the network to be verified by clients.
1.0
A CertificateRevocationList is an object representing a list of revoked certificates. The object is iterable and will yield the RevokedCertificate objects stored in this CRL.
>>> len(crl) 1 >>> revoked_certificate = crl[0] >>> type(revoked_certificate) <class 'cryptography.hazmat.backends.openssl.x509._RevokedCertificate'> >>> for r in crl: ... print(r.serial_number) 0
fingerprint(algorithm)
- param algorithm
The
~cryptography.hazmat.primitives.hashes.HashAlgorithm
that will be used to generate the fingerprint.- return bytes
The fingerprint using the supplied hash algorithm, as bytes.
>>> from cryptography.hazmat.primitives import hashes >>> crl.fingerprint(hashes.SHA256()) b'excf.xc4:x83?1xdcxf3xfcx95xd7xb3x87xb3x8exf8xb93!x87x07x9dx1bxb4!xb9xe4Wxf4x1f'
get_revoked_certificate_by_serial_number(serial_number)
2.3
- param serial_number
The serial as a Python integer.
- returns
~cryptography.x509.RevokedCertificate
if theserial_number
is present in the CRL orNone
if it is not.
signature_hash_algorithm
- type
~cryptography.hazmat.primitives.hashes.HashAlgorithm
Returns the ~cryptography.hazmat.primitives.hashes.HashAlgorithm
which was used in signing this CRL. Can be None
if signature did not use separate hash (~cryptography.x509.oid.SignatureAlgorithmOID.ED25519
, ~cryptography.x509.oid.SignatureAlgorithmOID.ED448
).
>>> from cryptography.hazmat.primitives import hashes >>> isinstance(crl.signature_hash_algorithm, hashes.SHA256) True
signature_algorithm_oid
1.6
- type
ObjectIdentifier
Returns the ObjectIdentifier
of the signature algorithm used to sign the CRL. This will be one of the OIDs from ~cryptography.x509.oid.SignatureAlgorithmOID
.
>>> crl.signature_algorithm_oid <ObjectIdentifier(oid=1.2.840.113549.1.1.11, name=sha256WithRSAEncryption)>
issuer
- type
Name
The Name
of the issuer.
>>> crl.issuer <Name(C=US,CN=cryptography.io)>
next_update
- type
datetime.datetime
A naïve datetime representing when the next update to this CRL is expected.
>>> crl.next_update datetime.datetime(2016, 1, 1, 0, 0)
last_update
- type
datetime.datetime
A naïve datetime representing when this CRL was last updated.
>>> crl.last_update datetime.datetime(2015, 1, 1, 0, 0)
extensions
- type
Extensions
The extensions encoded in the CRL.
signature
1.2
- type
bytes
The bytes of the CRL's signature.
tbs_certlist_bytes
1.2
- type
bytes
The DER encoded bytes payload (as defined by 5280
) that is hashed and then signed by the private key of the CRL's issuer. This data may be used to validate a signature, but use extreme caution as CRL validation is a complex problem that involves much more than just signature checks.
public_bytes(encoding)
1.2
- param encoding
The
~cryptography.hazmat.primitives.serialization.Encoding
that will be used to serialize the certificate revocation list.- return bytes
The data that can be written to a file or sent over the network and used as part of a certificate verification process.
is_signature_valid(public_key)
2.1
Warning
Checking the validity of the signature on the CRL is insufficient to know if the CRL should be trusted. More details are available in 5280
.
Returns True if the CRL signature is correct for given public key, False otherwise.
1.0
>>> from cryptography import x509 >>> from cryptography.hazmat.backends import default_backend >>> from cryptography.hazmat.primitives import hashes >>> from cryptography.hazmat.primitives.asymmetric import rsa >>> from cryptography.x509.oid import NameOID >>> import datetime >>> one_day = datetime.timedelta(1, 0, 0) >>> private_key = rsa.generate_private_key( ... public_exponent=65537, ... key_size=2048, ... backend=default_backend() ... ) >>> public_key = private_key.public_key() >>> builder = x509.CertificateBuilder() >>> builder = builder.subject_name(x509.Name([ ... x509.NameAttribute(NameOID.COMMON_NAME, u'cryptography.io'), ... ])) >>> builder = builder.issuer_name(x509.Name([ ... x509.NameAttribute(NameOID.COMMON_NAME, u'cryptography.io'), ... ])) >>> builder = builder.not_valid_before(datetime.datetime.today() - one_day) >>> builder = builder.not_valid_after(datetime.datetime.today() + (one_day * 30)) >>> builder = builder.serial_number(x509.random_serial_number()) >>> builder = builder.public_key(public_key) >>> builder = builder.add_extension( ... x509.SubjectAlternativeName( ... [x509.DNSName(u'cryptography.io')] ... ), ... critical=False ... ) >>> builder = builder.add_extension( ... x509.BasicConstraints(ca=False, path_length=None), critical=True, ... ) >>> certificate = builder.sign( ... private_key=private_key, algorithm=hashes.SHA256(), ... backend=default_backend() ... ) >>> isinstance(certificate, x509.Certificate) True
issuer_name(name)
Sets the issuer's distinguished name.
- param name
The
~cryptography.x509.Name
that describes the issuer (CA).
subject_name(name)
Sets the subject's distinguished name.
- param name
The
~cryptography.x509.Name
that describes the subject.
public_key(public_key)
Sets the subject's public key.
- param public_key
The subject's public key. This can be one of
~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey
,~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey
,~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey
,~cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PublicKey
or~cryptography.hazmat.primitives.asymmetric.ed448.Ed448PublicKey
.
serial_number(serial_number)
Sets the certificate's serial number (an integer). The CA's policy determines how it attributes serial numbers to certificates. This number must uniquely identify the certificate given the issuer. CABForum Guidelines require entropy in the serial number to provide protection against hash collision attacks. For more information on secure random number generation, see /random-numbers
.
- param serial_number
Integer number that will be used by the CA to identify this certificate (most notably during certificate revocation checking). Users should consider using
~cryptography.x509.random_serial_number
when possible.
not_valid_before(time)
Sets the certificate's activation time. This is the time from which clients can start trusting the certificate. It may be different from the time at which the certificate was created.
- param time
The
datetime.datetime
object (in UTC) that marks the activation time for the certificate. The certificate may not be trusted clients if it is used before this time.
not_valid_after(time)
Sets the certificate's expiration time. This is the time from which clients should no longer trust the certificate. The CA's policy will determine how long the certificate should remain in use.
- param time
The
datetime.datetime
object (in UTC) that marks the expiration time for the certificate. The certificate may not be trusted clients if it is used after this time.
add_extension(extension, critical)
Adds an X.509 extension to the certificate.
- param extension
An extension conforming to the
~cryptography.x509.ExtensionType
interface.- param critical
Set to
True
if the extension must be understood and handled by whoever reads the certificate.
sign(private_key, algorithm, backend=None)
Sign the certificate using the CA's private key.
- param private_key
The
~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateKey
,~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateKey
,~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePrivateKey
,~cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey
or~cryptography.hazmat.primitives.asymmetric.ed448.Ed448PrivateKey
that will be used to sign the certificate.- param algorithm
The
~cryptography.hazmat.primitives.hashes.HashAlgorithm
that will be used to generate the signature. This must beNone
if theprivate_key
is an~cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey
or an~cryptography.hazmat.primitives.asymmetric.ed448.Ed448PrivateKey
and an instance of a~cryptography.hazmat.primitives.hashes.HashAlgorithm
otherwise.- param backend
An optional backend used to build the certificate. Must support the
~cryptography.hazmat.backends.interfaces.X509Backend
interface.- returns
~cryptography.x509.Certificate
0.9
public_key()
The public key associated with the request.
- returns
One of
~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey
,~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey
,~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey
,~cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PublicKey
or~cryptography.hazmat.primitives.asymmetric.ed448.Ed448PublicKey
.
>>> from cryptography.hazmat.primitives.asymmetric import rsa >>> public_key = csr.public_key() >>> isinstance(public_key, rsa.RSAPublicKey) True
subject
- type
:class:Name
The Name
of the subject.
signature_hash_algorithm
- type
~cryptography.hazmat.primitives.hashes.HashAlgorithm
Returns the ~cryptography.hazmat.primitives.hashes.HashAlgorithm
which was used in signing this request. Can be None
if signature did not use separate hash (~cryptography.x509.oid.SignatureAlgorithmOID.ED25519
, ~cryptography.x509.oid.SignatureAlgorithmOID.ED448
).
>>> from cryptography.hazmat.primitives import hashes >>> isinstance(csr.signature_hash_algorithm, hashes.SHA256) True
signature_algorithm_oid
1.6
- type
ObjectIdentifier
Returns the ObjectIdentifier
of the signature algorithm used to sign the request. This will be one of the OIDs from ~cryptography.x509.oid.SignatureAlgorithmOID
.
>>> csr.signature_algorithm_oid <ObjectIdentifier(oid=1.2.840.113549.1.1.11, name=sha256WithRSAEncryption)>
extensions
- type
Extensions
The extensions encoded in the certificate signing request.
- raises cryptography.x509.DuplicateExtension
If more than one extension of the same type is found within the certificate signing request.
- raises cryptography.x509.UnsupportedGeneralNameType
If an extension contains a general name that is not supported.
get_attribute_for_oid(oid)
3.0
- param oid
An
ObjectIdentifier
instance.- returns
The bytes value of the attribute or an exception if not found.
- raises cryptography.x509.AttributeNotFound
If the request does not have the attribute requested.
public_bytes(encoding)
1.0
- param encoding
The
~cryptography.hazmat.primitives.serialization.Encoding
that will be used to serialize the certificate request.- return bytes
The data that can be written to a file or sent over the network to be signed by the certificate authority.
signature
1.2
- type
bytes
The bytes of the certificate signing request's signature.
tbs_certrequest_bytes
1.2
- type
bytes
The DER encoded bytes payload (as defined by 2986
) that is hashed and then signed by the private key (corresponding to the public key embedded in the CSR). This data may be used to validate the CSR signature.
is_signature_valid
1.3
Returns True if the CSR signature is correct, False otherwise.
1.2
>>> from cryptography import x509 >>> from cryptography.hazmat.backends import default_backend >>> from cryptography.hazmat.primitives import hashes >>> from cryptography.hazmat.primitives.asymmetric import rsa >>> from cryptography.x509.oid import NameOID >>> import datetime >>> one_day = datetime.timedelta(1, 0, 0) >>> private_key = rsa.generate_private_key( ... public_exponent=65537, ... key_size=2048, ... backend=default_backend() ... ) >>> builder = x509.CertificateRevocationListBuilder() >>> builder = builder.issuer_name(x509.Name([ ... x509.NameAttribute(NameOID.COMMON_NAME, u'cryptography.io CA'), ... ])) >>> builder = builder.last_update(datetime.datetime.today()) >>> builder = builder.next_update(datetime.datetime.today() + one_day) >>> revoked_cert = x509.RevokedCertificateBuilder().serial_number( ... 333 ... ).revocation_date( ... datetime.datetime.today() ... ).build(default_backend()) >>> builder = builder.add_revoked_certificate(revoked_cert) >>> crl = builder.sign( ... private_key=private_key, algorithm=hashes.SHA256(), ... backend=default_backend() ... ) >>> len(crl) 1
issuer_name(name)
Sets the issuer's distinguished name.
- param name
The
~cryptography.x509.Name
that describes the issuer (CA).
last_update(time)
Sets this CRL's activation time. This is the time from which clients can start trusting this CRL. It may be different from the time at which this CRL was created. This is also known as the thisUpdate
time.
- param time
The
datetime.datetime
object (in UTC) that marks the activation time for this CRL. The CRL may not be trusted if it is used before this time.
next_update(time)
Sets this CRL's next update time. This is the time by which a new CRL will be issued. The CA is allowed to issue a new CRL before this date, however clients are not required to check for it.
- param time
The
datetime.datetime
object (in UTC) that marks the next update time for this CRL.
add_extension(extension, critical)
Adds an X.509 extension to this CRL.
- param extension
An extension with the
~cryptography.x509.ExtensionType
interface.- param critical
Set to
True
if the extension must be understood and handled by whoever reads the CRL.
add_revoked_certificate(revoked_certificate)
Adds a revoked certificate to this CRL.
- param revoked_certificate
An instance of
~cryptography.x509.RevokedCertificate
. These can be obtained from an existing CRL or created with~cryptography.x509.RevokedCertificateBuilder
.
sign(private_key, algorithm, backend=None)
Sign this CRL using the CA's private key.
- param private_key
The
~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateKey
,~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateKey
,~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePrivateKey
,~cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey
or~cryptography.hazmat.primitives.asymmetric.ed448.Ed448PrivateKey
that will be used to sign the certificate.- param algorithm
The
~cryptography.hazmat.primitives.hashes.HashAlgorithm
that will be used to generate the signature. This must beNone
if theprivate_key
is an~cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey
or an~cryptography.hazmat.primitives.asymmetric.ed448.Ed448PrivateKey
and an instance of a~cryptography.hazmat.primitives.hashes.HashAlgorithm
otherwise.- param backend
An optional backend used to build the CRL. Must support the
~cryptography.hazmat.backends.interfaces.X509Backend
interface.- returns
~cryptography.x509.CertificateRevocationList
1.0
serial_number
- type
int
An integer representing the serial number of the revoked certificate.
>>> revoked_certificate.serial_number 0
revocation_date
- type
datetime.datetime
A naïve datetime representing the date this certificates was revoked.
>>> revoked_certificate.revocation_date datetime.datetime(2015, 1, 1, 0, 0)
extensions
- type
Extensions
The extensions encoded in the revoked certificate.
>>> for ext in revoked_certificate.extensions: ... print(ext) <Extension(oid=<ObjectIdentifier(oid=2.5.29.24, name=invalidityDate)>, critical=False, value=<InvalidityDate(invalidity_date=2015-01-01 00:00:00)>)> <Extension(oid=<ObjectIdentifier(oid=2.5.29.21, name=cRLReason)>, critical=False, value=<CRLReason(reason=ReasonFlags.key_compromise)>)>
This class is used to create ~cryptography.x509.RevokedCertificate
objects that can be used with the ~cryptography.x509.CertificateRevocationListBuilder
.
1.2
>>> from cryptography import x509 >>> from cryptography.hazmat.backends import default_backend >>> import datetime >>> builder = x509.RevokedCertificateBuilder() >>> builder = builder.revocation_date(datetime.datetime.today()) >>> builder = builder.serial_number(3333) >>> revoked_certificate = builder.build(default_backend()) >>> isinstance(revoked_certificate, x509.RevokedCertificate) True
serial_number(serial_number)
Sets the revoked certificate's serial number.
- param serial_number
Integer number that is used to identify the revoked certificate.
revocation_date(time)
Sets the certificate's revocation date.
- param time
The
datetime.datetime
object (in UTC) that marks the revocation time for the certificate.
add_extension(extension, critical)
Adds an X.509 extension to this revoked certificate.
- param extension
An instance of one of the
CRL entry extensions <crl_entry_extensions>
.- param critical
Set to
True
if the extension must be understood and handled.
build(backend=None)
Create a revoked certificate object using the provided backend.
- param backend
An optional backend used to build the revoked certificate. Must support the
~cryptography.hazmat.backends.interfaces.X509Backend
interface.- returns
~cryptography.x509.RevokedCertificate
1.0
>>> from cryptography import x509 >>> from cryptography.hazmat.backends import default_backend >>> from cryptography.hazmat.primitives import hashes >>> from cryptography.hazmat.primitives.asymmetric import rsa >>> from cryptography.x509.oid import AttributeOID, NameOID >>> private_key = rsa.generate_private_key( ... public_exponent=65537, ... key_size=2048, ... backend=default_backend() ... ) >>> builder = x509.CertificateSigningRequestBuilder() >>> builder = builder.subject_name(x509.Name([ ... x509.NameAttribute(NameOID.COMMON_NAME, u'cryptography.io'), ... ])) >>> builder = builder.add_extension( ... x509.BasicConstraints(ca=False, path_length=None), critical=True, ... ) >>> builder = builder.add_attribute( ... AttributeOID.CHALLENGE_PASSWORD, b"changeit" ... ) >>> request = builder.sign( ... private_key, hashes.SHA256(), default_backend() ... ) >>> isinstance(request, x509.CertificateSigningRequest) True
subject_name(name)
- param name
The
~cryptography.x509.Name
of the certificate subject.- returns
A new
~cryptography.x509.CertificateSigningRequestBuilder
.
add_extension(extension, critical)
- param extension
An extension conforming to the
~cryptography.x509.ExtensionType
interface.- param critical
Set to True if the extension must be understood and handled by whoever reads the certificate.
- returns
A new
~cryptography.x509.CertificateSigningRequestBuilder
.
add_attribute(oid, value)
3.0
- param oid
An
ObjectIdentifier
instance.- param value
The value of the attribute.
- type value
bytes
- returns
A new
~cryptography.x509.CertificateSigningRequestBuilder
.
sign(private_key, algorithm, backend=None)
- param backend
An optional backend used to sign the request. Must support the
~cryptography.hazmat.backends.interfaces.X509Backend
interface.- param private_key
The
~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateKey
,~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateKey
,~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePrivateKey
,~cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey
or~cryptography.hazmat.primitives.asymmetric.ed448.Ed448PrivateKey
that will be used to sign the request. When the request is signed by a certificate authority, the private key's associated public key will be stored in the resulting certificate.- param algorithm
The
~cryptography.hazmat.primitives.hashes.HashAlgorithm
that will be used to generate the request signature. This must beNone
if theprivate_key
is an~cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey
or an~cryptography.hazmat.primitives.asymmetric.ed448.Ed448PrivateKey
and an instance of a~cryptography.hazmat.primitives.hashes.HashAlgorithm
otherwise.- returns
A new
~cryptography.x509.CertificateSigningRequest
.
0.8
An X509 Name is an ordered list of attributes. The object is iterable to get every attribute or you can use Name.get_attributes_for_oid
to obtain the specific type you want. Names are sometimes represented as a slash or comma delimited string (e.g. /CN=mydomain.com/O=My Org/C=US
or CN=mydomain.com,O=My Org,C=US
).
Technically, a Name is a list of sets of attributes, called Relative Distinguished Names or RDNs, although multi-valued RDNs are rarely encountered. The iteration order of values within a multi-valued RDN is preserved. If you need to handle multi-valued RDNs, the rdns
property gives access to an ordered list of RelativeDistinguishedName
objects.
A Name can be initialized with an iterable of NameAttribute
(the common case where each RDN has a single attribute) or an iterable of RelativeDistinguishedName
objects (in the rare case of multi-valued RDNs).
>>> len(cert.subject) 3 >>> for attribute in cert.subject: ... print(attribute) <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.6, name=countryName)>, value='US')> <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.10, name=organizationName)>, value='Test Certificates 2011')> <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.3, name=commonName)>, value='Good CA')>
rdns
1.6
- type
list of
RelativeDistinguishedName
get_attributes_for_oid(oid)
- param oid
An
ObjectIdentifier
instance.- returns
A list of
NameAttribute
instances that match the OID provided. If nothing matches an empty list will be returned.
>>> cert.subject.get_attributes_for_oid(NameOID.COMMON_NAME) [<NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.3, name=commonName)>, value='Good CA')>]
public_bytes(backend=None)
1.6
- param backend
An optional backend supporting the
~cryptography.hazmat.backends.interfaces.X509Backend
interface.- return bytes
The DER encoded name.
rfc4514_string()
2.5
- return str
Format the given name as a
4514
Distinguished Name string, for exampleCN=mydomain.com,O=My Org,C=US
.
0.7
An enumeration for X.509 versions.
v1
For version 1 X.509 certificates.
v3
For version 3 X.509 certificates.
0.8
An X.509 name consists of a list of RelativeDistinguishedName
instances, which consist of a set of NameAttribute
instances.
oid
- type
ObjectIdentifier
The attribute OID.
value
- type
text
The value of the attribute.
rfc4514_string()
2.5
- return str
Format the given attribute as a
4514
Distinguished Name string.
1.6
A relative distinguished name is a non-empty set of name attributes. The object is iterable to get every attribute, preserving the original order. Passing duplicate attributes to the constructor raises ValueError
.
get_attributes_for_oid(oid)
- param oid
An
ObjectIdentifier
instance.- returns
A list of
NameAttribute
instances that match the OID provided. The list should contain zero or one values.
rfc4514_string()
2.5
- return str
Format the given RDN set as a
4514
Distinguished Name string.
0.8
Object identifiers (frequently seen abbreviated as OID) identify the type of a value (see: NameAttribute
).
dotted_string
- type
str
The dotted string value of the OID (e.g. "2.5.4.3"
)
0.9
This is the generic interface that all the following classes are registered against.
0.9
3.1
U-label
support has been removed. Encode them to A-label
before use.
This corresponds to an email address. For example, user@example.com
.
- param value
The email address. If the address contains an internationalized domain name then it must be encoded to an
A-label
string before being passed.- raises ValueError
If the provided string is not an
A-label
.
value
- type
text
0.9
3.1
U-label
support has been removed. Encode them to A-label
before use.
This corresponds to a domain name. For example, cryptography.io
.
- param value
The domain name. If it is an internationalized domain name then it must be encoded to an
A-label
string before being passed.- raises ValueError
If the provided string is not an
A-label
.- type
text
value
- type
text
0.9
This corresponds to a directory name.
value
- type
Name
0.9
3.1
U-label
support has been removed. Encode them to A-label
before use.
This corresponds to a uniform resource identifier. For example, https://cryptography.io
.
- param value
The URI. If it contains an internationalized domain name then it must be encoded to an
A-label
string before being passed.- raises ValueError
If the provided string is not an
A-label
.
value
- type
text
0.9
This corresponds to an IP address.
value
- type
~ipaddress.IPv4Address
,~ipaddress.IPv6Address
,~ipaddress.IPv4Network
, or~ipaddress.IPv6Network
.
0.9
This corresponds to a registered ID.
value
- type
ObjectIdentifier
1.0
This corresponds to an otherName.
An otherName
has a type identifier and a value represented in binary DER format.
type_id
- type
:class:ObjectIdentifier
value
- type
bytes
0.9
An X.509 Extensions instance is an ordered list of extensions. The object is iterable to get every extension.
get_extension_for_oid(oid)
- param oid
An
ObjectIdentifier
instance.- returns
An instance of the extension class.
- raises cryptography.x509.ExtensionNotFound
If the certificate does not have the extension requested.
>>> from cryptography.x509.oid import ExtensionOID >>> cert.extensions.get_extension_for_oid(ExtensionOID.BASIC_CONSTRAINTS) <Extension(oid=<ObjectIdentifier(oid=2.5.29.19, name=basicConstraints)>, critical=True, value=<BasicConstraints(ca=True, path_length=None)>)>
get_extension_for_class(extclass)
1.1
- param extclass
An extension class.
- returns
An instance of the extension class.
- raises cryptography.x509.ExtensionNotFound
If the certificate does not have the extension requested.
>>> from cryptography import x509 >>> cert.extensions.get_extension_for_class(x509.BasicConstraints) <Extension(oid=<ObjectIdentifier(oid=2.5.29.19, name=basicConstraints)>, critical=True, value=<BasicConstraints(ca=True, path_length=None)>)>
0.9
oid
- type
ObjectIdentifier
One of the ~cryptography.x509.oid.ExtensionOID
OIDs.
critical
- type
bool
Determines whether a given extension is critical or not. 5280
requires that "A certificate-using system MUST reject the certificate if it encounters a critical extension it does not recognize or a critical extension that contains information that it cannot process".
value
Returns an instance of the extension type corresponding to the OID.
1.0
This is the interface against which all the following extension types are registered.
0.9
The key usage extension defines the purpose of the key contained in the certificate. The usage restriction might be employed when a key that could be used for more than one operation is to be restricted.
oid
1.0
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.KEY_USAGE
.
digital_signature
- type
bool
This purpose is set to true when the subject public key is used for verifying digital signatures, other than signatures on certificates (key_cert_sign
) and CRLs (crl_sign
).
content_commitment
- type
bool
This purpose is set to true when the subject public key is used for verifying digital signatures, other than signatures on certificates (key_cert_sign
) and CRLs (crl_sign
). It is used to provide a non-repudiation service that protects against the signing entity falsely denying some action. In the case of later conflict, a reliable third party may determine the authenticity of the signed data. This was called non_repudiation
in older revisions of the X.509 specification.
key_encipherment
- type
bool
This purpose is set to true when the subject public key is used for enciphering private or secret keys.
data_encipherment
- type
bool
This purpose is set to true when the subject public key is used for directly enciphering raw user data without the use of an intermediate symmetric cipher.
key_agreement
- type
bool
This purpose is set to true when the subject public key is used for key agreement. For example, when a Diffie-Hellman key is to be used for key management, then this purpose is set to true.
key_cert_sign
- type
bool
This purpose is set to true when the subject public key is used for verifying signatures on public key certificates. If this purpose is set to true then ca
must be true in the BasicConstraints
extension.
crl_sign
- type
bool
This purpose is set to true when the subject public key is used for verifying signatures on certificate revocation lists.
encipher_only
- type
bool
When this purposes is set to true and the key_agreement
purpose is also set, the subject public key may be used only for enciphering data while performing key agreement.
- raises ValueError
This is raised if accessed when
key_agreement
is false.
decipher_only
- type
bool
When this purposes is set to true and the key_agreement
purpose is also set, the subject public key may be used only for deciphering data while performing key agreement.
- raises ValueError
This is raised if accessed when
key_agreement
is false.
0.9
Basic constraints is an X.509 extension type that defines whether a given certificate is allowed to sign additional certificates and what path length restrictions may exist.
oid
1.0
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.BASIC_CONSTRAINTS
.
ca
- type
bool
Whether the certificate can sign certificates.
path_length
- type
int or None
The maximum path length for certificates subordinate to this certificate. This attribute only has meaning if ca
is true. If ca
is true then a path length of None means there's no restriction on the number of subordinate CAs in the certificate chain. If it is zero or greater then it defines the maximum length for a subordinate CA's certificate chain. For example, a path_length
of 1 means the certificate can sign a subordinate CA, but the subordinate CA is not allowed to create subordinates with ca
set to true.
0.9
This extension indicates one or more purposes for which the certified public key may be used, in addition to or in place of the basic purposes indicated in the key usage extension. The object is iterable to obtain the list of ~cryptography.x509.oid.ExtendedKeyUsageOID
OIDs present.
- param list usages
A list of
~cryptography.x509.oid.ExtendedKeyUsageOID
OIDs.
oid
1.0
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.EXTENDED_KEY_USAGE
.
1.0
This presence of this extension indicates that an OCSP client can trust a responder for the lifetime of the responder's certificate. CAs issuing such a certificate should realize that a compromise of the responder's key is as serious as the compromise of a CA key used to sign CRLs, at least for the validity period of this certificate. CA's may choose to issue this type of certificate with a very short lifetime and renew it frequently. This extension is only relevant when the certificate is an authorized OCSP responder.
oid
1.0
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.OCSP_NO_CHECK
.
2.1
The TLS Feature extension is defined in 7633
and is used in certificates for OCSP Must-Staple. The object is iterable to get every element.
- param list features
A list of features to enable from the
~cryptography.x509.TLSFeatureType
enum. At this time onlystatus_request
orstatus_request_v2
are allowed.
oid
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.TLS_FEATURE
.
2.1
An enumeration of TLS Feature types.
status_request
This feature type is defined in 6066
and, when embedded in an X.509 certificate, signals to the client that it should require a stapled OCSP response in the TLS handshake. Commonly known as OCSP Must-Staple in certificates.
status_request_v2
This feature type is defined in 6961
. This value is not commonly used and if you want to enable OCSP Must-Staple you should use status_request
.
1.0
The name constraints extension, which only has meaning in a CA certificate, defines a name space within which all subject names in certificates issued beneath the CA certificate must (or must not) be in. For specific details on the way this extension should be processed see 5280
.
oid
1.0
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.NAME_CONSTRAINTS
.
permitted_subtrees
- type
list of
GeneralName
objects or None
The set of permitted name patterns. If a name matches this and an element in excluded_subtrees
it is invalid. At least one of permitted_subtrees
and excluded_subtrees
will be non-None.
excluded_subtrees
- type
list of
GeneralName
objects or None
Any name matching a restriction in the excluded_subtrees
field is invalid regardless of information appearing in the permitted_subtrees
. At least one of permitted_subtrees
and excluded_subtrees
will be non-None.
0.9
The authority key identifier extension provides a means of identifying the public key corresponding to the private key used to sign a certificate. This extension is typically used to assist in determining the appropriate certificate chain. For more information about generation and use of this extension see RFC 5280 section 4.2.1.1.
oid
1.0
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.AUTHORITY_KEY_IDENTIFIER
.
key_identifier
- type
bytes
A value derived from the public key used to verify the certificate's signature.
authority_cert_issuer
- type
A list of
GeneralName
instances or None
The GeneralName
(one or multiple) of the issuer's issuer.
authority_cert_serial_number
- type
int or None
The serial number of the issuer's issuer.
from_issuer_public_key(public_key)
1.0
Note
This method should be used if the issuer certificate does not contain a ~cryptography.x509.SubjectKeyIdentifier
. Otherwise, use ~cryptography.x509.AuthorityKeyIdentifier.from_issuer_subject_key_identifier
.
Creates a new AuthorityKeyIdentifier instance using the public key provided to generate the appropriate digest. This should be the issuer's public key. The resulting object will contain ~cryptography.x509.AuthorityKeyIdentifier.key_identifier
, but ~cryptography.x509.AuthorityKeyIdentifier.authority_cert_issuer
and ~cryptography.x509.AuthorityKeyIdentifier.authority_cert_serial_number
will be None. The generated key_identifier
is the SHA1 hash of the subjectPublicKey
ASN.1 bit string. This is the first recommendation in 5280
section 4.2.1.2.
- param public_key
One of
~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey
,~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey
,~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey
,~cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PublicKey
or~cryptography.hazmat.primitives.asymmetric.ed448.Ed448PublicKey
.
>>> from cryptography import x509 >>> from cryptography.hazmat.backends import default_backend >>> issuer_cert = x509.load_pem_x509_certificate(pem_data, default_backend()) >>> x509.AuthorityKeyIdentifier.from_issuer_public_key(issuer_cert.public_key()) <AuthorityKeyIdentifier(key_identifier=b'Xx01x84$x1bxbc+Rx94J=xa5x10rx14Qxf5xaf:xc9', authority_cert_issuer=None, authority_cert_serial_number=None)>
from_issuer_subject_key_identifier(ski)
1.3
Note
This method should be used if the issuer certificate contains a ~cryptography.x509.SubjectKeyIdentifier
. Otherwise, use ~cryptography.x509.AuthorityKeyIdentifier.from_issuer_public_key
.
Creates a new AuthorityKeyIdentifier instance using the SubjectKeyIdentifier from the issuer certificate. The resulting object will contain ~cryptography.x509.AuthorityKeyIdentifier.key_identifier
, but ~cryptography.x509.AuthorityKeyIdentifier.authority_cert_issuer
and ~cryptography.x509.AuthorityKeyIdentifier.authority_cert_serial_number
will be None.
- param ski
The
~cryptography.x509.SubjectKeyIdentifier
from the issuer certificate.
>>> from cryptography import x509 >>> from cryptography.hazmat.backends import default_backend >>> issuer_cert = x509.load_pem_x509_certificate(pem_data, default_backend()) >>> ski_ext = issuer_cert.extensions.get_extension_for_class(x509.SubjectKeyIdentifier) >>> x509.AuthorityKeyIdentifier.from_issuer_subject_key_identifier(ski_ext.value) <AuthorityKeyIdentifier(key_identifier=b'Xx01x84$x1bxbc+Rx94J=xa5x10rx14Qxf5xaf:xc9', authority_cert_issuer=None, authority_cert_serial_number=None)>
0.9
The subject key identifier extension provides a means of identifying certificates that contain a particular public key.
oid
1.0
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.SUBJECT_KEY_IDENTIFIER
.
digest
- type
bytes
The binary value of the identifier.
from_public_key(public_key)
1.0
Creates a new SubjectKeyIdentifier instance using the public key provided to generate the appropriate digest. This should be the public key that is in the certificate. The generated digest is the SHA1 hash of the subjectPublicKey
ASN.1 bit string. This is the first recommendation in 5280
section 4.2.1.2.
- param public_key
One of
~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey
,~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey
,~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey
,~cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PublicKey
or~cryptography.hazmat.primitives.asymmetric.ed448.Ed448PublicKey
.
>>> from cryptography import x509 >>> from cryptography.hazmat.backends import default_backend >>> csr = x509.load_pem_x509_csr(pem_req_data, default_backend()) >>> x509.SubjectKeyIdentifier.from_public_key(csr.public_key()) <SubjectKeyIdentifier(digest=b'x8c"x98xe2xb5xbf]xe8*2xf8xd2'?x00xd2xc7#xe4c')>
0.9
Subject alternative name is an X.509 extension that provides a list of general name <general_name_classes>
instances that provide a set of identities for which the certificate is valid. The object is iterable to get every element.
- param list general_names
A list of
GeneralName
instances.
oid
1.0
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.SUBJECT_ALTERNATIVE_NAME
.
get_values_for_type(type)
- param type
A
GeneralName
instance. This is one of thegeneral name classes <general_name_classes>
.- returns
A list of values extracted from the matched general names. The type of the returned values depends on the
GeneralName
.
>>> from cryptography import x509 >>> from cryptography.hazmat.backends import default_backend >>> from cryptography.hazmat.primitives import hashes >>> cert = x509.load_pem_x509_certificate(cryptography_cert_pem, default_backend()) >>> # Get the subjectAltName extension from the certificate >>> ext = cert.extensions.get_extension_for_oid(ExtensionOID.SUBJECT_ALTERNATIVE_NAME) >>> # Get the dNSName entries from the SAN extension >>> ext.value.get_values_for_type(x509.DNSName) ['www.cryptography.io', 'cryptography.io']
1.0
Issuer alternative name is an X.509 extension that provides a list of general name <general_name_classes>
instances that provide a set of identities for the certificate issuer. The object is iterable to get every element.
- param list general_names
A list of
GeneralName
instances.
oid
1.0
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.ISSUER_ALTERNATIVE_NAME
.
get_values_for_type(type)
- param type
A
GeneralName
instance. This is one of thegeneral name classes <general_name_classes>
.- returns
A list of values extracted from the matched general names.
2.0
This extension contains ~cryptography.x509.certificate_transparency.SignedCertificateTimestamp
instances which were issued for the pre-certificate corresponding to this certificate. These can be used to verify that the certificate is included in a public Certificate Transparency log.
It is an iterable containing one or more ~cryptography.x509.certificate_transparency.SignedCertificateTimestamp
objects.
- param list scts
A
list
of~cryptography.x509.certificate_transparency.SignedCertificateTimestamp
objects.
oid
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.PRECERT_SIGNED_CERTIFICATE_TIMESTAMPS
.
2.4
This extension indicates that the certificate should not be treated as a certificate for the purposes of validation, but is instead for submission to a certificate transparency log in order to obtain SCTs which will be embedded in a PrecertificateSignedCertificateTimestamps
extension on the final certificate.
oid
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.PRECERT_POISON
.
3.0
This extension contains ~cryptography.x509.certificate_transparency.SignedCertificateTimestamp
instances. These can be used to verify that the certificate is included in a public Certificate Transparency log. This extension is only found in OCSP responses. For SCTs in an X.509 certificate see ~cryptography.x509.PrecertificateSignedCertificateTimestamps
.
It is an iterable containing one or more ~cryptography.x509.certificate_transparency.SignedCertificateTimestamp
objects.
- param list scts
A
list
of~cryptography.x509.certificate_transparency.SignedCertificateTimestamp
objects.
oid
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.SIGNED_CERTIFICATE_TIMESTAMPS
.
2.1
The delta CRL indicator is a CRL extension that identifies a CRL as being a delta CRL. Delta CRLs contain updates to revocation information previously distributed, rather than all the information that would appear in a complete CRL.
- param int crl_number
The CRL number of the complete CRL that the delta CRL is updating.
oid
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.DELTA_CRL_INDICATOR
.
crl_number
- type
int
0.9
The authority information access extension indicates how to access information and services for the issuer of the certificate in which the extension appears. Information and services may include online validation services (such as OCSP) and issuer data. It is an iterable, containing one or more ~cryptography.x509.AccessDescription
instances.
- param list descriptions
A list of
AccessDescription
objects.
oid
1.0
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.AUTHORITY_INFORMATION_ACCESS
.
3.0
The subject information access extension indicates how to access information and services for the subject of the certificate in which the extension appears. When the subject is a CA, information and services may include certificate validation services and CA policy data. When the subject is an end entity, the information describes the type of services offered and how to access them. It is an iterable, containing one or more ~cryptography.x509.AccessDescription
instances.
- param list descriptions
A list of
AccessDescription
objects.
oid
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.SUBJECT_INFORMATION_ACCESS
.
0.9
access_method
- type
ObjectIdentifier
The access method defines what the access_location
means. It must be ~cryptography.x509.oid.AuthorityInformationAccessOID.OCSP
or ~cryptography.x509.oid.AuthorityInformationAccessOID.CA_ISSUERS
when used with ~cryptography.x509.AuthorityInformationAccess
or ~cryptography.x509.oid.SubjectInformationAccessOID.CA_REPOSITORY
when used with ~cryptography.x509.SubjectInformationAccess
.
If it is ~cryptography.x509.oid.AuthorityInformationAccessOID.OCSP
the access location will be where to obtain OCSP information for the certificate. If it is ~cryptography.x509.oid.AuthorityInformationAccessOID.CA_ISSUERS
the access location will provide additional information about the issuing certificate. Finally, if it is ~cryptography.x509.oid.SubjectInformationAccessOID.CA_REPOSITORY
the access location will be the location of the CA's repository.
access_location
- type
GeneralName
Where to access the information defined by the access method.
2.1
The freshest CRL extension (also known as Delta CRL Distribution Point) identifies how delta CRL information is obtained. It is an iterable, containing one or more DistributionPoint
instances.
- param list distribution_points
A list of
DistributionPoint
instances.
oid
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.FRESHEST_CRL
.
0.9
The CRL distribution points extension identifies how CRL information is obtained. It is an iterable, containing one or more DistributionPoint
instances.
- param list distribution_points
A list of
DistributionPoint
instances.
oid
1.0
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.CRL_DISTRIBUTION_POINTS
.
0.9
full_name
- type
list of
GeneralName
instances or None
This field describes methods to retrieve the CRL. At most one of full_name
or relative_name
will be non-None.
relative_name
- type
RelativeDistinguishedName
or None
This field describes methods to retrieve the CRL relative to the CRL issuer. At most one of full_name
or relative_name
will be non-None.
1.6 Changed from Name
to RelativeDistinguishedName
.
crl_issuer
- type
list of
GeneralName
instances or None
Information about the issuer of the CRL.
reasons
- type
frozenset of
ReasonFlags
or None
The reasons a given distribution point may be used for when performing revocation checks.
0.9
An enumeration for CRL reasons.
unspecified
It is unspecified why the certificate was revoked. This reason cannot be used as a reason flag in a DistributionPoint
.
key_compromise
This reason indicates that the private key was compromised.
ca_compromise
This reason indicates that the CA issuing the certificate was compromised.
affiliation_changed
This reason indicates that the subject's name or other information has changed.
superseded
This reason indicates that a certificate has been superseded.
cessation_of_operation
This reason indicates that the certificate is no longer required.
certificate_hold
This reason indicates that the certificate is on hold.
privilege_withdrawn
This reason indicates that the privilege granted by this certificate have been withdrawn.
aa_compromise
When an attribute authority has been compromised.
remove_from_crl
This reason indicates that the certificate was on hold and should be removed from the CRL. This reason cannot be used as a reason flag in a DistributionPoint
.
1.0
The inhibit anyPolicy
extension indicates that the special OID ~cryptography.x509.oid.CertificatePoliciesOID.ANY_POLICY
, is not considered an explicit match for other CertificatePolicies
except when it appears in an intermediate self-issued CA certificate. The value indicates the number of additional non-self-issued certificates that may appear in the path before ~cryptography.x509.oid.CertificatePoliciesOID.ANY_POLICY
is no longer permitted. For example, a value of one indicates that ~cryptography.x509.oid.CertificatePoliciesOID.ANY_POLICY
may be processed in certificates issued by the subject of this certificate, but not in additional certificates in the path.
oid
1.0
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.INHIBIT_ANY_POLICY
.
skip_certs
- type
int
1.3
The policy constraints extension is used to inhibit policy mapping or require that each certificate in a chain contain an acceptable policy identifier. For more information about the use of this extension see 5280
.
oid
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.POLICY_CONSTRAINTS
.
require_explicit_policy
- type
int or None
If this field is not None, the value indicates the number of additional certificates that may appear in the chain before an explicit policy is required for the entire path. When an explicit policy is required, it is necessary for all certificates in the chain to contain an acceptable policy identifier in the certificate policies extension. An acceptable policy identifier is the identifier of a policy required by the user of the certification path or the identifier of a policy that has been declared equivalent through policy mapping.
inhibit_policy_mapping
- type
int or None
If this field is not None, the value indicates the number of additional certificates that may appear in the chain before policy mapping is no longer permitted. For example, a value of one indicates that policy mapping may be processed in certificates issued by the subject of this certificate, but not in additional certificates in the chain.
1.2
The CRL number is a CRL extension that conveys a monotonically increasing sequence number for a given CRL scope and CRL issuer. This extension allows users to easily determine when a particular CRL supersedes another CRL. 5280
requires that this extension be present in conforming CRLs.
oid
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.CRL_NUMBER
.
crl_number
- type
int
2.5
Issuing distribution point is a CRL extension that identifies the CRL distribution point and scope for a particular CRL. It indicates whether the CRL covers revocation for end entity certificates only, CA certificates only, attribute certificates only, or a limited set of reason codes. For specific details on the way this extension should be processed see 5280
.
oid
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.ISSUING_DISTRIBUTION_POINT
.
only_contains_user_certs
- type
bool
Set to True
if the CRL this extension is embedded within only contains information about user certificates.
only_contains_ca_certs
- type
bool
Set to True
if the CRL this extension is embedded within only contains information about CA certificates.
indirect_crl
- type
bool
Set to True
if the CRL this extension is embedded within includes certificates issued by one or more authorities other than the CRL issuer.
only_contains_attribute_certs
- type
bool
Set to True
if the CRL this extension is embedded within only contains information about attribute certificates.
only_some_reasons
- type
frozenset of
ReasonFlags
or None
The reasons for which the issuing distribution point is valid. None indicates that it is valid for all reasons.
full_name
- type
list of
GeneralName
instances or None
This field describes methods to retrieve the CRL. At most one of full_name
or relative_name
will be non-None.
relative_name
- type
RelativeDistinguishedName
or None
This field describes methods to retrieve the CRL relative to the CRL issuer. At most one of full_name
or relative_name
will be non-None.
1.2
A generic extension class used to hold the raw value of extensions that cryptography
does not know how to parse. This can also be used when creating new certificates, CRLs, or OCSP requests and responses to encode extensions that cryptography
does not know how to generate.
oid
- type
ObjectIdentifier
Returns the OID associated with this extension.
value
- type
bytes
Returns the DER encoded bytes payload of the extension.
0.9
The certificate policies extension is an iterable, containing one or more PolicyInformation
instances.
- param list policies
A list of
PolicyInformation
instances.
As an example of how CertificatePolicies
might be used, if you wanted to check if a certificated contained the CAB Forum's "domain-validated" policy, you might write code like:
def contains_domain_validated(policies):
return any(
policy.oid.dotted_string == "2.23.140.1.2.1"
for policy in policies
)
oid
1.0
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.ExtensionOID.CERTIFICATE_POLICIES
.
These classes may be present within a CertificatePolicies
instance.
0.9
Contains a policy identifier and an optional list of qualifiers.
policy_identifier
- type
ObjectIdentifier
policy_qualifiers
- type
list
A list consisting of text
and/or UserNotice
objects. If the value is text it is a pointer to the practice statement published by the certificate authority. If it is a user notice it is meant for display to the relying party when the certificate is used.
0.9
User notices are intended for display to a relying party when a certificate is used. In practice, few if any UIs expose this data and it is a rarely encoded component.
notice_reference
- type
NoticeReference
or None
The notice reference field names an organization and identifies, by number, a particular statement prepared by that organization.
explicit_text
This field includes an arbitrary textual statement directly in the certificate.
- type
text
Notice reference can name an organization and provide information about notices related to the certificate. For example, it might identify the organization name and notice number 1. Application software could have a notice file containing the current set of notices for the named organization; the application would then extract the notice text from the file and display it. In practice this is rarely seen.
0.9
organization
- type
text
notice_numbers
- type
list
A list of integers.
These extensions are only valid within a RevokedCertificate
object.
1.2
The certificate issuer is an extension that is only valid inside ~cryptography.x509.RevokedCertificate
objects. If the indirectCRL
property of the parent CRL's IssuingDistributionPoint extension is set, then this extension identifies the certificate issuer associated with the revoked certificate. The object is iterable to get every element.
- param list general_names
A list of
GeneralName
instances.
oid
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.CRLEntryExtensionOID.CERTIFICATE_ISSUER
.
get_values_for_type(type)
- param type
A
GeneralName
instance. This is one of thegeneral name classes <general_name_classes>
.- returns
A list of values extracted from the matched general names. The type of the returned values depends on the
GeneralName
.
1.2
CRL reason (also known as reasonCode
) is an extension that is only valid inside ~cryptography.x509.RevokedCertificate
objects. It identifies a reason for the certificate revocation.
- param reason
An element from
~cryptography.x509.ReasonFlags
.
oid
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.CRLEntryExtensionOID.CRL_REASON
.
reason
- type
An element from
~cryptography.x509.ReasonFlags
1.2
Invalidity date is an extension that is only valid inside ~cryptography.x509.RevokedCertificate
objects. It provides the date on which it is known or suspected that the private key was compromised or that the certificate otherwise became invalid. This date may be earlier than the revocation date in the CRL entry, which is the date at which the CA processed the revocation.
- param invalidity_date
The
datetime.datetime
when it is known or suspected that the private key was compromised.
oid
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.CRLEntryExtensionOID.INVALIDITY_DATE
.
invalidity_date
- type
datetime.datetime
2.4
OCSP nonce is an extension that is only valid inside ~cryptography.x509.ocsp.OCSPRequest
and ~cryptography.x509.ocsp.OCSPResponse
objects. The nonce cryptographically binds a request and a response to prevent replay attacks. In practice nonces are rarely used in OCSP due to the desire to precompute OCSP responses at large scale.
oid
- type
ObjectIdentifier
Returns ~cryptography.x509.oid.OCSPExtensionOID.NONCE
.
nonce
- type
bytes
X.509 elements are frequently identified by ObjectIdentifier
instances. The following common OIDs are available as constants.
cryptography.x509.oid
These OIDs are typically seen in X.509 names.
1.0
COMMON_NAME
Corresponds to the dotted string "2.5.4.3"
. Historically the domain name would be encoded here for server certificates. 2818
deprecates this practice and names of that type should now be located in a ~cryptography.x509.SubjectAlternativeName
extension.
COUNTRY_NAME
Corresponds to the dotted string "2.5.4.6"
.
LOCALITY_NAME
Corresponds to the dotted string "2.5.4.7"
.
STATE_OR_PROVINCE_NAME
Corresponds to the dotted string "2.5.4.8"
.
STREET_ADDRESS
1.6
Corresponds to the dotted string "2.5.4.9"
.
ORGANIZATION_NAME
Corresponds to the dotted string "2.5.4.10"
.
ORGANIZATIONAL_UNIT_NAME
Corresponds to the dotted string "2.5.4.11"
.
SERIAL_NUMBER
Corresponds to the dotted string "2.5.4.5"
. This is distinct from the serial number of the certificate itself (which can be obtained with ~cryptography.x509.Certificate.serial_number
).
SURNAME
Corresponds to the dotted string "2.5.4.4"
.
GIVEN_NAME
Corresponds to the dotted string "2.5.4.42"
.
TITLE
Corresponds to the dotted string "2.5.4.12"
.
GENERATION_QUALIFIER
Corresponds to the dotted string "2.5.4.44"
.
X500_UNIQUE_IDENTIFIER
1.6
Corresponds to the dotted string "2.5.4.45"
.
DN_QUALIFIER
Corresponds to the dotted string "2.5.4.46"
. This specifies disambiguating information to add to the relative distinguished name of an entry. See 2256
.
PSEUDONYM
Corresponds to the dotted string "2.5.4.65"
.
USER_ID
1.6
Corresponds to the dotted string "0.9.2342.19200300.100.1.1"
.
DOMAIN_COMPONENT
Corresponds to the dotted string "0.9.2342.19200300.100.1.25"
. A string holding one component of a domain name. See 4519
.
EMAIL_ADDRESS
Corresponds to the dotted string "1.2.840.113549.1.9.1"
.
JURISDICTION_COUNTRY_NAME
Corresponds to the dotted string "1.3.6.1.4.1.311.60.2.1.3"
.
JURISDICTION_LOCALITY_NAME
Corresponds to the dotted string "1.3.6.1.4.1.311.60.2.1.1"
.
JURISDICTION_STATE_OR_PROVINCE_NAME
Corresponds to the dotted string "1.3.6.1.4.1.311.60.2.1.2"
.
BUSINESS_CATEGORY
Corresponds to the dotted string "2.5.4.15"
.
POSTAL_ADDRESS
1.6
Corresponds to the dotted string "2.5.4.16"
.
POSTAL_CODE
1.6
Corresponds to the dotted string "2.5.4.17"
.
UNSTRUCTURED_NAME
3.0
Corresponds to the dotted string "1.2.840.113549.1.9.2"
.
1.0
RSA_WITH_MD5
Corresponds to the dotted string "1.2.840.113549.1.1.4"
. This is an MD5 digest signed by an RSA key.
RSA_WITH_SHA1
Corresponds to the dotted string "1.2.840.113549.1.1.5"
. This is a SHA1 digest signed by an RSA key.
RSA_WITH_SHA224
Corresponds to the dotted string "1.2.840.113549.1.1.14"
. This is a SHA224 digest signed by an RSA key.
RSA_WITH_SHA256
Corresponds to the dotted string "1.2.840.113549.1.1.11"
. This is a SHA256 digest signed by an RSA key.
RSA_WITH_SHA384
Corresponds to the dotted string "1.2.840.113549.1.1.12"
. This is a SHA384 digest signed by an RSA key.
RSA_WITH_SHA512
Corresponds to the dotted string "1.2.840.113549.1.1.13"
. This is a SHA512 digest signed by an RSA key.
RSASSA_PSS
2.3
Corresponds to the dotted string "1.2.840.113549.1.1.10"
. This is signed by an RSA key using the Probabilistic Signature Scheme (PSS) padding from 4055
. The hash function and padding are defined by signature algorithm parameters.
ECDSA_WITH_SHA1
Corresponds to the dotted string "1.2.840.10045.4.1"
. This is a SHA1 digest signed by an ECDSA key.
ECDSA_WITH_SHA224
Corresponds to the dotted string "1.2.840.10045.4.3.1"
. This is a SHA224 digest signed by an ECDSA key.
ECDSA_WITH_SHA256
Corresponds to the dotted string "1.2.840.10045.4.3.2"
. This is a SHA256 digest signed by an ECDSA key.
ECDSA_WITH_SHA384
Corresponds to the dotted string "1.2.840.10045.4.3.3"
. This is a SHA384 digest signed by an ECDSA key.
ECDSA_WITH_SHA512
Corresponds to the dotted string "1.2.840.10045.4.3.4"
. This is a SHA512 digest signed by an ECDSA key.
DSA_WITH_SHA1
Corresponds to the dotted string "1.2.840.10040.4.3"
. This is a SHA1 digest signed by a DSA key.
DSA_WITH_SHA224
Corresponds to the dotted string "2.16.840.1.101.3.4.3.1"
. This is a SHA224 digest signed by a DSA key.
DSA_WITH_SHA256
Corresponds to the dotted string "2.16.840.1.101.3.4.3.2"
. This is a SHA256 digest signed by a DSA key.
ED25519
2.8
Corresponds to the dotted string "1.3.101.112"
. This is a signature using an ed25519 key.
ED448
2.8
Corresponds to the dotted string "1.3.101.113"
. This is a signature using an ed448 key.
1.0
SERVER_AUTH
Corresponds to the dotted string "1.3.6.1.5.5.7.3.1"
. This is used to denote that a certificate may be used for TLS web server authentication.
CLIENT_AUTH
Corresponds to the dotted string "1.3.6.1.5.5.7.3.2"
. This is used to denote that a certificate may be used for TLS web client authentication.
CODE_SIGNING
Corresponds to the dotted string "1.3.6.1.5.5.7.3.3"
. This is used to denote that a certificate may be used for code signing.
EMAIL_PROTECTION
Corresponds to the dotted string "1.3.6.1.5.5.7.3.4"
. This is used to denote that a certificate may be used for email protection.
TIME_STAMPING
Corresponds to the dotted string "1.3.6.1.5.5.7.3.8"
. This is used to denote that a certificate may be used for time stamping.
OCSP_SIGNING
Corresponds to the dotted string "1.3.6.1.5.5.7.3.9"
. This is used to denote that a certificate may be used for signing OCSP responses.
ANY_EXTENDED_KEY_USAGE
2.0
Corresponds to the dotted string "2.5.29.37.0"
. This is used to denote that a certificate may be used for _any purposes. However, 5280
additionally notes that applications that require the presence of a particular purpose _MAY reject certificates that include the anyExtendedKeyUsage
OID but not the particular OID expected for the application. Therefore, the presence of this OID does not mean a given application will accept the certificate for all purposes.
1.0
OCSP
Corresponds to the dotted string "1.3.6.1.5.5.7.48.1"
. Used as the identifier for OCSP data in ~cryptography.x509.AccessDescription
objects.
CA_ISSUERS
Corresponds to the dotted string "1.3.6.1.5.5.7.48.2"
. Used as the identifier for CA issuer data in ~cryptography.x509.AccessDescription
objects.
3.0
CA_REPOSITORY
Corresponds to the dotted string "1.3.6.1.5.5.7.48.5"
. Used as the identifier for CA repository data in ~cryptography.x509.AccessDescription
objects.
1.0
CPS_QUALIFIER
Corresponds to the dotted string "1.3.6.1.5.5.7.2.1"
.
CPS_USER_NOTICE
Corresponds to the dotted string "1.3.6.1.5.5.7.2.2"
.
ANY_POLICY
Corresponds to the dotted string "2.5.29.32.0"
.
1.0
BASIC_CONSTRAINTS
Corresponds to the dotted string "2.5.29.19"
. The identifier for the ~cryptography.x509.BasicConstraints
extension type.
KEY_USAGE
Corresponds to the dotted string "2.5.29.15"
. The identifier for the ~cryptography.x509.KeyUsage
extension type.
SUBJECT_ALTERNATIVE_NAME
Corresponds to the dotted string "2.5.29.17"
. The identifier for the ~cryptography.x509.SubjectAlternativeName
extension type.
ISSUER_ALTERNATIVE_NAME
Corresponds to the dotted string "2.5.29.18"
. The identifier for the ~cryptography.x509.IssuerAlternativeName
extension type.
SUBJECT_KEY_IDENTIFIER
Corresponds to the dotted string "2.5.29.14"
. The identifier for the ~cryptography.x509.SubjectKeyIdentifier
extension type.
NAME_CONSTRAINTS
Corresponds to the dotted string "2.5.29.30"
. The identifier for the ~cryptography.x509.NameConstraints
extension type.
CRL_DISTRIBUTION_POINTS
Corresponds to the dotted string "2.5.29.31"
. The identifier for the ~cryptography.x509.CRLDistributionPoints
extension type.
CERTIFICATE_POLICIES
Corresponds to the dotted string "2.5.29.32"
. The identifier for the ~cryptography.x509.CertificatePolicies
extension type.
AUTHORITY_KEY_IDENTIFIER
Corresponds to the dotted string "2.5.29.35"
. The identifier for the ~cryptography.x509.AuthorityKeyIdentifier
extension type.
EXTENDED_KEY_USAGE
Corresponds to the dotted string "2.5.29.37"
. The identifier for the ~cryptography.x509.ExtendedKeyUsage
extension type.
AUTHORITY_INFORMATION_ACCESS
Corresponds to the dotted string "1.3.6.1.5.5.7.1.1"
. The identifier for the ~cryptography.x509.AuthorityInformationAccess
extension type.
SUBJECT_INFORMATION_ACCESS
3.0
Corresponds to the dotted string "1.3.6.1.5.5.7.1.11"
. The identifier for the ~cryptography.x509.SubjectInformationAccess
extension type.
INHIBIT_ANY_POLICY
Corresponds to the dotted string "2.5.29.54"
. The identifier for the ~cryptography.x509.InhibitAnyPolicy
extension type.
OCSP_NO_CHECK
Corresponds to the dotted string "1.3.6.1.5.5.7.48.1.5"
. The identifier for the ~cryptography.x509.OCSPNoCheck
extension type.
TLS_FEATURE
Corresponds to the dotted string "1.3.6.1.5.5.7.1.24"
. The identifier for the ~cryptography.x509.TLSFeature
extension type.
CRL_NUMBER
Corresponds to the dotted string "2.5.29.20"
. The identifier for the CRLNumber
extension type. This extension only has meaning for certificate revocation lists.
DELTA_CRL_INDICATOR
2.1
Corresponds to the dotted string "2.5.29.27"
. The identifier for the DeltaCRLIndicator
extension type. This extension only has meaning for certificate revocation lists.
PRECERT_SIGNED_CERTIFICATE_TIMESTAMPS
1.9
Corresponds to the dotted string "1.3.6.1.4.1.11129.2.4.2"
.
PRECERT_POISON
2.4
Corresponds to the dotted string "1.3.6.1.4.1.11129.2.4.3"
.
SIGNED_CERTIFICATE_TIMESTAMPS
3.0
Corresponds to the dotted string "1.3.6.1.4.1.11129.2.4.5"
.
POLICY_CONSTRAINTS
Corresponds to the dotted string "2.5.29.36"
. The identifier for the ~cryptography.x509.PolicyConstraints
extension type.
FRESHEST_CRL
Corresponds to the dotted string "2.5.29.46"
. The identifier for the ~cryptography.x509.FreshestCRL
extension type.
ISSUING_DISTRIBUTION_POINT
2.4
Corresponds to the dotted string "2.5.29.28"
.
1.2
CERTIFICATE_ISSUER
Corresponds to the dotted string "2.5.29.29"
.
CRL_REASON
Corresponds to the dotted string "2.5.29.21"
.
INVALIDITY_DATE
Corresponds to the dotted string "2.5.29.24"
.
2.4
NONCE
Corresponds to the dotted string "1.3.6.1.5.5.7.48.1.2"
.
3.0
CHALLENGE_PASSWORD
Corresponds to the dotted string "1.2.840.113549.1.9.7"
.
UNSTRUCTURED_NAME
Corresponds to the dotted string "1.2.840.113549.1.9.2"
.
cryptography.x509
random_serial_number()
1.6
Generates a random serial number suitable for use when constructing certificates.
cryptography.x509
This is raised when an X.509 certificate has an invalid version number.
parsed_version
- type
int
Returns the raw version that was parsed from the certificate.
This is raised when more than one X.509 extension of the same type is found within a certificate.
oid
- type
ObjectIdentifier
Returns the OID.
This is raised when calling Extensions.get_extension_for_oid
with an extension OID that is not present in the certificate.
oid
- type
ObjectIdentifier
Returns the OID.
This is raised when calling CertificateSigningRequest.get_attribute_for_oid
with an attribute OID that is not present in the request.
oid
- type
ObjectIdentifier
Returns the OID.
This is raised when a certificate contains an unsupported general name type in an extension.
type
- type
int
The integer value of the unsupported type. The complete list of types can be found in RFC 5280 section 4.2.1.6.