← Back to branch summary

~myers-1/pyopenssl/npn

« back to all changes in this revision

Viewing changes to doc/html/openssl-x509.html

  • Committer: Jean-Paul Calderone
  • Date: 2011-04-11 23:26:11 UTC
  • mfrom: (143.1.6 release-0.12)
  • Revision ID: exarkun@divmod.com-20110411232611-z1xtswwjxqorzjrn
Merge 0.12 release branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/openssl-x509.html
1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
2
<html>
3
3
<head>
4
 
<title>3.1.1 X509 objects </title>
5
 
<META NAME="description" CONTENT="3.1.1 X509 objects ">
 
4
<title>3.1.2 X509 objects </title>
 
5
<META NAME="description" CONTENT="3.1.2 X509 objects ">
6
6
<META NAME="keywords" CONTENT="pyOpenSSL">
7
7
<META NAME="resource-type" CONTENT="document">
8
8
<META NAME="distribution" CONTENT="global">
9
9
<link rel="STYLESHEET" href="pyOpenSSL.css">
10
10
<LINK REL="next" href="openssl-x509name.html">
11
 
<LINK REL="previous" href="openssl-crypto.html">
 
11
<LINK REL="previous" href="openssl-x509ext.html">
12
12
<LINK REL="up" href="openssl-crypto.html">
13
13
<LINK REL="next" href="openssl-x509name.html">
14
14
</head>
16
16
<DIV CLASS="navigation">
17
17
<table align="center" width="100%" cellpadding="0" cellspacing="2">
18
18
<tr>
19
 
<td><A href="openssl-crypto.html"><img src="previous.gif"
 
19
<td><A href="openssl-x509ext.html"><img src="previous.gif"
20
20
  border="0" height="32"
21
21
  alt="Previous Page" width="32"></A></td>
22
22
<td><A href="openssl-crypto.html"><img src="up.gif"
36
36
  border="0" height="32"
37
37
  alt="" width="32"></td>
38
38
</tr></table>
39
 
<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto  </A>
 
39
<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509ext.html">3.1.1 X509Extension objects</A>
40
40
<b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto  </A>
41
 
<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509name.html">3.1.2 X509Name objects</A>
 
41
<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509name.html">3.1.3 X509Name objects</A>
42
42
<br><hr>
43
43
</DIV>
44
44
<!--End of Navigation Panel-->
45
45
 
46
 
<H3><A NAME="SECTION000411000000000000000">&nbsp;</A>
 
46
<H3><A NAME="SECTION000412000000000000000">&nbsp;</A>
47
47
<BR>
48
 
3.1.1 X509 objects 
 
48
3.1.2 X509 objects 
49
49
</H3>
50
50
 
51
51
<P>
52
52
X509 objects have the following methods:
53
53
 
54
54
<P>
55
 
<dl><dt><b><a name='l2h-39'><tt class='method'>get_issuer</tt></a></b>()
 
55
<dl><dt><b><a name='l2h-41'><tt class='method'>get_issuer</tt></a></b>()
56
56
<dd>
57
57
Return an X509Name object representing the issuer of the certificate.
58
58
</dl>
59
59
 
60
60
<P>
61
 
<dl><dt><b><a name='l2h-40'><tt class='method'>get_pubkey</tt></a></b>()
 
61
<dl><dt><b><a name='l2h-42'><tt class='method'>get_pubkey</tt></a></b>()
62
62
<dd>
63
63
Return a PKey object representing the public key of the certificate.
64
64
</dl>
65
65
 
66
66
<P>
67
 
<dl><dt><b><a name='l2h-41'><tt class='method'>get_serial_number</tt></a></b>()
 
67
<dl><dt><b><a name='l2h-43'><tt class='method'>get_serial_number</tt></a></b>()
68
68
<dd>
69
69
Return the certificate serial number.
70
70
</dl>
71
71
 
72
72
<P>
73
 
<dl><dt><b><a name='l2h-42'><tt class='method'>get_subject</tt></a></b>()
 
73
<dl><dt><b><a name='l2h-44'><tt class='method'>get_subject</tt></a></b>()
74
74
<dd>
75
75
Return an X509Name object representing the subject of the certificate.
76
76
</dl>
77
77
 
78
78
<P>
79
 
<dl><dt><b><a name='l2h-43'><tt class='method'>get_version</tt></a></b>()
 
79
<dl><dt><b><a name='l2h-45'><tt class='method'>get_version</tt></a></b>()
80
80
<dd>
81
81
Return the certificate version.
82
82
</dl>
83
83
 
84
84
<P>
85
 
