doc/man3/OSSL_CMP_ITAV_set0.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_CMP_ITAV_create,
   6 OSSL_CMP_ITAV_set0,
   7 OSSL_CMP_ITAV_get0_type,
   8 OSSL_CMP_ITAV_get0_value,
   9 OSSL_CMP_ITAV_push0_stack_item
  10 - OSSL_CMP_ITAV utility functions
  11
  12 =head1 SYNOPSIS
  13
  14   #include <openssl/cmp.h>
  15   OSSL_CMP_ITAV *OSSL_CMP_ITAV_create(ASN1_OBJECT *type, ASN1_TYPE *value);
  16   void OSSL_CMP_ITAV_set0(OSSL_CMP_ITAV *itav, ASN1_OBJECT *type,
  17                           ASN1_TYPE *value);
  18   ASN1_OBJECT *OSSL_CMP_ITAV_get0_type(const OSSL_CMP_ITAV *itav);
  19   ASN1_TYPE *OSSL_CMP_ITAV_get0_value(const OSSL_CMP_ITAV *itav);
  20
  21   int OSSL_CMP_ITAV_push0_stack_item(STACK_OF(OSSL_CMP_ITAV) **itav_sk_p,
  22                                      OSSL_CMP_ITAV *itav);
  23
  24 =head1 DESCRIPTION
  25
  26 Certificate Management Protocol (CMP, RFC 4210) extension to OpenSSL
  27
  28 ITAV is short for InfoTypeAndValue. This type is defined in RFC 4210
  29 section 5.3.19 and Appendix F. It is used at various places in CMP messages,
  30 e.g., in the generalInfo PKIHeader field, to hold a key-value pair.
  31
  32 OSSL_CMP_ITAV_create() creates a new OSSL_CMP_ITAV structure and fills it in.
  33 It combines B<OSSL_CMP_ITAV_new()> and B<OSSL_CMP_ITAV_set0>.
  34
  35 OSSL_CMP_ITAV_set0() sets the B<itav> with an infoType of B<type> and an
  36 infoValue of B<value>. This function uses the pointers B<type> and B<value>
  37 internally, so they must B<not> be freed up after the call.
  38
  39 OSSL_CMP_ITAV_get0_type() returns a direct pointer to the infoType in the
  40 B<itav>.
  41
  42 OSSL_CMP_ITAV_get0_value() returns a direct pointer to the infoValue in
  43 the B<itav> as generic ASN1_TYPE*.
  44
  45 OSSL_CMP_ITAV_push0_stack_item() pushes B<itav> to the stack pointed to
  46 by B<*itav_sk_p>. It creates a new stack if B<*itav_sk_p> points to NULL.
  47
  48 =head1 NOTES
  49
  50 CMP is defined in RFC 4210 (and CRMF in RFC 4211).
  51
  52 =head1 RETURN VALUES
  53
  54 OSSL_CMP_ITAV_create() returns a pointer to the ITAV structure on success,
  55 or NULL on error.
  56
  57 OSSL_CMP_ITAV_set0() does not return a value.
  58
  59 OSSL_CMP_ITAV_get0_type() and OSSL_CMP_ITAV_get0_value()
  60 return the respective pointer or NULL if their input is NULL.
  61
  62 OSSL_CMP_ITAV_push0_stack_item() returns 1 on success, 0 on error.
  63
  64 =head1 EXAMPLES
  65
  66 The following code creates and sets a structure representing a generic
  67 InfoTypeAndValue sequence, using an OID created from text as type, and an
  68 integer as value. Afterwards, it is pushed to the OSSL_CMP_CTX to be later
  69 included in the requests' PKIHeader's genInfo field.
  70
  71     ASN1_OBJECT *type = OBJ_txt2obj("1.2.3.4.5", 1);
  72     if (type == NULL) ...
  73
  74     ASN1_INTEGER *asn1int = ASN1_INTEGER_new();
  75     if (asn1int == NULL || !ASN1_INTEGER_set(asn1int, 12345)) ...
  76
  77     ASN1_TYPE *val = ASN1_TYPE_new();
  78     if (val == NULL) ...
  79     ASN1_TYPE_set(val, V_ASN1_INTEGER, asn1int);
  80
  81     OSSL_CMP_ITAV *itav = OSSL_CMP_ITAV_create(type, val);
  82     if (itav == NULL) ...
  83
  84     OSSL_CMP_CTX *ctx = OSSL_CMP_CTX_new();
  85     if (ctx == NULL || !OSSL_CMP_CTX_geninfo_push0_ITAV(ctx, itav)) {
  86         OSSL_CMP_ITAV_free(itav); /* also frees type and val */
  87         goto err;
  88     }
  89
  90     ...
  91
  92     OSSL_CMP_CTX_free(ctx); /* also frees itav */
  93
  94 =head1 SEE ALSO
  95
  96 L<OSSL_CMP_CTX_new(3)>, L<OSSL_CMP_CTX_free(3)>, L<ASN1_TYPE_set(3)>
  97
  98 =head1 HISTORY
  99
 100 The OpenSSL CMP support was added in OpenSSL 3.0.
 101
 102 =head1 COPYRIGHT
 103
 104 Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
 105
 106 Licensed under the Apache License 2.0 (the "License").  You may not use
 107 this file except in compliance with the License.  You can obtain a copy
 108 in the file LICENSE in the source distribution or at
 109 L<https://www.openssl.org/source/license.html>.
 110
 111 =cut