lib/libcrypto/man/d2i_GENERAL_NAME.3

   1 .\"     $OpenBSD: d2i_GENERAL_NAME.3,v 1.4 2018/03/22 21:08:22 schwarze Exp $
   2 .\"
   3 .\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .Dd $Mdocdate: March 22 2018 $
  18 .Dt D2I_GENERAL_NAME 3
  19 .Os
  20 .Sh NAME
  21 .Nm d2i_GENERAL_NAME ,
  22 .Nm i2d_GENERAL_NAME ,
  23 .Nm d2i_GENERAL_NAMES ,
  24 .Nm i2d_GENERAL_NAMES ,
  25 .Nm d2i_EDIPARTYNAME ,
  26 .Nm i2d_EDIPARTYNAME ,
  27 .Nm d2i_OTHERNAME ,
  28 .Nm i2d_OTHERNAME
  29 .Nd decode and encode names for use in X.509 extensions
  30 .Sh SYNOPSIS
  31 .In openssl/x509v3.h
  32 .Ft GENERAL_NAME *
  33 .Fo d2i_GENERAL_NAME
  34 .Fa "GENERAL_NAME **val_out"
  35 .Fa "const unsigned char **der_in"
  36 .Fa "long length"
  37 .Fc
  38 .Ft int
  39 .Fo i2d_GENERAL_NAME
  40 .Fa "GENERAL_NAME *val_in"
  41 .Fa "unsigned char **der_out"
  42 .Fc
  43 .Ft GENERAL_NAMES *
  44 .Fo d2i_GENERAL_NAMES
  45 .Fa "GENERAL_NAMES **val_out"
  46 .Fa "const unsigned char **der_in"
  47 .Fa "long length"
  48 .Fc
  49 .Ft int
  50 .Fo i2d_GENERAL_NAMES
  51 .Fa "GENERAL_NAMES *val_in"
  52 .Fa "unsigned char **der_out"
  53 .Fc
  54 .Ft EDIPARTYNAME *
  55 .Fo d2i_EDIPARTYNAME
  56 .Fa "EDIPARTYNAME **val_out"
  57 .Fa "const unsigned char **der_in"
  58 .Fa "long length"
  59 .Fc
  60 .Ft int
  61 .Fo i2d_EDIPARTYNAME
  62 .Fa "EDIPARTYNAME *val_in"
  63 .Fa "unsigned char **der_out"
  64 .Fc
  65 .Ft OTHERNAME *
  66 .Fo d2i_OTHERNAME
  67 .Fa "OTHERNAME **val_out"
  68 .Fa "const unsigned char **der_in"
  69 .Fa "long length"
  70 .Fc
  71 .Ft int
  72 .Fo i2d_OTHERNAME
  73 .Fa "OTHERNAME *val_in"
  74 .Fa "unsigned char **der_out"
  75 .Fc
  76 .Sh DESCRIPTION
  77 These functions decode and encode names that can be used in X.509
  78 extensions.
  79 For details about the semantics, examples, caveats, and bugs, see
  80 .Xr ASN1_item_d2i 3 .
  81 .Pp
  82 .Fn d2i_GENERAL_NAME
  83 and
  84 .Fn i2d_GENERAL_NAME
  85 decode and encode an ASN.1
  86 .Vt GeneralName
  87 structure defined in RFC 5280 section 4.2.1.6.
  88 .Pp
  89 .Fn d2i_GENERAL_NAMES
  90 and
  91 .Fn i2d_GENERAL_NAMES
  92 decode and encode an ASN.1
  93 .Vt GeneralNames
  94 structure defined in RFC 5280 section 4.2.1.6.
  95 .Pp
  96 .Fn d2i_EDIPARTYNAME
  97 and
  98 .Fn i2d_EDIPARTYNAME
  99 decode and encode an ASN.1
 100 .Vt EDIPartyName
 101 structure defined in RFC 5280 section 4.2.1.6.
 102 .Pp
 103 .Fn d2i_OTHERNAME
 104 and
 105 .Fn i2d_OTHERNAME
 106 decode and encode an ASN.1
 107 .Vt OtherName
 108 structure defined in RFC 5280 section 4.2.1.6.
 109 .Sh RETURN VALUES
 110 .Fn d2i_GENERAL_NAME ,
 111 .Fn d2i_GENERAL_NAMES ,
 112 .Fn d2i_EDIPARTYNAME ,
 113 and
 114 .Fn d2i_OTHERNAME
 115 return a
 116 .Vt GENERAL_NAME ,
 117 .Vt GENERAL_NAMES ,
 118 .Vt EDIPARTYNAME ,
 119 or
 120 .Vt OTHERNAME
 121 object, respectively, or
 122 .Dv NULL
 123 if an error occurs.
 124 .Pp
 125 .Fn i2d_GENERAL_NAME ,
 126 .Fn i2d_GENERAL_NAMES ,
 127 .Fn i2d_EDIPARTYNAME ,
 128 and
 129 .Fn i2d_OTHERNAME
 130 return the number of bytes successfully encoded or a negative value
 131 if an error occurs.
 132 .Sh SEE ALSO
 133 .Xr ASN1_item_d2i 3 ,
 134 .Xr d2i_X509_NAME 3 ,
 135 .Xr GENERAL_NAME_new 3 ,
 136 .Xr X509_EXTENSION_new 3
 137 .Sh STANDARDS
 138 RFC 5280: Internet X.509 Public Key Infrastructure Certificate and
 139 Certificate Revocation List (CRL) Profile,
 140 section 4.2: Certificate Extensions
 141 .Sh HISTORY
 142 .Fn d2i_GENERAL_NAME ,
 143 .Fn i2d_GENERAL_NAME ,
 144 .Fn d2i_GENERAL_NAMES ,
 145 and
 146 .Fn i2d_GENERAL_NAMES
 147 first appeared in OpenSSL 0.9.2b and have been available since
 148 .Ox 2.6 .
 149 .Pp
 150 .Fn d2i_OTHERNAME
 151 and
 152 .Fn i2d_OTHERNAME
 153 first appeared in OpenSSL 0.9.5 and have been available since
 154 .Ox 2.7 .
 155 .Pp
 156 .Fn d2i_EDIPARTYNAME
 157 and
 158 .Fn i2d_EDIPARTYNAME
 159 first appeared in OpenSSL 0.9.7 and have been available since
 160 .Ox 3.2 .