← Back to branch summary

~stepankk/pyopenssl/bug-845445

« back to all changes in this revision

Viewing changes to OpenSSL/crypto/x509.c

  • Committer: Jean-Paul Calderone
  • Date: 2011-09-11 19:49:43 UTC
  • mfrom: (156.3.22 sphinx-doc)
  • Revision ID: exarkun@divmod.com-20110911194943-ucaan2tzidk7ek5l
Convert the documentation from LaTeX/epytext to Sphinx/ReST

Show diffs side-by-side

added added

removed removed

Lines of Context:
OpenSSL/crypto/x509.c
23
23
static char crypto_X509_get_version_doc[] = "\n\
24
24
Return version number of the certificate\n\
25
25
\n\
26
 
@return: Version number as a Python integer\n\
 
26
:return: Version number as a Python integer\n\
27
27
";
28
28
 
29
29
static PyObject *
38
38
static char crypto_X509_set_version_doc[] = "\n\
39
39
Set version number of the certificate\n\
40
40
\n\
41
 
@param version: The version number\n\
42
 
@return: None\n\
 
41
:param version: The version number\n\
 
42
:return: None\n\
43
43
";
44
44
 
45
45
static PyObject *
59
59
static char crypto_X509_get_serial_number_doc[] = "\n\
60
60
Return serial number of the certificate\n\
61
61
\n\
62
 
@return: Serial number as a Python integer\n\
 
62
:return: Serial number as a Python integer\n\
63
63
";
64
64
 
65
65
static PyObject *
85
85
static char crypto_X509_set_serial_number_doc[] = "\n\
86
86
Set serial number of the certificate\n\
87
87
\n\
88
 
@param serial: The serial number\n\
89
 
@return: None\n\
 
88
:param serial: The serial number\n\
 
89
:return: None\n\
90
90
";
91
91
 
92
92
static PyObject *
176
176
static char crypto_X509_get_issuer_doc[] = "\n\
177
177
Create an X509Name object for the issuer of the certificate\n\
178
178
\n\
179
 
@return: An X509Name object\n\
 
179
:return: An X509Name object\n\
180
180
";
181
181
 
182
182
static PyObject *
201
201
static char crypto_X509_set_issuer_doc[] = "\n\
202
202
Set the issuer of the certificate\n\
203
203
\n\
204
 
@param issuer: The issuer name\n\
205
 
@type issuer: L{X509Name}\n\
206
 
@return: None\n\
 
204
:param issuer: The issuer name\n\
 
205
:type issuer: :py:class:`X509Name`\n\
 
206
:return: None\n\
207
207
";
208
208
 
209
209
static PyObject *
228
228
static char crypto_X509_get_subject_doc[] = "\n\
229
229
Create an X509Name object for the subject of the certificate\n\
230
230
\n\
231
 
@return: An X509Name object\n\
 
231
:return: An X509Name object\n\
232
232
";
233
233
 
234
234
static PyObject *
253
253
static char crypto_X509_set_subject_doc[] = "\n\
254
254
Set the subject of the certificate\n\
255
255
\n\
256
 
@param subject: The subject name\n\
257
 
@type subject: L{X509Name}\n\
258
 
@return: None\n\
 
256
:param subject: The subject name\n\
 
257
:type subject: :py:class:`X509Name`\n\
 
258
:return: None\n\
259
259
";
260
260
 
261
261
static PyObject *
280
280
static char crypto_X509_get_pubkey_doc[] = "\n\
281
281
Get the public key of the certificate\n\
282
282
\n\
283
 
@return: The public key\n\
 
283
:return: The public key\n\
284
284
";
285
285
 
286
286
static PyObject *
309
309
static char crypto_X509_set_pubkey_doc[] = "\n\
310
310
Set the public key of the certificate\n\
311
311
\n\
312
 
@param pkey: The public key\n\
313
 
@return: None\n\
 
312
:param pkey: The public key\n\
 
313
:return: None\n\
314
314
";
315
315
 
316
316
static PyObject *
358
358
static char crypto_X509_set_notBefore_doc[] = "\n\
359
359
Set the time stamp for when the certificate starts being valid\n\
360
360
\n\
361
 
@param when: A string giving the timestamp, in the format:\n\
 
361
:param when: A string giving the timestamp, in the format:\n\
362
362
\n\
363
363
                 YYYYMMDDhhmmssZ\n\
364
364
                 YYYYMMDDhhmmss+hhmm\n\
365
365
                 YYYYMMDDhhmmss-hhmm\n\
366
366
\n\
367
 
@return: None\n\
 
367
:return: None\n\
368
368
";
369
369
 
370
370
static PyObject*
378
378
static char crypto_X509_set_notAfter_doc[] = "\n\
379
379
Set the time stamp for when the certificate stops being valid\n\
380
380
\n\
381
 
@param when: A string giving the timestamp, in the format:\n\
 
381
:param when: A string giving the timestamp, in the format:\n\
382
382
\n\
383
383
                 YYYYMMDDhhmmssZ\n\
384
384
                 YYYYMMDDhhmmss+hhmm\n\
385
385
                 YYYYMMDDhhmmss-hhmm\n\
386
386
\n\
387
 
@return: None\n\
 
387
:return: None\n\
388
388
";
389
389
 
390
390
static PyObject*
433
433
static char crypto_X509_get_notBefore_doc[] = "\n\
434
434
Retrieve the time stamp for when the certificate starts being valid\n\
435
435
\n\
436
 
@return: A string giving the timestamp, in the format:\n\
 
