]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - secure/lib/libcrypto/man/X509_get0_notBefore.3
MFC: r352191
[FreeBSD/FreeBSD.git] / secure / lib / libcrypto / man / X509_get0_notBefore.3
1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.39)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
60 .    if \nF \{\
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{\
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "X509_GET0_NOTBEFORE 3"
136 .TH X509_GET0_NOTBEFORE 3 "2019-09-10" "1.1.1d" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 X509_get0_notBefore, X509_getm_notBefore, X509_get0_notAfter, X509_getm_notAfter, X509_set1_notBefore, X509_set1_notAfter, X509_CRL_get0_lastUpdate, X509_CRL_get0_nextUpdate, X509_CRL_set1_lastUpdate, X509_CRL_set1_nextUpdate \- get or set certificate or CRL dates
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 1
146 \& #include <openssl/x509.h>
147 \&
148 \& const ASN1_TIME *X509_get0_notBefore(const X509 *x);
149 \& const ASN1_TIME *X509_get0_notAfter(const X509 *x);
150 \&
151 \& ASN1_TIME *X509_getm_notBefore(const X509 *x);
152 \& ASN1_TIME *X509_getm_notAfter(const X509 *x);
153 \&
154 \& int X509_set1_notBefore(X509 *x, const ASN1_TIME *tm);
155 \& int X509_set1_notAfter(X509 *x, const ASN1_TIME *tm);
156 \&
157 \& const ASN1_TIME *X509_CRL_get0_lastUpdate(const X509_CRL *crl);
158 \& const ASN1_TIME *X509_CRL_get0_nextUpdate(const X509_CRL *crl);
159 \&
160 \& int X509_CRL_set1_lastUpdate(X509_CRL *x, const ASN1_TIME *tm);
161 \& int X509_CRL_set1_nextUpdate(X509_CRL *x, const ASN1_TIME *tm);
162 .Ve
163 .SH "DESCRIPTION"
164 .IX Header "DESCRIPTION"
165 \&\fBX509_get0_notBefore()\fR and \fBX509_get0_notAfter()\fR return the \fBnotBefore\fR
166 and \fBnotAfter\fR fields of certificate \fBx\fR respectively. The value
167 returned is an internal pointer which must not be freed up after
168 the call.
169 .PP
170 \&\fBX509_getm_notBefore()\fR and \fBX509_getm_notAfter()\fR are similar to
171 \&\fBX509_get0_notBefore()\fR and \fBX509_get0_notAfter()\fR except they return
172 non-constant mutable references to the associated date field of
173 the certificate.
174 .PP
175 \&\fBX509_set1_notBefore()\fR and \fBX509_set1_notAfter()\fR set the \fBnotBefore\fR
176 and \fBnotAfter\fR fields of \fBx\fR to \fBtm\fR. Ownership of the passed
177 parameter \fBtm\fR is not transferred by these functions so it must
178 be freed up after the call.
179 .PP
180 \&\fBX509_CRL_get0_lastUpdate()\fR and \fBX509_CRL_get0_nextUpdate()\fR return the
181 \&\fBlastUpdate\fR and \fBnextUpdate\fR fields of \fBcrl\fR. The value
182 returned is an internal pointer which must not be freed up after
183 the call. If the \fBnextUpdate\fR field is absent from \fBcrl\fR then
184 \&\fB\s-1NULL\s0\fR is returned.
185 .PP
186 \&\fBX509_CRL_set1_lastUpdate()\fR and \fBX509_CRL_set1_nextUpdate()\fR set the \fBlastUpdate\fR
187 and \fBnextUpdate\fR fields of \fBcrl\fR to \fBtm\fR. Ownership of the passed parameter
188 \&\fBtm\fR is not transferred by these functions so it must be freed up after the
189 call.
190 .SH "RETURN VALUES"
191 .IX Header "RETURN VALUES"
192 \&\fBX509_get0_notBefore()\fR, \fBX509_get0_notAfter()\fR and \fBX509_CRL_get0_lastUpdate()\fR
193 return a pointer to an \fB\s-1ASN1_TIME\s0\fR structure.
194 .PP
195 \&\fBX509_CRL_get0_lastUpdate()\fR return a pointer to an \fB\s-1ASN1_TIME\s0\fR structure
196 or \s-1NULL\s0 if the \fBlastUpdate\fR field is absent.
197 .PP
198 \&\fBX509_set1_notBefore()\fR, \fBX509_set1_notAfter()\fR, \fBX509_CRL_set1_lastUpdate()\fR and
199 \&\fBX509_CRL_set1_nextUpdate()\fR return 1 for success or 0 for failure.
200 .SH "SEE ALSO"
201 .IX Header "SEE ALSO"
202 \&\fBd2i_X509\fR\|(3),
203 \&\fBERR_get_error\fR\|(3),
204 \&\fBX509_CRL_get0_by_serial\fR\|(3),
205 \&\fBX509_get0_signature\fR\|(3),
206 \&\fBX509_get_ext_d2i\fR\|(3),
207 \&\fBX509_get_extension_flags\fR\|(3),
208 \&\fBX509_get_pubkey\fR\|(3),
209 \&\fBX509_get_subject_name\fR\|(3),
210 \&\fBX509_NAME_add_entry_by_txt\fR\|(3),
211 \&\fBX509_NAME_ENTRY_get_object\fR\|(3),
212 \&\fBX509_NAME_get_index_by_NID\fR\|(3),
213 \&\fBX509_NAME_print_ex\fR\|(3),
214 \&\fBX509_new\fR\|(3),
215 \&\fBX509_sign\fR\|(3),
216 \&\fBX509V3_get_d2i\fR\|(3),
217 \&\fBX509_verify_cert\fR\|(3)
218 .SH "HISTORY"
219 .IX Header "HISTORY"
220 These functions are available in all versions of OpenSSL.
221 .PP
222 \&\fBX509_get_notBefore()\fR and \fBX509_get_notAfter()\fR were deprecated in OpenSSL
223 1.1.0
224 .SH "COPYRIGHT"
225 .IX Header "COPYRIGHT"
226 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
227 .PP
228 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
229 this file except in compliance with the License.  You can obtain a copy
230 in the file \s-1LICENSE\s0 in the source distribution or at
231 <https://www.openssl.org/source/license.html>.