doc/man3/SSL_CTX_set_verify.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_get_ex_data_X509_STORE_CTX_idx,
   6 SSL_CTX_set_verify, SSL_set_verify,
   7 SSL_CTX_set_verify_depth, SSL_set_verify_depth,
   8 SSL_verify_cb
   9 - set peer certificate verification parameters
  10
  11 =head1 SYNOPSIS
  12
  13  #include <openssl/ssl.h>
  14
  15  void SSL_CTX_set_verify(SSL_CTX *ctx, int mode, SSL_verify_cb verify_callback);
  16  void SSL_set_verify(SSL *s, int mode, SSL_verify_cb verify_callback);
  17  SSL_get_ex_data_X509_STORE_CTX_idx(void);
  18
  19  void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
  20  void SSL_set_verify_depth(SSL *s, int depth);
  21
  22
  23  typedef int (*SSL_verify_cb)(int preverify_ok, X509_STORE_CTX *x509_ctx);
  24
  25 =head1 DESCRIPTION
  26
  27 SSL_CTX_set_verify() sets the verification flags for B<ctx> to be B<mode> and
  28 specifies the B<verify_callback> function to be used. If no callback function
  29 shall be specified, the NULL pointer can be used for B<verify_callback>.
  30
  31 SSL_set_verify() sets the verification flags for B<ssl> to be B<mode> and
  32 specifies the B<verify_callback> function to be used. If no callback function
  33 shall be specified, the NULL pointer can be used for B<verify_callback>. In
  34 this case last B<verify_callback> set specifically for this B<ssl> remains. If
  35 no special B<callback> was set before, the default callback for the underlying
  36 B<ctx> is used, that was valid at the time B<ssl> was created with
  37 L<SSL_new(3)>. Within the callback function,
  38 B<SSL_get_ex_data_X509_STORE_CTX_idx> can be called to get the data index
  39 of the current SSL object that is doing the verification.
  40
  41 SSL_CTX_set_verify_depth() sets the maximum B<depth> for the certificate chain
  42 verification that shall be allowed for B<ctx>. (See the BUGS section.)
  43
  44 SSL_set_verify_depth() sets the maximum B<depth> for the certificate chain
  45 verification that shall be allowed for B<ssl>. (See the BUGS section.)
  46
  47 =head1 NOTES
  48
  49 The verification of certificates can be controlled by a set of logically
  50 or'ed B<mode> flags:
  51
  52 =over 4
  53
  54 =item SSL_VERIFY_NONE
  55
  56 B<Server mode:> the server will not send a client certificate request to the
  57 client, so the client will not send a certificate.
  58
  59 B<Client mode:> if not using an anonymous cipher (by default disabled), the
  60 server will send a certificate which will be checked. The result of the
  61 certificate verification process can be checked after the TLS/SSL handshake
  62 using the L<SSL_get_verify_result(3)> function.
  63 The handshake will be continued regardless of the verification result.
  64
  65 =item SSL_VERIFY_PEER
  66
  67 B<Server mode:> the server sends a client certificate request to the client.
  68 The certificate returned (if any) is checked. If the verification process
  69 fails, the TLS/SSL handshake is
  70 immediately terminated with an alert message containing the reason for
  71 the verification failure.
  72 The behaviour can be controlled by the additional
  73 SSL_VERIFY_FAIL_IF_NO_PEER_CERT and SSL_VERIFY_CLIENT_ONCE flags.
  74
  75 B<Client mode:> the server certificate is verified. If the verification process
  76 fails, the TLS/SSL handshake is
  77 immediately terminated with an alert message containing the reason for
  78 the verification failure. If no server certificate is sent, because an
  79 anonymous cipher is used, SSL_VERIFY_PEER is ignored.
  80
  81 =item SSL_VERIFY_FAIL_IF_NO_PEER_CERT
  82
  83 B<Server mode:> if the client did not return a certificate, the TLS/SSL
  84 handshake is immediately terminated with a "handshake failure" alert.
  85 This flag must be used together with SSL_VERIFY_PEER.
  86
  87 B<Client mode:> ignored
  88
  89 =item SSL_VERIFY_CLIENT_ONCE
  90
  91 B<Server mode:> only request a client certificate on the initial TLS/SSL
  92 handshake. Do not ask for a client certificate again in case of a
  93 renegotiation. This flag must be used together with SSL_VERIFY_PEER.
  94
  95 B<Client mode:> ignored
  96
  97 =back
  98
  99 If the B<mode> is SSL_VERIFY_NONE none of the other flags may be set.
 100
 101 The actual verification procedure is performed either using the built-in
 102 verification procedure or using another application provided verification
 103 function set with
 104 L<SSL_CTX_set_cert_verify_callback(3)>.
 105 The following descriptions apply in the case of the built-in procedure. An
 106 application provided procedure also has access to the verify depth information
 107 and the verify_callback() function, but the way this information is used
 108 may be different.
 109
 110 SSL_CTX_set_verify_depth() and SSL_set_verify_depth() set the limit up
 111 to which depth certificates in a chain are used during the verification
 112 procedure. If the certificate chain is longer than allowed, the certificates
 113 above the limit are ignored. Error messages are generated as if these
 114 certificates would not be present, most likely a
 115 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY will be issued.
 116 The depth count is "level 0:peer certificate", "level 1: CA certificate",
 117 "level 2: higher level CA certificate", and so on. Setting the maximum
 118 depth to 2 allows the levels 0, 1, and 2. The default depth limit is 100,
 119 allowing for the peer certificate and additional 100 CA certificates.
 120
 121 The B<verify_callback> function is used to control the behaviour when the
 122 SSL_VERIFY_PEER flag is set. It must be supplied by the application and
 123 receives two arguments: B<preverify_ok> indicates, whether the verification of
 124 the certificate in question was passed (preverify_ok=1) or not
 125 (preverify_ok=0). B<x509_ctx> is a pointer to the complete context used
 126 for the certificate chain verification.
 127
 128 The certificate chain is checked starting with the deepest nesting level
 129 (the root CA certificate) and worked upward to the peer's certificate.
 130 At each level signatures and issuer attributes are checked. Whenever
 131 a verification error is found, the error number is stored in B<x509_ctx>
 132 and B<verify_callback> is called with B<preverify_ok>=0. By applying
 133 X509_CTX_store_* functions B<verify_callback> can locate the certificate
 134 in question and perform additional steps (see EXAMPLES). If no error is
 135 found for a certificate, B<verify_callback> is called with B<preverify_ok>=1
 136 before advancing to the next level.
 137
 138 The return value of B<verify_callback> controls the strategy of the further
 139 verification process. If B<verify_callback> returns 0, the verification
 140 process is immediately stopped with "verification failed" state. If
 141 SSL_VERIFY_PEER is set, a verification failure alert is sent to the peer and
 142 the TLS/SSL handshake is terminated. If B<verify_callback> returns 1,
 143 the verification process is continued. If B<verify_callback> always returns
 144 1, the TLS/SSL handshake will not be terminated with respect to verification
 145 failures and the connection will be established. The calling process can
 146 however retrieve the error code of the last verification error using
 147 L<SSL_get_verify_result(3)> or by maintaining its
 148 own error storage managed by B<verify_callback>.
 149
 150 If no B<verify_callback> is specified, the default callback will be used.
 151 Its return value is identical to B<preverify_ok>, so that any verification
 152 failure will lead to a termination of the TLS/SSL handshake with an
 153 alert message, if SSL_VERIFY_PEER is set.
 154
 155 =head1 BUGS
 156
 157 In client mode, it is not checked whether the SSL_VERIFY_PEER flag
 158 is set, but whether any flags are set. This can lead to
 159 unexpected behaviour if SSL_VERIFY_PEER and other flags are not used as
 160 required.
 161
 162 =head1 RETURN VALUES
 163
 164 The SSL*_set_verify*() functions do not provide diagnostic information.
 165
 166 =head1 EXAMPLES
 167
 168 The following code sequence realizes an example B<verify_callback> function
 169 that will always continue the TLS/SSL handshake regardless of verification
 170 failure, if wished. The callback realizes a verification depth limit with
 171 more informational output.
 172
 173 All verification errors are printed; information about the certificate chain
 174 is printed on request.
 175 The example is realized for a server that does allow but not require client
 176 certificates.
 177
 178 The example makes use of the ex_data technique to store application data
 179 into/retrieve application data from the SSL structure
 180 (see L<CRYPTO_get_ex_new_index(3)>,
 181 L<SSL_get_ex_data_X509_STORE_CTX_idx(3)>).
 182
 183  ...
 184  typedef struct {
 185    int verbose_mode;
 186    int verify_depth;
 187    int always_continue;
 188  } mydata_t;
 189  int mydata_index;
 190  ...
 191  static int verify_callback(int preverify_ok, X509_STORE_CTX *ctx)
 192  {
 193     char    buf[256];
 194     X509   *err_cert;
 195     int     err, depth;
 196     SSL    *ssl;
 197     mydata_t *mydata;
 198
 199     err_cert = X509_STORE_CTX_get_current_cert(ctx);
 200     err = X509_STORE_CTX_get_error(ctx);
 201     depth = X509_STORE_CTX_get_error_depth(ctx);
 202
 203     /*
 204      * Retrieve the pointer to the SSL of the connection currently treated
 205      * and the application specific data stored into the SSL object.
 206      */
 207     ssl = X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx());
 208     mydata = SSL_get_ex_data(ssl, mydata_index);
 209
 210     X509_NAME_oneline(X509_get_subject_name(err_cert), buf, 256);
 211
 212     /*
 213      * Catch a too long certificate chain. The depth limit set using
 214      * SSL_CTX_set_verify_depth() is by purpose set to "limit+1" so
 215      * that whenever the "depth>verify_depth" condition is met, we
 216      * have violated the limit and want to log this error condition.
 217      * We must do it here, because the CHAIN_TOO_LONG error would not
 218      * be found explicitly; only errors introduced by cutting off the
 219      * additional certificates would be logged.
 220      */
 221     if (depth > mydata->verify_depth) {
 222         preverify_ok = 0;
 223         err = X509_V_ERR_CERT_CHAIN_TOO_LONG;
 224         X509_STORE_CTX_set_error(ctx, err);
 225     }
 226     if (!preverify_ok) {
 227         printf("verify error:num=%d:%s:depth=%d:%s\n", err,
 228                  X509_verify_cert_error_string(err), depth, buf);
 229     }
 230     else if (mydata->verbose_mode)
 231     {
 232         printf("depth=%d:%s\n", depth, buf);
 233     }
 234
 235     /*
 236      * At this point, err contains the last verification error. We can use
 237      * it for something special
 238      */
 239     if (!preverify_ok && (err == X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT))
 240     {
 241       X509_NAME_oneline(X509_get_issuer_name(err_cert), buf, 256);
 242       printf("issuer= %s\n", buf);
 243     }
 244
 245     if (mydata->always_continue)
 246       return 1;
 247     else
 248       return preverify_ok;
 249  }
 250  ...
 251
 252  mydata_t mydata;
 253
 254  ...
 255  mydata_index = SSL_get_ex_new_index(0, "mydata index", NULL, NULL, NULL);
 256
 257  ...
 258  SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER|SSL_VERIFY_CLIENT_ONCE,
 259                     verify_callback);
 260
 261  /*
 262   * Let the verify_callback catch the verify_depth error so that we get
 263   * an appropriate error in the logfile.
 264   */
 265  SSL_CTX_set_verify_depth(verify_depth + 1);
 266
 267  /*
 268   * Set up the SSL specific data into "mydata" and store it into th SSL
 269   * structure.
 270   */
 271  mydata.verify_depth = verify_depth; ...
 272  SSL_set_ex_data(ssl, mydata_index, &mydata);
 273
 274  ...
 275  SSL_accept(ssl);       /* check of success left out for clarity */
 276  if (peer = SSL_get_peer_certificate(ssl))
 277  {
 278    if (SSL_get_verify_result(ssl) == X509_V_OK)
 279    {
 280      /* The client sent a certificate which verified OK */
 281    }
 282  }
 283
 284 =head1 SEE ALSO
 285
 286 L<ssl(7)>, L<SSL_new(3)>,
 287 L<SSL_CTX_get_verify_mode(3)>,
 288 L<SSL_get_verify_result(3)>,
 289 L<SSL_CTX_load_verify_locations(3)>,
 290 L<SSL_get_peer_certificate(3)>,
 291 L<SSL_CTX_set_cert_verify_callback(3)>,
 292 L<SSL_get_ex_data_X509_STORE_CTX_idx(3)>,
 293 L<CRYPTO_get_ex_new_index(3)>
 294
 295 =head1 COPYRIGHT
 296
 297 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
 298
 299 Licensed under the OpenSSL license (the "License").  You may not use
 300 this file except in compliance with the License.  You can obtain a copy
 301 in the file LICENSE in the source distribution or at
 302 L<https://www.openssl.org/source/license.html>.
 303
 304 =cut