<dl><dt><b><a name='l2h-44'><tt class='method'>get_notBefore</tt></a></b>()
 
85
<dl><dt><b><a name='l2h-46'><tt class='method'>get_notBefore</tt></a></b>()
86
86
<dd>
87
87
Return a string giving the time before which the certificate is not valid.  The
88
88
string is formatted as an ASN1 GENERALIZEDTIME:
95
95
</dl>
96
96
 
97
97
<P>
98
 
<dl><dt><b><a name='l2h-45'><tt class='method'>get_notAfter</tt></a></b>()
 
98
<dl><dt><b><a name='l2h-47'><tt class='method'>get_notAfter</tt></a></b>()
99
99
<dd>
100
100
Return a string giving the time after which the certificate is not valid.  The
101
101
string is formatted as an ASN1 GENERALIZEDTIME:
108
108
</dl>
109
109
 
110
110
<P>
111
 
<dl><dt><b><a name='l2h-46'><tt class='method'>set_notBefore</tt></a></b>(<var>when</var>)
 
111
<dl><dt><b><a name='l2h-48'><tt class='method'>set_notBefore</tt></a></b>(<var>when</var>)
112
112
<dd>
113
113
Change the time before which the certificate is not valid.  <var>when</var> is a
114
114
string formatted as an ASN1 GENERALIZEDTIME:
120
120
</dl>
121
121
 
122
122
<P>
123
 
<dl><dt><b><a name='l2h-47'><tt class='method'>set_notAfter</tt></a></b>(<var>when</var>)
 
123
<dl><dt><b><a name='l2h-49'><tt class='method'>set_notAfter</tt></a></b>(<var>when</var>)
124
124
<dd>
125
125
Change the time after which the certificate is not valid.  <var>when</var> is a
126
126
string formatted as an ASN1 GENERALIZEDTIME:
132
132
</dl>
133
133
 
134
134
<P>
135
 
<dl><dt><b><a name='l2h-48'><tt class='method'>gmtime_adj_notBefore</tt></a></b>(<var>time</var>)
 
135
<dl><dt><b><a name='l2h-50'><tt class='method'>gmtime_adj_notBefore</tt></a></b>(<var>time</var>)
136
136
<dd>
137
137
Adjust the timestamp (in GMT) when the certificate starts being valid.
138
138
</dl>
139
139
 
140
140
<P>
141
 
<dl><dt><b><a name='l2h-49'><tt class='method'>gmtime_adj_notAfter</tt></a></b>(<var>time</var>)
 
141
<dl><dt><b><a name='l2h-51'><tt class='method'>gmtime_adj_notAfter</tt></a></b>(<var>time</var>)
142
142
<dd>
143
143
Adjust the timestamp (in GMT) when the certificate stops being valid.
144
144
</dl>
145
145
 
146
146
<P>
147
 
<dl><dt><b><a name='l2h-50'><tt class='method'>has_expired</tt></a></b>()
 
147
<dl><dt><b><a name='l2h-52'><tt class='method'>has_expired</tt></a></b>()
148
148
<dd>
149
149
Checks the certificate's time stamp against current time. Returns true if the
150
150
certificate has expired and false otherwise.
151
151
</dl>
152
152
 
153
153
<P>
154
 
<dl><dt><b><a name='l2h-51'><tt class='method'>set_issuer</tt></a></b>(<var>issuer</var>)
 
154
<dl><dt><b><a name='l2h-53'><tt class='method'>set_issuer</tt></a></b>(<var>issuer</var>)
155
155
<dd>
156
156
Set the issuer of the certificate to <var>issuer</var>.
157
157
</dl>
158
158
 
159
159
<P>
160
 
<dl><dt><b><a name='l2h-52'><tt class='method'>set_pubkey</tt></a></b>(<var>pkey</var>)
 
160
<dl><dt><b><a name='l2h-54'><tt class='method'>set_pubkey</tt></a></b>(<var>pkey</var>)
161
161
<dd>
162
162
Set the public key of the certificate to <var>pkey</var>.
163
163
</dl>
164
164
 
165
165
<P>
166
 
<dl><dt><b><a name='l2h-53'><tt class='method'>set_serial_number</tt></a></b>(<var>serialno</var>)
 
166
<dl><dt><b><a name='l2h-55'><tt class='method'>set_serial_number</tt></a></b>(<var>serialno</var>)
167
167
<dd>
168
168
Set the serial number of the certificate to <var>serialno</var>.
169
169
</dl>
170
170
 
171
171
<P>
172
 
<dl><dt><b><a name='l2h-54'><tt class='method'>set_subject</tt></a></b>(<var>subject</var>)
 
