diff options
author | schwarze <> | 2016-12-05 18:24:08 +0000 |
---|---|---|
committer | schwarze <> | 2016-12-05 18:24:08 +0000 |
commit | 5e667a70479419d08aa5042c692cf8c3ff282916 (patch) | |
tree | b8ddcc29259acd8efd50cf94425421827a385a2d /src/lib/libcrypto/man/X509_get_version.3 | |
parent | d5694b0bdfc7bb2ce8043ccab2f3e6c1bb8b33e8 (diff) | |
download | openbsd-5e667a70479419d08aa5042c692cf8c3ff282916.tar.gz openbsd-5e667a70479419d08aa5042c692cf8c3ff282916.tar.bz2 openbsd-5e667a70479419d08aa5042c692cf8c3ff282916.zip |
import the relevant parts of six more X509 manuals from OpenSSL
Diffstat (limited to 'src/lib/libcrypto/man/X509_get_version.3')
-rw-r--r-- | src/lib/libcrypto/man/X509_get_version.3 | 149 |
1 files changed, 149 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/X509_get_version.3 b/src/lib/libcrypto/man/X509_get_version.3 new file mode 100644 index 0000000000..6e35f3df31 --- /dev/null +++ b/src/lib/libcrypto/man/X509_get_version.3 | |||
@@ -0,0 +1,149 @@ | |||
1 | .\" $OpenBSD: X509_get_version.3,v 1.1 2016/12/05 18:24:08 schwarze Exp $ | ||
2 | .\" OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 | ||
3 | .\" | ||
4 | .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. | ||
5 | .\" Copyright (c) 2015, 2016 The OpenSSL Project. All rights reserved. | ||
6 | .\" | ||
7 | .\" Redistribution and use in source and binary forms, with or without | ||
8 | .\" modification, are permitted provided that the following conditions | ||
9 | .\" are met: | ||
10 | .\" | ||
11 | .\" 1. Redistributions of source code must retain the above copyright | ||
12 | .\" notice, this list of conditions and the following disclaimer. | ||
13 | .\" | ||
14 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
15 | .\" notice, this list of conditions and the following disclaimer in | ||
16 | .\" the documentation and/or other materials provided with the | ||
17 | .\" distribution. | ||
18 | .\" | ||
19 | .\" 3. All advertising materials mentioning features or use of this | ||
20 | .\" software must display the following acknowledgment: | ||
21 | .\" "This product includes software developed by the OpenSSL Project | ||
22 | .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | ||
23 | .\" | ||
24 | .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to | ||
25 | .\" endorse or promote products derived from this software without | ||
26 | .\" prior written permission. For written permission, please contact | ||
27 | .\" openssl-core@openssl.org. | ||
28 | .\" | ||
29 | .\" 5. Products derived from this software may not be called "OpenSSL" | ||
30 | .\" nor may "OpenSSL" appear in their names without prior written | ||
31 | .\" permission of the OpenSSL Project. | ||
32 | .\" | ||
33 | .\" 6. Redistributions of any form whatsoever must retain the following | ||
34 | .\" acknowledgment: | ||
35 | .\" "This product includes software developed by the OpenSSL Project | ||
36 | .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" | ||
37 | .\" | ||
38 | .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY | ||
39 | .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
40 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
41 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR | ||
42 | .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
43 | .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | ||
44 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
45 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
46 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
47 | .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | ||
49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | ||
50 | .\" | ||
51 | .Dd $Mdocdate: December 5 2016 $ | ||
52 | .Dt X509_GET_VERSION 3 | ||
53 | .Os | ||
54 | .Sh NAME | ||
55 | .Nm X509_get_version , | ||
56 | .Nm X509_set_version , | ||
57 | .Nm X509_REQ_get_version , | ||
58 | .Nm X509_REQ_set_version , | ||
59 | .Nm X509_CRL_get_version , | ||
60 | .Nm X509_CRL_set_version | ||
61 | .Nd get or set certificate, certificate request, or CRL version | ||
62 | .Sh SYNOPSIS | ||
63 | .In openssl/x509.h | ||
64 | .Ft long | ||
65 | .Fo X509_get_version | ||
66 | .Fa "const X509 *x" | ||
67 | .Fc | ||
68 | .Ft int | ||
69 | .Fo X509_set_version | ||
70 | .Fa "X509 *x" | ||
71 | .Fa "long version" | ||
72 | .Fc | ||
73 | .Ft long | ||
74 | .Fo X509_REQ_get_version | ||
75 | .Fa "const X509_REQ *req" | ||
76 | .Fc | ||
77 | .Ft int | ||
78 | .Fo X509_REQ_set_version | ||
79 | .Fa "X509_REQ *x" | ||
80 | .Fa "long version" | ||
81 | .Fc | ||
82 | .Ft long | ||
83 | .Fo X509_CRL_get_version | ||
84 | .Fa "const X509_CRL *crl" | ||
85 | .Fc | ||
86 | .Ft int | ||
87 | .Fo X509_CRL_set_version | ||
88 | .Fa "X509_CRL *x" | ||
89 | .Fa "long version" | ||
90 | .Fc | ||
91 | .Sh DESCRIPTION | ||
92 | .Fn X509_get_version | ||
93 | returns the numerical value of the version field of certificate | ||
94 | .Fa x . | ||
95 | Note: this is defined by standards (X.509 et al.) to be one less | ||
96 | than the certificate version. | ||
97 | So a version 3 certificate will return 2 and a version 1 certificate | ||
98 | will return 0. | ||
99 | .Pp | ||
100 | .Fn X509_set_version | ||
101 | sets the numerical value of the version field of certificate | ||
102 | .Fa x | ||
103 | to | ||
104 | .Fa version . | ||
105 | .Pp | ||
106 | Similarly | ||
107 | .Fn X509_REQ_get_version , | ||
108 | .Fn X509_REQ_set_version , | ||
109 | .Fn X509_CRL_get_version , | ||
110 | and | ||
111 | .Fn X509_CRL_set_version | ||
112 | get and set the version number of certificate requests and CRLs. | ||
113 | .Pp | ||
114 | The version field of certificates, certificate requests, and CRLs | ||
115 | has a DEFAULT value of v1(0) meaning the field should be omitted | ||
116 | for version 1. | ||
117 | This is handled transparently by these functions. | ||
118 | .Pp | ||
119 | .Fn X509_get_version , | ||
120 | .Fn X509_REQ_get_version | ||
121 | and | ||
122 | .Fn X509_CRL_get_version | ||
123 | are implemented as macros. | ||
124 | .Sh RETURN VALUES | ||
125 | .Fn X509_get_version , | ||
126 | .Fn X509_REQ_get_version , | ||
127 | and | ||
128 | .Fn X509_CRL_get_version | ||
129 | return the numerical value of the version field. | ||
130 | .Pp | ||
131 | .Fn X509_set_version , | ||
132 | .Fn X509_REQ_set_version , | ||
133 | and | ||
134 | .Fn X509_CRL_set_version | ||
135 | return 1 for success or 0 for failure. | ||
136 | .Sh SEE ALSO | ||
137 | .Xr d2i_X509 3 , | ||
138 | .Xr ERR_get_error 3 , | ||
139 | .Xr X509_CRL_get0_by_serial 3 , | ||
140 | .Xr X509_get_pubkey 3 , | ||
141 | .Xr X509_get_subject_name 3 , | ||
142 | .Xr X509_NAME_add_entry_by_txt 3 , | ||
143 | .Xr X509_NAME_ENTRY_get_object 3 , | ||
144 | .Xr X509_NAME_get_index_by_NID 3 , | ||
145 | .Xr X509_NAME_print_ex 3 , | ||
146 | .Xr X509_new 3 , | ||
147 | .Xr X509_sign 3 , | ||
148 | .Xr X509_verify_cert 3 , | ||
149 | .Xr X509V3_get_d2i 3 | ||