436
:return: A string giving the timestamp, in the format::\n\
437
437
\n\
438
438
                 YYYYMMDDhhmmssZ\n\
439
439
                 YYYYMMDDhhmmss+hhmm\n\
440
440
                 YYYYMMDDhhmmss-hhmm\n\
441
 
           or None if there is no value set.\n\
 
441
\n\
 
442
         or None if there is no value set.\n\
442
443
";
443
444
 
444
445
static PyObject*
455
456
static char crypto_X509_get_notAfter_doc[] = "\n\
456
457
Retrieve the time stamp for when the certificate stops being valid\n\
457
458
\n\
458
 
@return: A string giving the timestamp, in the format:\n\
 
459
:return: A string giving the timestamp, in the format::\n\
459
460
\n\
460
461
                 YYYYMMDDhhmmssZ\n\
461
462
                 YYYYMMDDhhmmss+hhmm\n\
462
463
                 YYYYMMDDhhmmss-hhmm\n\
463
 
           or None if there is no value set.\n\
 
464
\n\
 
465
         or None if there is no value set.\n\
464
466
";
465
467
 
466
468
static PyObject*
478
480
Change the timestamp for when the certificate starts being valid to the current\n\
479
481
time plus an offset.\n \
480
482
\n\
481
 
@param amount: The number of seconds by which to adjust the starting validity\n\
 
483
:param amount: The number of seconds by which to adjust the starting validity\n\
482
484
               time.\n\
483
 
@return: None\n\
 
485
:return: None\n\
484
486
";
485
487
 
486
488
static PyObject *
500
502
static char crypto_X509_gmtime_adj_notAfter_doc[] = "\n\
501
503
Adjust the time stamp for when the certificate stops being valid\n\
502
504
\n\
503
 
@param amount: The number of seconds by which to adjust the ending validity\n\
 
505
:param amount: The number of seconds by which to adjust the ending validity\n\
504
506
               time.\n\
505
 
@return: None\n\
 
507
:return: None\n\
506
508
";
507
509
 
508
510
static PyObject *
523
525
static char crypto_X509_get_signature_algorithm_doc[] = "\n\
524
526
Retrieve the signature algorithm used in the certificate\n\
525
527
\n\
526
 
@return: A byte string giving the name of the signature algorithm used in\n\
 
528
:return: A byte string giving the name of the signature algorithm used in\n\
527
529
         the certificate.\n\
528
 
@raise ValueError: If the signature algorithm is undefined.\n\
 
530
:raise ValueError: If the signature algorithm is undefined.\n\
529
531
";
530
532
 
531
533
static PyObject *
550
552
static char crypto_X509_sign_doc[] = "\n\
551
553
Sign the certificate using the supplied key and digest\n\
552
554
\n\
553
 
@param pkey: The key to sign with\n\
554
 
@param digest: The message digest to use\n\
555
 
@return: None\n\
 
555
:param pkey: The key to sign with\n\
 
556
:param digest: The message digest to use\n\
 
557
:return: None\n\
556
558
";
557
559
 
558
560
static PyObject *
595
597
static char crypto_X509_has_expired_doc[] = "\n\
596
598
Check whether the certificate has expired.\n\
597
599
\n\
598
 
@return: True if the certificate has expired, false otherwise\n\
 
600
:return: True if the certificate has expired, false otherwise\n\
599
601
";
600
602
 
601
603
static PyObject *
616
618
static char crypto_X509_subject_name_hash_doc[] = "\n\
617
619
Return the hash of the X509 subject.\n\
618
620
\n\
619
 
@return: The hash of the subject\n\
 
621
:return: The hash of the subject\n\
620
622
";
621
623
 
622
624
static PyObject *
631
633
static char crypto_X509_digest_doc[] = "\n\
632
634
Return the digest of the X509 object.\n\
633
635
\n\
634
 
@return: The digest of the object\n\
 
636
:return: The digest of the object\n\
635
637
";
636
638
 
637
639
static PyObject *
672
674
static char crypto_X509_add_extensions_doc[] = "\n\
673
675
Add extensions to the certificate.\n\
674
676
\n\
675
 
@param extensions: a sequence of X509Extension objects\n\
676
 
@return: None\n\
 
677
:param extensions: a sequence of X509Extension objects\n\
 
678
:return: None\n\
677
679
";
678
680
 
679
681
static PyObject *
717
719
static char crypto_X509_get_extension_count_doc[] = "\n\
718
720
Get the number of extensions on the certificate.\n\
719
721
\n\
720
 
@return: Number of extensions as a Python integer\n\
 
722
:return: Number of extensions as a Python integer\n\
721
723
";
722
724
 
723
725
static PyObject *
732
734
static char crypto_X509_get_extension_doc[] = "\n\
733
735
Get a specific extension of the certificate by index.\n\
734
736
\n\
735
 
@param index: The index of the extension to retrieve.\n\
736
 
@return: The X509Extension object at the specified index.\n\
 
737
:param index: The index of the extension to retrieve.\n\
 
738
:return: The X509Extension object at the specified index.\n\
737
739
";
738
740
 
739
741
static PyObject *
824
826
 
825
827
 
826
828
static char crypto_X509_doc[] = "\n\
827
 
X509() -> X509 instance\n\
 
829
A class representing X.509 certificates.\n\
828
830
\n\
829
831
Create a new X509 object.\n\
830
832
\n\
831
 
@returns: The X509 object\n\
 
833
:returns: The :class:`X509` object\n\
832
834
";
833
835
 
834
836
static PyObject *