summaryrefslogtreecommitdiff
path: root/lib/libcrypto/man/ACCESS_DESCRIPTION_new.3
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2016-12-23 22:21:41 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2016-12-23 22:21:41 +0000
commit7c4f28e2dd62921bb200d4d53cf54df307874479 (patch)
treef1d2a049c45723866747137ef3a364cfd495e094 /lib/libcrypto/man/ACCESS_DESCRIPTION_new.3
parent58f9d79dc4f0d05f2385409ae6ec23480cd74152 (diff)
Write ACCESS_DESCRIPTION_new(3) manual page from scratch.
All four functions are listed in <openssl/x509v3.h> and in OpenSSL doc/man3/X509_dup.pod. OpenSSL documentation specifies the wrong header file.
Diffstat (limited to 'lib/libcrypto/man/ACCESS_DESCRIPTION_new.3')
-rw-r--r--lib/libcrypto/man/ACCESS_DESCRIPTION_new.3140
1 files changed, 140 insertions, 0 deletions
diff --git a/lib/libcrypto/man/ACCESS_DESCRIPTION_new.3 b/lib/libcrypto/man/ACCESS_DESCRIPTION_new.3
new file mode 100644
index 00000000000..18e50e24c0f
--- /dev/null
+++ b/lib/libcrypto/man/ACCESS_DESCRIPTION_new.3
@@ -0,0 +1,140 @@
+.\" $OpenBSD: ACCESS_DESCRIPTION_new.3,v 1.1 2016/12/23 22:21:40 schwarze Exp $
+.\"
+.\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: December 23 2016 $
+.Dt ACCESS_DESCRIPTION_NEW 3
+.Os
+.Sh NAME
+.Nm ACCESS_DESCRIPTION_new ,
+.Nm ACCESS_DESCRIPTION_free ,
+.Nm AUTHORITY_INFO_ACCESS_new ,
+.Nm AUTHORITY_INFO_ACCESS_free
+.Nd X.509 information access extensions
+.Sh SYNOPSIS
+.In openssl/x509v3.h
+.Ft ACCESS_DESCRIPTION *
+.Fn ACCESS_DESCRIPTION_new void
+.Ft void
+.Fn ACCESS_DESCRIPTION_free "ACCESS_DESCRIPTION *ad"
+.Ft AUTHORITY_INFO_ACCESS
+.Fn AUTHORITY_INFO_ACCESS_new void
+.Ft void
+.Fn AUTHORITY_INFO_ACCESS_free "AUTHORITY_INFO_ACCESS *aia"
+.Sh DESCRIPTION
+Using the information access extensions, certificates and certificate
+revocation lists can point to auxiliary information and services
+available online, for example online validation services or CA
+policy data.
+.Pp
+.Fn ACCESS_DESCRIPTION_new
+allocates and initializes an empty
+.Vt ACCESS_DESCRIPTION
+object, representing an ASN.1 AccessDescription structure
+defined in RFC 5280 section 4.2.2.1.
+It can hold a pointer to a
+.Vt GENERAL_NAME
+object documented in
+.Xr GENERAL_NAME_new 3
+and an access method identifier.
+.Fn ACCESS_DESCRIPTION_free
+frees
+.Fa ad .
+.Pp
+The access method identifier is somewhat misnamed; it identifies
+the type and format of the information provided.
+How to access that information is often obvious from the
+.Vt GENERAL_NAME
+which may for example include a uniform resource identifier.
+.Pp
+Four standard access method identifiers are defined in RFC 5280:
+.Bl -bullet
+.It
+.Qq id-ad-caIssuers
+can occur in the authority information access extension of certificates
+and certificate revocation lists and provides access to certificates
+issued to the CA that issued the certificate, or provides access
+to certificates used for signing the CRL, in order to help constructing
+a certification path.
+.It
+.Qq id-ad-ocsp
+can occur in the authority information access extension of certificates
+and provides access to revocation information via the Online
+Certificate Status Protocol (OCSP) defined in RFC 6960.
+.It
+.Qq id-ad-caRepository
+can occur in the subject information access extension of CA
+certificates and provides access to an online repository of
+certificates issued by the CA.
+.It
+.Qq id-ad-timeStamping
+can occur in the subject information access extension of end entity
+certificates and indicates that the subject offers timestamping
+services using the Time Stamp Protocol defined in RFC 3161.
+.El
+.Pp
+.Fn AUTHORITY_INFO_ACCESS_new
+allocates and initializes an empty
+.Vt AUTHORITY_INFO_ACCESS
+object, which is a
+.Vt STACK_OF(ACCESS_DESCRIPTION)
+and represents an ASN.1 AuthorityInfoAccessSyntax structure
+defined in RFC 5280 section 4.2.2.1.
+If can be used for the authority information access extension of
+certificates and certificate revocation lists and for the subject
+information access extension of certificates.
+.Fn AUTHORITY_INFO_ACCESS_free
+frees
+.Fa aia .
+.Sh RETURN VALUE
+.Fn ACCESS_DESCRIPTION_new
+and
+.Fn AUTHORITY_INFO_ACCESS_new
+return the new
+.Vt ACCESS_DESCRIPTION
+or
+.Vt AUTHORITY_INFO_ACCESS
+object, respectively, or
+.Dv NULL
+if an error occurs.
+.Sh SEE ALSO
+.Xr DIST_POINT_new 3 ,
+.Xr GENERAL_NAME_new 3 ,
+.Xr OCSP_REQUEST_new 3 ,
+.Xr TS_REQ_new 3 ,
+.Xr X509_CRL_new 3 ,
+.Xr X509_EXTENSION_new 3 ,
+.Xr X509_new 3
+.Sh STANDARDS
+These extensions are only defined in the following RFC and not
+specified in the underlying X.509 standard.
+.Pp
+RFC 5280: Internet X.509 Public Key Infrastructure Certificate and
+Certificate Revocation List (CRL) Profile:
+.Bl -dash -compact
+.It
+section 4.2.2.1: Certificate Extensions: Authority Information Access
+.It
+section 4.2.2.2: Certificate Extensions: Subject Information Access
+.It
+section 5.2.7: CRL Extensions: Authority Information Access
+.El
+.Pp
+Regarding OCSP and TSP, see:
+.Pp
+RFC 6960: X.509 Internet Public Key Infrastructure Online Certificate
+Status Protocol
+.Pp
+RFC 3161: Internet X.509 Public Key Infrastructure Time-Stamp Protocol