doc/man3/OSSL_CMP_SRV_CTX_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_CMP_SRV_process_request,
   6 OSSL_CMP_CTX_server_perform,
   7 OSSL_CMP_SRV_CTX_new,
   8 OSSL_CMP_SRV_CTX_free,
   9 OSSL_CMP_SRV_cert_request_cb_t,
  10 OSSL_CMP_SRV_rr_cb_t,
  11 OSSL_CMP_SRV_certConf_cb_t,
  12 OSSL_CMP_SRV_genm_cb_t,
  13 OSSL_CMP_SRV_error_cb_t,
  14 OSSL_CMP_SRV_pollReq_cb_t,
  15 OSSL_CMP_SRV_CTX_init,
  16 OSSL_CMP_SRV_CTX_get0_cmp_ctx,
  17 OSSL_CMP_SRV_CTX_get0_custom_ctx,
  18 OSSL_CMP_SRV_CTX_set_send_unprotected_errors,
  19 OSSL_CMP_SRV_CTX_set_accept_unprotected,
  20 OSSL_CMP_SRV_CTX_set_accept_raverified,
  21 OSSL_CMP_SRV_CTX_set_grant_implicit_confirm
  22 - generic functions to set up and control a CMP server
  23
  24 =head1 SYNOPSIS
  25
  26  #include <openssl/cmp.h>
  27
  28  OSSL_CMP_MSG *OSSL_CMP_SRV_process_request(OSSL_CMP_SRV_CTX *srv_ctx,
  29                                             const OSSL_CMP_MSG *req);
  30  OSSL_CMP_MSG *OSSL_CMP_CTX_server_perform(OSSL_CMP_CTX *client_ctx,
  31                                            const OSSL_CMP_MSG *req);
  32  OSSL_CMP_SRV_CTX *OSSL_CMP_SRV_CTX_new(void);
  33  void OSSL_CMP_SRV_CTX_free(OSSL_CMP_SRV_CTX *srv_ctx);
  34
  35  typedef OSSL_CMP_PKISI *(*OSSL_CMP_SRV_cert_request_cb_t)(
  36                                                  OSSL_CMP_SRV_CTX *srv_ctx,
  37                                                  const OSSL_CMP_MSG *req,
  38                                                  int certReqId,
  39                                                  const OSSL_CRMF_MSG *crm,
  40                                                  const X509_REQ *p10cr,
  41                                                  X509 **certOut,
  42                                                  STACK_OF(X509) **chainOut,
  43                                                  STACK_OF(X509) **caPubs);
  44  typedef OSSL_CMP_PKISI *(*OSSL_CMP_SRV_rr_cb_t)(OSSL_CMP_SRV_CTX *srv_ctx,
  45                                                  const OSSL_CMP_MSG *req,
  46                                                  const X509_NAME *issuer,
  47                                                  const ASN1_INTEGER *serial);
  48  typedef int (*OSSL_CMP_SRV_genm_cb_t)(OSSL_CMP_SRV_CTX *srv_ctx,
  49                                        const OSSL_CMP_MSG *req,
  50                                        STACK_OF(OSSL_CMP_ITAV) *in,
  51                                        STACK_OF(OSSL_CMP_ITAV) **out);
  52  typedef void (*OSSL_CMP_SRV_error_cb_t)(OSSL_CMP_SRV_CTX *srv_ctx,
  53                                          const OSSL_CMP_MSG *req,
  54                                          const OSSL_CMP_PKISI *statusInfo,
  55                                          const ASN1_INTEGER *errorCode,
  56                                          const OSSL_CMP_PKIFREETEXT *errorDetails);
  57  typedef int (*OSSL_CMP_SRV_certConf_cb_t)(OSSL_CMP_SRV_CTX *srv_ctx,
  58                                            const OSSL_CMP_MSG *req,
  59                                            int certReqId,
  60                                            const ASN1_OCTET_STRING *certHash,
  61                                            const OSSL_CMP_PKISI *si);
  62  typedef int (*OSSL_CMP_SRV_pollReq_cb_t)(OSSL_CMP_SRV_CTX *srv_ctx,
  63                                           const OSSL_CMP_MSG *req,
  64                                           int certReqId,
  65                                           OSSL_CMP_MSG **certReq,
  66                                           int64_t *check_after);
  67  int OSSL_CMP_SRV_CTX_init(OSSL_CMP_SRV_CTX *srv_ctx, void *custom_ctx,
  68                            OSSL_CMP_SRV_cert_request_cb_t process_cert_request,
  69                            OSSL_CMP_SRV_rr_cb_t process_rr,
  70                            OSSL_CMP_SRV_genm_cb_t process_genm,
  71                            OSSL_CMP_SRV_error_cb_t process_error,
  72                            OSSL_CMP_SRV_certConf_cb_t process_certConf,
  73                            OSSL_CMP_SRV_pollReq_cb_t process_pollReq);
  74
  75  OSSL_CMP_CTX *OSSL_CMP_SRV_CTX_get0_cmp_ctx(const OSSL_CMP_SRV_CTX *srv_ctx);
  76  void *OSSL_CMP_SRV_CTX_get0_custom_ctx(const OSSL_CMP_SRV_CTX *srv_ctx);
  77
  78  int OSSL_CMP_SRV_CTX_set_send_unprotected_errors(OSSL_CMP_SRV_CTX *srv_ctx,
  79                                                   int val);
  80  int OSSL_CMP_SRV_CTX_set_accept_unprotected(OSSL_CMP_SRV_CTX *srv_ctx, int val);
  81  int OSSL_CMP_SRV_CTX_set_accept_raverified(OSSL_CMP_SRV_CTX *srv_ctx, int val);
  82  int OSSL_CMP_SRV_CTX_set_grant_implicit_confirm(OSSL_CMP_SRV_CTX *srv_ctx,
  83                                                  int val);
  84
  85 =head1 DESCRIPTION
  86
  87 OSSL_CMP_SRV_process_request() implements the generic aspects of a CMP server.
  88 Its arguments are the B<OSSL_CMP_SRV_CTX> I<srv_ctx> and the CMP request message
  89 I<req>. It does the typical generic checks on I<req>, calls
  90 the respective callback function (if present) for more specific processing,
  91 and then assembles a result message, which may be a CMP error message.
  92
  93 OSSL_CMP_CTX_server_perform() is an interface to
  94 B<OSSL_CMP_SRV_process_request()> that can be used by a CMP client
  95 in the same way as B<OSSL_CMP_MSG_http_perform()>.
  96 The B<OSSL_CMP_SRV_CTX> must be set as I<transfer_cb_arg> of I<client_ctx>.
  97
  98 OSSL_CMP_SRV_CTX_new() creates and initializes an OSSL_CMP_SRV_CTX structure
  99 and returns a pointer to it on success, NULL on error.
 100
 101 OSSL_CMP_SRV_CTX_free() deletes the given I<srv_ctx>.
 102
 103 OSSL_CMP_SRV_CTX_init() sets in the given I<srv_ctx> a custom server context
 104 pointer as well as callback functions performing the specific processing of CMP
 105 certificate requests, revocation requests, certificate confirmation requests,
 106 general messages, error messages, and poll requests.
 107 All arguments except I<srv_ctx> may be NULL.
 108 If a callback for some message type is not given this means that the respective
 109 type of CMP message is not supported by the server.
 110
 111 OSSL_CMP_SRV_CTX_get0_cmp_ctx() returns the B<OSSL_CMP_CTX> from the I<srv_ctx>.
 112
 113 OSSL_CMP_SRV_CTX_get0_custom_ctx() returns the custom server context from
 114 I<srv_ctx> that has been set using B<OSSL_CMP_SRV_CTX_init()>.
 115
 116 OSSL_CMP_SRV_CTX_set_send_unprotected_errors() enables sending error messages
 117 and other forms of negative responses unprotected.
 118
 119 OSSL_CMP_SRV_CTX_set_accept_unprotected() enables acceptance of requests
 120 without protection of with invalid protection.
 121
 122 OSSL_CMP_SRV_CTX_set_accept_raverified() enables acceptance of ir/cr/kur
 123 messages with POPO 'RAVerified'.
 124
 125 OSSL_CMP_SRV_CTX_set_grant_implicit_confirm() enables granting implicit
 126 confirmation of newly enrolled certificates if requested.
 127
 128 =head1 NOTES
 129
 130 CMP is defined in RFC 4210 (and CRMF in RFC 4211).
 131
 132 So far the CMP server implementation is limited to one request per CMP message
 133 (and consequently to at most one response component per CMP message).
 134
 135 =head1 RETURN VALUES
 136
 137 OSSL_CMP_SRV_CTX_new() returns a B<OSSL_CMP_SRV_CTX> structure on success,
 138 NULL on error.
 139
 140 OSSL_CMP_SRV_CTX_free() does not return a value.
 141
 142 OSSL_CMP_SRV_CTX_get0_cmp_ctx() returns a B<OSSL_CMP_CTX> structure on success,
 143 NULL on error.
 144
 145 OSSL_CMP_SRV_CTX_get0_custom_ctx() returns the custom server context
 146 that has been set using B<OSSL_CMP_SRV_CTX_init()>.
 147
 148 All other functions return 1 on success, 0 on error.
 149
 150 =head1 HISTORY
 151
 152 The OpenSSL CMP support was added in OpenSSL 3.0.
 153
 154 =head1 COPYRIGHT
 155
 156 Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
 157
 158 Licensed under the Apache License 2.0 (the "License").  You may not use
 159 this file except in compliance with the License.  You can obtain a copy
 160 in the file LICENSE in the source distribution or at
 161 L<https://www.openssl.org/source/license.html>.
 162
 163 =cut