lib/libcrypto/man/DIST_POINT_new.3

   1 .\"     $OpenBSD: DIST_POINT_new.3,v 1.4 2018/03/23 04:34:23 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 23 2018 $
  18 .Dt DIST_POINT_NEW 3
  19 .Os
  20 .Sh NAME
  21 .Nm DIST_POINT_new ,
  22 .Nm DIST_POINT_free ,
  23 .Nm CRL_DIST_POINTS_new ,
  24 .Nm CRL_DIST_POINTS_free ,
  25 .Nm DIST_POINT_NAME_new ,
  26 .Nm DIST_POINT_NAME_free ,
  27 .Nm ISSUING_DIST_POINT_new ,
  28 .Nm ISSUING_DIST_POINT_free
  29 .Nd X.509 CRL distribution point extensions
  30 .Sh SYNOPSIS
  31 .In openssl/x509v3.h
  32 .Ft DIST_POINT *
  33 .Fn DIST_POINT_new void
  34 .Ft void
  35 .Fn DIST_POINT_free "DIST_POINT *dp"
  36 .Ft CRL_DIST_POINTS *
  37 .Fn CRL_DIST_POINTS_new void
  38 .Ft void
  39 .Fn CRL_DIST_POINTS_free "CRL_DIST_POINTS *dps"
  40 .Ft DIST_POINT_NAME *
  41 .Fn DIST_POINT_NAME_new void
  42 .Ft void
  43 .Fn DIST_POINT_NAME_free "DIST_POINT_NAME *name"
  44 .Ft ISSUING_DIST_POINT *
  45 .Fn ISSUING_DIST_POINT_new void
  46 .Ft void
  47 .Fn ISSUING_DIST_POINT_free "ISSUING_DIST_POINT *dp"
  48 .Sh DESCRIPTION
  49 Using the CRL distribution point extension, a certificate can specify
  50 where to obtain certificate revocation lists that might later revoke it.
  51 .Pp
  52 .Fn DIST_POINT_new
  53 allocates and initializes an empty
  54 .Vt DIST_POINT
  55 object, representing an ASN.1
  56 .Vt DistributionPoint
  57 structure defined in RFC 5280 section 4.2.1.13.
  58 It can hold issuer names, distribution point names, and reason flags.
  59 .Fn DIST_POINT_free
  60 frees
  61 .Fa dp .
  62 .Pp
  63 .Fn CRL_DIST_POINTS_new
  64 allocates and initializes an empty
  65 .Vt CRL_DIST_POINTS
  66 object, which is a
  67 .Vt STACK_OF(DIST_POINT)
  68 and represents the ASN.1
  69 .Vt CRLDistributionPoints
  70 structure defined in RFC 5280 section 4.2.1.13.
  71 It can be used as an extension in
  72 .Vt X509
  73 and in
  74 .Vt X509_CRL
  75 objects.
  76 .Fn CRL_DIST_POINTS_free
  77 frees
  78 .Fa dps .
  79 .Pp
  80 .Fn DIST_POINT_NAME_new
  81 allocates and initializes an empty
  82 .Vt DIST_POINT_NAME
  83 object, representing an ASN.1
  84 .Vt DistributionPointName
  85 structure defined in RFC 5280 section 4.2.1.13.
  86 It is used by the
  87 .Vt DIST_POINT
  88 and
  89 .Vt ISSUING_DIST_POINT
  90 objects and can hold multiple names, each representing a different
  91 way to obtain the same CRL.
  92 .Fn DIST_POINT_NAME_free
  93 frees
  94 .Fa name .
  95 .Pp
  96 .Fn ISSUING_DIST_POINT_new
  97 allocates and initializes an empty
  98 .Vt ISSUING_DIST_POINT
  99 object, representing an ASN.1
 100 .Vt IssuingDistributionPoint
 101 structure defined in RFC 5280 section 5.2.5.
 102 Using this extension, a CRL can specify which distribution point
 103 it was issued from and which kinds of certificates and revocation
 104 reasons it covers.
 105 .Fn ISSUING_DIST_POINT_free
 106 frees
 107 .Fa dp .
 108 .Sh RETURN VALUES
 109 .Fn DIST_POINT_new ,
 110 .Fn CRL_DIST_POINTS_new ,
 111 .Fn DIST_POINT_NAME_new ,
 112 and
 113 .Fn ISSUING_DIST_POINT_new
 114 return the new
 115 .Vt DIST_POINT ,
 116 .Vt CRL_DIST_POINTS ,
 117 .Vt DIST_POINT_NAME ,
 118 or
 119 .Vt ISSUING_DIST_POINT
 120 object, respectively, or
 121 .Dv NULL
 122 if an error occurs.
 123 .Sh SEE ALSO
 124 .Xr GENERAL_NAMES_new 3 ,
 125 .Xr X509_CRL_new 3 ,
 126 .Xr X509_EXTENSION_new 3 ,
 127 .Xr X509_NAME_new 3 ,
 128 .Xr X509_new 3
 129 .Sh STANDARDS
 130 RFC 5280: Internet X.509 Public Key Infrastructure Certificate and
 131 Certificate Revocation List (CRL) Profile:
 132 .Bl -dash -compact
 133 .It
 134 section 4.2.1.13: CRL Distribution Points
 135 .It
 136 section 5.2.5: Issuing Distribution Point
 137 .El
 138 .Sh HISTORY
 139 .Fn DIST_POINT_new ,
 140 .Fn DIST_POINT_free ,
 141 .Fn CRL_DIST_POINTS_new ,
 142 .Fn CRL_DIST_POINTS_free ,
 143 .Fn DIST_POINT_NAME_new ,
 144 and
 145 .Fn DIST_POINT_NAME_free
 146 first appeared in OpenSSL 0.9.3 and have been available since
 147 .Ox 2.6 .
 148 .Pp
 149 .Fn ISSUING_DIST_POINT_new
 150 and
 151 .Fn ISSUING_DIST_POINT_free
 152 first appeared in OpenSSL 1.0.0 and have been available since
 153 .Ox 4.9 .