doc/crypto/X509_STORE_CTX_get_error.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 X509_STORE_CTX_get_error, X509_STORE_CTX_set_error,
   6 X509_STORE_CTX_get_error_depth, X509_STORE_CTX_get_current_cert,
   7 X509_STORE_CTX_get0_cert,
   8 X509_STORE_CTX_get1_chain, X509_verify_cert_error_string - get or set certificate verification status information
   9
  10 =head1 SYNOPSIS
  11
  12  #include <openssl/x509.h>
  13  #include <openssl/x509_vfy.h>
  14
  15  int    X509_STORE_CTX_get_error(X509_STORE_CTX *ctx);
  16  void   X509_STORE_CTX_set_error(X509_STORE_CTX *ctx,int s);
  17  int    X509_STORE_CTX_get_error_depth(X509_STORE_CTX *ctx);
  18  X509 * X509_STORE_CTX_get_current_cert(X509_STORE_CTX *ctx);
  19  X509 * X509_STORE_CTX_get0_cert(X509_STORE_CTX *ctx);
  20
  21  STACK_OF(X509) *X509_STORE_CTX_get1_chain(X509_STORE_CTX *ctx);
  22
  23  const char *X509_verify_cert_error_string(long n);
  24
  25 =head1 DESCRIPTION
  26
  27 These functions are typically called after X509_verify_cert() has indicated
  28 an error or in a verification callback to determine the nature of an error.
  29
  30 X509_STORE_CTX_get_error() returns the error code of B<ctx>, see
  31 the B<ERROR CODES> section for a full description of all error codes.
  32
  33 X509_STORE_CTX_set_error() sets the error code of B<ctx> to B<s>. For example
  34 it might be used in a verification callback to set an error based on additional
  35 checks.
  36
  37 X509_STORE_CTX_get_error_depth() returns the B<depth> of the error. This is a
  38 non-negative integer representing where in the certificate chain the error
  39 occurred. If it is zero it occurred in the end entity certificate, one if
  40 it is the certificate which signed the end entity certificate and so on.
  41
  42 X509_STORE_CTX_get0_cert() returns the leaf certificate being verified.
  43
  44 X509_STORE_CTX_get_current_cert() returns the certificate in B<ctx> which
  45 caused the error or B<NULL> if no certificate is relevant.
  46
  47 X509_STORE_CTX_get1_chain() returns a complete validate chain if a previous
  48 call to X509_verify_cert() is successful. If the call to X509_verify_cert()
  49 is B<not> successful the returned chain may be incomplete or invalid. The
  50 returned chain persists after the B<ctx> structure is freed, when it is
  51 no longer needed it should be free up using:
  52
  53   sk_X509_pop_free(chain, X509_free);
  54
  55 X509_verify_cert_error_string() returns a human readable error string for
  56 verification error B<n>.
  57
  58 =head1 RETURN VALUES
  59
  60 X509_STORE_CTX_get_error() returns B<X509_V_OK> or an error code.
  61
  62 X509_STORE_CTX_get_error_depth() returns a non-negative error depth.
  63
  64 X509_STORE_CTX_get_current_cert() returns the certificate which caused the
  65 error or B<NULL> if no certificate is relevant to the error.
  66
  67 X509_verify_cert_error_string() returns a human readable error string for
  68 verification error B<n>.
  69
  70 =head1 ERROR CODES
  71
  72 A list of error codes and messages is shown below.  Some of the
  73 error codes are defined but currently never returned: these are described as
  74 "unused".
  75
  76 =over 4
  77
  78 =item B<X509_V_OK: ok>
  79
  80 the operation was successful.
  81
  82 =item B<X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT: unable to get issuer certificate>
  83
  84 the issuer certificate could not be found: this occurs if the issuer certificate
  85 of an untrusted certificate cannot be found.
  86
  87 =item B<X509_V_ERR_UNABLE_TO_GET_CRL: unable to get certificate CRL>
  88
  89 the CRL of a certificate could not be found.
  90
  91 =item B<X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE: unable to decrypt certificate's signature>
  92
  93 the certificate signature could not be decrypted. This means that the actual
  94 signature value could not be determined rather than it not matching the
  95 expected value, this is only meaningful for RSA keys.
  96
  97 =item B<X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE: unable to decrypt CRL's signature>
  98
  99 the CRL signature could not be decrypted: this means that the actual signature
 100 value could not be determined rather than it not matching the expected value.
 101 Unused.
 102
 103 =item B<X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY: unable to decode issuer public key>
 104
 105 the public key in the certificate SubjectPublicKeyInfo could not be read.
 106
 107 =item B<X509_V_ERR_CERT_SIGNATURE_FAILURE: certificate signature failure>
 108
 109 the signature of the certificate is invalid.
 110
 111 =item B<X509_V_ERR_CRL_SIGNATURE_FAILURE: CRL signature failure>
 112
 113 the signature of the certificate is invalid.
 114
 115 =item B<X509_V_ERR_CERT_NOT_YET_VALID: certificate is not yet valid>
 116
 117 the certificate is not yet valid: the notBefore date is after the current time.
 118
 119 =item B<X509_V_ERR_CERT_HAS_EXPIRED: certificate has expired>
 120
 121 the certificate has expired: that is the notAfter date is before the current time.
 122
 123 =item B<X509_V_ERR_CRL_NOT_YET_VALID: CRL is not yet valid>
 124
 125 the CRL is not yet valid.
 126
 127 =item B<X509_V_ERR_CRL_HAS_EXPIRED: CRL has expired>
 128
 129 the CRL has expired.
 130
 131 =item B<X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD: format error in certificate's notBefore field>
 132
 133 the certificate notBefore field contains an invalid time.
 134
 135 =item B<X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD: format error in certificate's notAfter field>
 136
 137 the certificate notAfter field contains an invalid time.
 138
 139 =item B<X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD: format error in CRL's lastUpdate field>
 140
 141 the CRL lastUpdate field contains an invalid time.
 142
 143 =item B<X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD: format error in CRL's nextUpdate field>
 144
 145 the CRL nextUpdate field contains an invalid time.
 146
 147 =item B<X509_V_ERR_OUT_OF_MEM: out of memory>
 148
 149 an error occurred trying to allocate memory. This should never happen.
 150
 151 =item B<X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT: self signed certificate>
 152
 153 the passed certificate is self signed and the same certificate cannot be found
 154 in the list of trusted certificates.
 155
 156 =item B<X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN: self signed certificate in certificate chain>
 157
 158 the certificate chain could be built up using the untrusted certificates but
 159 the root could not be found locally.
 160
 161 =item B<X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY: unable to get local issuer certificate>
 162
 163 the issuer certificate of a locally looked up certificate could not be found.
 164 This normally means the list of trusted certificates is not complete.
 165
 166 =item B<X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE: unable to verify the first certificate>
 167
 168 no signatures could be verified because the chain contains only one certificate
 169 and it is not self signed.
 170
 171 =item B<X509_V_ERR_CERT_CHAIN_TOO_LONG: certificate chain too long>
 172
 173 the certificate chain length is greater than the supplied maximum depth. Unused.
 174
 175 =item B<X509_V_ERR_CERT_REVOKED: certificate revoked>
 176
 177 the certificate has been revoked.
 178
 179 =item B<X509_V_ERR_INVALID_CA: invalid CA certificate>
 180
 181 a CA certificate is invalid. Either it is not a CA or its extensions are not
 182 consistent with the supplied purpose.
 183
 184 =item B<X509_V_ERR_PATH_LENGTH_EXCEEDED: path length constraint exceeded>
 185
 186 the basicConstraints pathlength parameter has been exceeded.
 187
 188 =item B<X509_V_ERR_INVALID_PURPOSE: unsupported certificate purpose>
 189
 190 the supplied certificate cannot be used for the specified purpose.
 191
 192 =item B<X509_V_ERR_CERT_UNTRUSTED: certificate not trusted>
 193
 194 the root CA is not marked as trusted for the specified purpose.
 195
 196 =item B<X509_V_ERR_CERT_REJECTED: certificate rejected>
 197
 198 the root CA is marked to reject the specified purpose.
 199
 200 =item B<X509_V_ERR_SUBJECT_ISSUER_MISMATCH: subject issuer mismatch>
 201
 202 the current candidate issuer certificate was rejected because its subject name
 203 did not match the issuer name of the current certificate. This is only set
 204 if issuer check debugging is enabled it is used for status notification and
 205 is B<not> in itself an error.
 206
 207 =item B<X509_V_ERR_AKID_SKID_MISMATCH: authority and subject key identifier mismatch>
 208
 209 the current candidate issuer certificate was rejected because its subject key
 210 identifier was present and did not match the authority key identifier current
 211 certificate. This is only set if issuer check debugging is enabled it is used
 212 for status notification and is B<not> in itself an error.
 213
 214 =item B<X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH: authority and issuer serial number mismatch>
 215
 216 the current candidate issuer certificate was rejected because its issuer name
 217 and serial number was present and did not match the authority key identifier of
 218 the current certificate. This is only set if issuer check debugging is enabled
 219 it is used for status notification and is B<not> in itself an error.
 220
 221 =item B<X509_V_ERR_KEYUSAGE_NO_CERTSIGN:key usage does not include certificate signing>
 222
 223 the current candidate issuer certificate was rejected because its keyUsage
 224 extension does not permit certificate signing. This is only set if issuer check
 225 debugging is enabled it is used for status notification and is B<not> in itself
 226 an error.
 227
 228 =item B<X509_V_ERR_INVALID_EXTENSION: invalid or inconsistent certificate extension>
 229
 230 A certificate extension had an invalid value (for example an incorrect
 231 encoding) or some value inconsistent with other extensions.
 232
 233
 234 =item B<X509_V_ERR_INVALID_POLICY_EXTENSION: invalid or inconsistent certificate policy extension>
 235
 236 A certificate policies extension had an invalid value (for example an incorrect
 237 encoding) or some value inconsistent with other extensions. This error only
 238 occurs if policy processing is enabled.
 239
 240 =item B<X509_V_ERR_NO_EXPLICIT_POLICY: no explicit policy>
 241
 242 The verification flags were set to require and explicit policy but none was
 243 present.
 244
 245 =item B<X509_V_ERR_DIFFERENT_CRL_SCOPE: Different CRL scope>
 246
 247 The only CRLs that could be found did not match the scope of the certificate.
 248
 249 =item B<X509_V_ERR_UNSUPPORTED_EXTENSION_FEATURE: Unsupported extension feature>
 250
 251 Some feature of a certificate extension is not supported. Unused.
 252
 253 =item B<X509_V_ERR_PERMITTED_VIOLATION: permitted subtree violation>
 254
 255 A name constraint violation occurred in the permitted subtrees.
 256
 257 =item B<X509_V_ERR_EXCLUDED_VIOLATION: excluded subtree violation>
 258
 259 A name constraint violation occurred in the excluded subtrees.
 260
 261 =item B<X509_V_ERR_SUBTREE_MINMAX: name constraints minimum and maximum not supported>
 262
 263 A certificate name constraints extension included a minimum or maximum field:
 264 this is not supported.
 265
 266 =item B<X509_V_ERR_UNSUPPORTED_CONSTRAINT_TYPE: unsupported name constraint type>
 267
 268 An unsupported name constraint type was encountered. OpenSSL currently only
 269 supports directory name, DNS name, email and URI types.
 270
 271 =item B<X509_V_ERR_UNSUPPORTED_CONSTRAINT_SYNTAX: unsupported or invalid name constraint syntax>
 272
 273 The format of the name constraint is not recognised: for example an email
 274 address format of a form not mentioned in RFC3280. This could be caused by
 275 a garbage extension or some new feature not currently supported.
 276
 277 =item B<X509_V_ERR_CRL_PATH_VALIDATION_ERROR: CRL path validation error>
 278
 279 An error occurred when attempting to verify the CRL path. This error can only
 280 happen if extended CRL checking is enabled.
 281
 282 =item B<X509_V_ERR_APPLICATION_VERIFICATION: application verification failure>
 283
 284 an application specific error. This will never be returned unless explicitly
 285 set by an application.
 286
 287 =back
 288
 289 =head1 NOTES
 290
 291 The above functions should be used instead of directly referencing the fields
 292 in the B<X509_VERIFY_CTX> structure.
 293
 294 In versions of OpenSSL before 1.0 the current certificate returned by
 295 X509_STORE_CTX_get_current_cert() was never B<NULL>. Applications should
 296 check the return value before printing out any debugging information relating
 297 to the current certificate.
 298
 299 If an unrecognised error code is passed to X509_verify_cert_error_string() the
 300 numerical value of the unknown code is returned in a static buffer. This is not
 301 thread safe but will never happen unless an invalid code is passed.
 302
 303 =head1 SEE ALSO
 304
 305 L<X509_verify_cert(3)>
 306
 307 =head1 HISTORY
 308
 309 TBA
 310
 311 =cut