← Back to branch summary

~myers-1/pyopenssl/npn

« back to all changes in this revision

Viewing changes to OpenSSL/ssl/context.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/ssl/context.c
292
292
OpenSSL.SSL.Context instances define the parameters for setting up new SSL\n\
293
293
connections.\n\
294
294
\n\
295
 
@param method: One of " SSLv2_METHOD_TEXT "SSLv3_METHOD, SSLv23_METHOD, or\n\
 
295
:param method: One of " SSLv2_METHOD_TEXT "SSLv3_METHOD, SSLv23_METHOD, or\n\
296
296
               TLSv1_METHOD.\n\
297
297
";
298
298
 
302
302
Let SSL know where we can find trusted certificates for the certificate\n\
303
303
chain\n\
304
304
\n\
305
 
@param cafile: In which file we can find the certificates\n\
306
 
@param capath: In which directory we can find the certificates\n\
307
 
@return: None\n\
 
305
:param cafile: In which file we can find the certificates\n\
 
306
:param capath: In which directory we can find the certificates\n\
 
307
:return: None\n\
308
308
";
309
309
static PyObject *
310
310
ssl_Context_load_verify_locations(ssl_ContextObj *self, PyObject *args) {
330
330
static char ssl_Context_set_default_verify_paths_doc[] = "\n\
331
331
Use the platform-specific CA certificate locations\n\
332
332
\n\
333
 
@return: None\n\
 
333
:return: None\n\
334
334
";
335
335
static PyObject *
336
336
ssl_Context_set_default_verify_paths(ssl_ContextObj *self, PyObject *args) {
354
354
static char ssl_Context_set_passwd_cb_doc[] = "\n\
355
355
Set the passphrase callback\n\
356
356
\n\
357
 
@param callback: The Python callback to use\n\
358
 
@param userdata: (optional) A Python object which will be given as\n\
 
357
:param callback: The Python callback to use\n\
 
358
:param userdata: (optional) A Python object which will be given as\n\
359
359
                 argument to the callback\n\
360
 
@return: None\n\
 
360
:return: None\n\
361
361
";
362
362
static PyObject *
363
363
ssl_Context_set_passwd_cb(ssl_ContextObj *self, PyObject *args)
459
459
static char ssl_Context_add_extra_chain_cert_doc[] = "\n\
460
460
Add certificate to chain\n\
461
461
\n\
462
 
@param certobj: The X509 certificate object to add to the chain\n\
463
 
@return: None\n\
 
462
:param certobj: The X509 certificate object to add to the chain\n\
 
463
:return: None\n\
464
464
";
465
465
 
466
466
static PyObject *
496
496
static char ssl_Context_use_certificate_chain_file_doc[] = "\n\
497
497
Load a certificate chain from a file\n\
498
498
\n\
499
 
@param certfile: The name of the certificate chain file\n\
500
 
@return: None\n\
 
499
:param certfile: The name of the certificate chain file\n\
 
500
:return: None\n\
501
501
";
502
502
static PyObject *
503
503
ssl_Context_use_certificate_chain_file(ssl_ContextObj *self, PyObject *args)
523
523
static char ssl_Context_use_certificate_file_doc[] = "\n\
524
524
Load a certificate from a file\n\
525
525
\n\
526
 
@param certfile: The name of the certificate file\n\
527
 
@param filetype: (optional) The encoding of the file, default is PEM\n\
528
 
@return: None\n\
 
526
:param certfile: The name of the certificate file\n\
 
527
:param filetype: (optional) The encoding of the file, default is PEM\n\
 
528
:return: None\n\
529
529
";
530
530
static PyObject *
531
531
ssl_Context_use_certificate_file(ssl_ContextObj *self, PyObject *args)
551
551
static char ssl_Context_use_certificate_doc[] = "\n\
552
552
Load a certificate from a X509 object\n\
553
553
\n\
554
 
@param cert: The X509 object\n\
555
 
@return: None\n\
 
554
:param cert: The X509 object\n\
 
555
:return: None\n\
556
556
";
557
557
static PyObject *
558
558
ssl_Context_use_certificate(ssl_ContextObj *self, PyObject *args)
578
578
static char ssl_Context_use_privatekey_file_doc[] = "\n\
579
579
Load a private key from a file\n\
580
580
\n\
581
 
@param keyfile: The name of the key file\n\
582
 
@param filetype: (optional) The encoding of the file, default is PEM\n\
583
 
@return: None\n\
 
581
:param keyfile: The name of the key file\n\
 
582
:param filetype: (optional) The encoding of the file, default is PEM\n\
 
583
:return: None\n\
584
584
";
585
585
static PyObject *
586
586
ssl_Context_use_privatekey_file(ssl_ContextObj *self, PyObject *args)
616
616
static char ssl_Context_use_privatekey_doc[] = "\n\
617
617
Load a private key from a PKey object\n\
618
618
\n\
619
 
@param pkey: The PKey object\n\
620
 
@return: None\n\
 
619
:param pkey: The PKey object\n\
 
620
:return: None\n\
621
621
";
622
622
static PyObject *
623
623
ssl_Context_use_privatekey(ssl_ContextObj *self, PyObject *args) {
646
646
static char ssl_Context_check_privatekey_doc[] = "\n\
647
647
Check that the private key and certificate match up\n\
648
648
\n\
649
 
@return: None (raises an exception if something's wrong)\n\
 
649
:return: None (raises an exception if something's wrong)\n\
650
650
";
651
651
static PyObject *
652
652
ssl_Context_check_privatekey(ssl_ContextObj *self, PyObject *args)
667
667
}
668
668
 
669
669
static char ssl_Context_load_client_ca_doc[] = "\n\
670
 
Load the trusted certificates that will be sent to the client (basically\n \
 
670
Load the trusted certificates that will be sent to the client (basically\n\
671
671
telling the client \"These are the guys I trust\").  Does not actually\n\
672
672
imply any of the certificates are trusted; that must be configured\n\
673
673
separately.\n\
674
674
\n\
675
 
@param cafile: The name of the certificates file\n\
676
 
@return: None\n\
 
675
:param cafile: The name of the certificates file\n\
 
676
:return: None\n\
677
677
";
678
678
static PyObject *
679
679
ssl_Context_load_client_ca(ssl_ContextObj *self, PyObject *args)
693
693
Set the session identifier, this is needed if you want to do session\n\
694
694
resumption (which, ironically, isn't implemented yet)\n\
695
695
\n\
696
 
@param buf: A Python object that can be safely converted to a string\n\
697
 
@returns: None\n\
 
696
:param buf: A Python object that can be safely converted to a string\n\
 
697
:returns: None\n\
698
698
";
699
699
static PyObject *
700
700
ssl_Context_set_session_id(ssl_ContextObj *self, PyObject *args)
720
720
static char ssl_Context_set_verify_doc[] = "\n\
721
721
Set the verify mode and verify callback\n\
722
722
\n\
723
 
@param mode: The verify mode, this is either VERIFY_NONE or\n\
 
723
:param mode: The verify mode, this is either VERIFY_NONE or\n\
724
724
             VERIFY_PEER combined with possible other flags\n\
725
 
@param callback: The Python callback to use\n\
726
 
@return: None\n\
 
725
:param callback: The Python callback to use\n\
 
726
:return: None\n\
727
727
\n\
728
728
See SSL_CTX_set_verify(3SSL) for further details.\n\
729
729
";
754
754
static char ssl_Context_set_verify_depth_doc[] = "\n\
755
755
Set the verify depth\n\
756
756
\n\
757
 
@param depth: An integer specifying the verify depth\n\
758
 
@return: None\n\
 
757
:param depth: An integer specifying the verify depth\n\
 
758
:return: None\n\
759
759
";
760
760
static PyObject *
761
761
ssl_Context_set_verify_depth(ssl_ContextObj *self, PyObject *args)
773
773
static char ssl_Context_get_verify_mode_doc[] = "\n\
774
774
Get the verify mode\n\
775
775
\n\
776
 
@return: The verify mode\n\
 
776
:return: The verify mode\n\
777
777
";
778
778
static PyObject *
779
779
ssl_Context_get_verify_mode(ssl_ContextObj *self, PyObject *args)
790
790
static char ssl_Context_get_verify_depth_doc[] = "\n\
791
791
Get the verify depth\n\
792
792
\n\
793
 
@return: The verify depth\n\
 
793
:return: The verify depth\n\
794
794
";
795
795
static PyObject *
796
796
ssl_Context_get_verify_depth(ssl_ContextObj *self, PyObject *args)
807
807
static char ssl_Context_load_tmp_dh_doc[] = "\n\
808
808
Load parameters for Ephemeral Diffie-Hellman\n\
809
809
\n\
810
 
@param dhfile: The file to load EDH parameters from\n\
811
 
@return: None\n\
 
810
:param dhfile: The file to load EDH parameters from\n\
 
811
:return: None\n\
812
812
";
813
813
static PyObject *
814
814
ssl_Context_load_tmp_dh(ssl_ContextObj *self, PyObject *args)
838
838
static char ssl_Context_set_cipher_list_doc[] = "\n\
839
839
Change the cipher list\n\
840
840
\n\
841
 
@param cipher_list: A cipher list, see ciphers(1)\n\
842
 
@return: None\n\
 
841
:param cipher_list: A cipher list, see ciphers(1)\n\
 
842
:return: None\n\
843
843
";
844
844
static PyObject *
845
845
ssl_Context_set_cipher_list(ssl_ContextObj *self, PyObject *args)
867
867
This list of certificate authorities will be sent to the client when the\n\
868
868
server requests a client certificate.\n\
869
869
\n\
870
 
@param certificate_authorities: a sequence of X509Names.\n\
871
 
@return: None\n\
 
870
:param certificate_authorities: a sequence of X509Names.\n\
 
871
:return: None\n\
872
872
";
873
873
 
874
874
static PyObject *
945
945
The list of certificate authorities will be sent to the client when the\n\
946
946
server requests a client certificate.\n\
947
947
\n\
948
 
@param certificate_authority: certificate authority's X509 certificate.\n\
949
 
@return: None\n\
 
948
:param certificate_authority: certificate authority's X509 certificate.\n\
 
949
:return: None\n\
950
950
";
951
951
 
952
952
static PyObject *
969
969
static char ssl_Context_set_timeout_doc[] = "\n\
970
970
Set session timeout\n\
971
971
\n\
972
 
@param timeout: The timeout in seconds\n\
973
 
@return: The previous session timeout\n\
 
972
:param timeout: The timeout in seconds\n\
 
973
:return: The previous session timeout\n\
974
974
";
975
975
static PyObject *
976
976
ssl_Context_set_timeout(ssl_ContextObj *self, PyObject *args)
987
987
static char ssl_Context_get_timeout_doc[] = "\n\
988
988
Get the session timeout\n\
989
989
\n\
990
 
@return: The session timeout\n\
 
990
:return: The session timeout\n\
991
991
";
992
992
static PyObject *
993
993
ssl_Context_get_timeout(ssl_ContextObj *self, PyObject *args)
1004
1004
static char ssl_Context_set_info_callback_doc[] = "\n\
1005
1005
Set the info callback\n\
1006
1006
\n\
1007
 
@param callback: The Python callback to use\n\
1008
 
@return: None\n\
 
1007
:param callback: The Python callback to use\n\
 
1008
:return: None\n\
1009
1009
";
1010
1010
static PyObject *
1011
1011
ssl_Context_set_info_callback(ssl_ContextObj *self, PyObject *args)
1033
1033
static char ssl_Context_get_app_data_doc[] = "\n\
1034
1034
Get the application data (supplied via set_app_data())\n\
1035
1035
\n\
1036
 
@return: The application data\n\
 
1036
:return: The application data\n\
1037
1037
";
1038
1038
static PyObject *
1039
1039
ssl_Context_get_app_data(ssl_ContextObj *self, PyObject *args)
1048
1048
static char ssl_Context_set_app_data_doc[] = "\n\
1049
1049
Set the application data (will be returned from get_app_data())\n\
1050
1050
\n\
1051
 
@param data: Any Python object\n\
1052
 
@return: None\n\
 
1051
:param data: Any Python object\n\
 
1052
:return: None\n\
1053
1053
";
1054
1054
static PyObject *
1055
1055
ssl_Context_set_app_data(ssl_ContextObj *self, PyObject *args)
1070
1070
static char ssl_Context_get_cert_store_doc[] = "\n\
1071
1071
Get the certificate store for the context\n\
1072
1072
\n\
1073
 
@return: A X509Store object\n\
 
1073
:return: A X509Store object\n\
1074
1074
";
1075
1075
static PyObject *
1076
1076
ssl_Context_get_cert_store(ssl_ContextObj *self, PyObject *args)
1094
1094
static char ssl_Context_set_options_doc[] = "\n\
1095
1095
Add options. Options set before are not cleared!\n\
1096
1096
\n\
1097
 
@param options: The options to add.\n\
1098
 
@return: The new option bitmask.\n\
 
1097
:param options: The options to add.\n\
 
1098
:return: The new option bitmask.\n\
1099
1099
";
1100
1100
static PyObject *
1101
1101
ssl_Context_set_options(ssl_ContextObj *self, PyObject *args)
1111
1111
static char ssl_Context_set_mode_doc[] = "\n\
1112
1112
Add modes via bitmask. Modes set before are not cleared!\n\
1113
1113
\n\
1114
 
@param mode: The mode to add.\n\
1115
 
@return: The new mode bitmask.\n\
 
1114
:param mode: The mode to add.\n\
 
1115
:return: The new mode bitmask.\n\
1116
1116
";
1117
1117
static PyObject *
1118
1118
ssl_Context_set_mode(ssl_ContextObj *self, PyObject *args) {
1128
1128
static char ssl_Context_set_tlsext_servername_callback_doc[] = "\n\
1129
1129
Specify a callback function to be called when clients specify a server name.\n\
1130
1130
\n\
1131
 
@param callback: The callback function.  It will be invoked with one\n\
 
1131
:param callback: The callback function.  It will be invoked with one\n\
1132
1132
    argument, the Connection instance.\n\
1133
1133
\n\
1134
1134
";