172
<dl><dt><b><a name='l2h-56'><tt class='method'>set_subject</tt></a></b>(<var>subject</var>)
173
173
<dd>
174
174
Set the subject of the certificate to <var>subject</var>.
175
175
</dl>
176
176
 
177
177
<P>
178
 
<dl><dt><b><a name='l2h-55'><tt class='method'>set_version</tt></a></b>(<var>version</var>)
 
178
<dl><dt><b><a name='l2h-57'><tt class='method'>set_version</tt></a></b>(<var>version</var>)
179
179
<dd>
180
180
Set the certificate version to <var>version</var>.
181
181
</dl>
182
182
 
183
183
<P>
184
 
<dl><dt><b><a name='l2h-56'><tt class='method'>sign</tt></a></b>(<var>pkey, digest</var>)
 
184
<dl><dt><b><a name='l2h-58'><tt class='method'>sign</tt></a></b>(<var>pkey, digest</var>)
185
185
<dd>
186
186
Sign the certificate, using the key <var>pkey</var> and the message digest algorithm
187
187
identified by the string <var>digest</var>.
188
188
</dl>
189
189
 
190
190
<P>
191
 
<dl><dt><b><a name='l2h-57'><tt class='method'>subject_name_hash</tt></a></b>()
 
191
<dl><dt><b><a name='l2h-59'><tt class='method'>subject_name_hash</tt></a></b>()
192
192
<dd>
193
193
Return the hash of the certificate subject.
194
194
</dl>
195
195
 
196
196
<P>
197
 
<dl><dt><b><a name='l2h-58'><tt class='method'>digest</tt></a></b>(<var>digest_name</var>)
 
197
<dl><dt><b><a name='l2h-60'><tt class='method'>digest</tt></a></b>(<var>digest_name</var>)
198
198
<dd>
199
199
Return a digest of the certificate, using the <var>digest_name</var> method.
200
200
<var>digest_name</var> must be a string describing a digest algorithm supported
203
203
</dl>
204
204
 
205
205
<P>
206
 
<dl><dt><b><a name='l2h-59'><tt class='method'>add_extensions</tt></a></b>(<var>extensions</var>)
 
206
<dl><dt><b><a name='l2h-61'><tt class='method'>add_extensions</tt></a></b>(<var>extensions</var>)
207
207
<dd>
208
208
Add the extensions in the sequence <var>extensions</var> to the certificate.
209
209
</dl>
210
210
 
211
211
<P>
 
212
<dl><dt><b><a name='l2h-62'><tt class='method'>get_extension_count</tt></a></b>()
 
213
<dd>
 
214
Return the number of extensions on this certificate.
 
215
 
 
216
<span class='versionnote'>New in version 0.12.</span>
 
217
 
 
218
</dl>
 
219
 
 
220
<P>
 
221
<dl><dt><b><a name='l2h-63'><tt class='method'>get_extension</tt></a></b>(<var>index</var>)
 
222
<dd>
 
223
Retrieve the extension on this certificate at the given index.
 
224
 
 
225
<P>
 
226
Extensions on a certificate are kept in order.  The index parameter selects
 
227
which extension will be returned.  The returned object will be an X509Extension
 
228
instance.
 
229
 
 
230
<span class='versionnote'>New in version 0.12.</span>
 
231
 
 
232
</dl>
 
233
 
 
234
<P>
212
235
 
213
236
<DIV CLASS="navigation">
214
237
<p><hr>
215
238
<table align="center" width="100%" cellpadding="0" cellspacing="2">
216
239
<tr>
217
 
<td><A href="openssl-crypto.html"><img src="previous.gif"
 
240
<td><A href="openssl-x509ext.html"><img src="previous.gif"
218
241
  border="0" height="32"
219
242
  alt="Previous Page" width="32"></A></td>
220
243
<td><A href="openssl-crypto.html"><img src="up.gif"
234
257
  border="0" height="32"
235
258
  alt="" width="32"></td>
236
259
</tr></table>
237
 
<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto  </A>
 
260
<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-x509ext.html">3.1.1 X509Extension objects</A>
238
261
<b class="navlabel">Up:</b> <a class="sectref" href="openssl-crypto.html">3.1 crypto  </A>
239
 
<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509name.html">3.1.2 X509Name objects</A>
 
262
<b class="navlabel">Next:</b> <a class="sectref" href="openssl-x509name.html">3.1.3 X509Name objects</A>
240
263
<hr>
241
264
<span class="release-info">Release 0.11.</span>
242
265
</DIV>