index.rst (13429B)
1 .. _mozilla_projects_nss_ssl_functions_old_ssl_reference: 2 3 OLD SSL Reference 4 ================= 5 6 .. container:: 7 8 .. rubric:: OLD SSL Reference 9 :name: OLD_SSL_Reference 10 11 .. note:: 12 13 - We are migrating this SSL Reference into the format described in the `MDN Style 14 Guide <https://developer.mozilla.org/en-US/docs/Project:MDC_style_guide>`__. If you are 15 inclined to help with this migration, your help would be very much appreciated. 16 17 - Upgraded documentation may be found in the :ref:`mozilla_projects_nss_reference` 18 19 .. _ssl_reference: 20 21 `SSL Reference <#ssl_reference>`__ 22 ---------------------------------- 23 24 .. container:: 25 26 *Newsgroup:*\ `mozilla.dev.tech.crypto <news://news.mozilla.org/mozilla.dev.tech.crypto>`__\ * 27 Writer: Sean Cotter 28 Manager: Wan-Teh Chang* 29 30 .. rubric:: `Chapter 1 Overview of an SSL Application <sslintro.html#1028068>`__ 31 :name: chapter_1_overview_of_an_ssl_application 32 33 SSL and related APIs allow compliant applications to configure sockets for authenticated, 34 tamper-proof, and encrypted communications. This chapter introduces some of the basic SSL 35 functions. Chapter 2, "Getting Started With SSL" illustrates their use in sample client and 36 server applications. 37 38 - `Initialization <sslintro.html#1027662>`__ 39 40 - `Initializing Caches <sslintro.html#1039943>`__ 41 42 - `Configuration <sslintro.html#1027742>`__ ` <sslintro.html#1027816>`__ 43 - `Communication <sslintro.html#1027816>`__ ` <sslintro.html#1027820>`__ 44 - `Functions Used by Callbacks <sslintro.html#1027820>`__ ` <sslintro.html#1030535>`__ 45 - `Cleanup <sslintro.html#1030535>`__ 46 47 .. rubric:: `Chapter 2 Getting Started With SSL <gtstd.html#1005439>`__ 48 :name: chapter_2_getting_started_with_ssl 49 50 This chapter describes how to set up your environment, including certificate and key 51 databases, to run the NSS sample code. The sample code and makefiles are available via LXR in 52 the SSLSamples directory. 53 54 - `SSL, PKCS #11, and the Default Security Databases <gtstd.html#1011970>`__ 55 ` <gtstd.html#1011987>`__ 56 - `Setting Up the Certificate and Key Databases <gtstd.html#1011987>`__ 57 58 - `Setting Up the CA DB and Certificate <gtstd.html#1012301>`__ ` <gtstd.html#1012351>`__ 59 - `Setting Up the Server DB and Certificate <gtstd.html#1012351>`__ ` <gtstd.html#1012067>`__ 60 - `Setting Up the Client DB and Certificate <gtstd.html#1012067>`__ ` <gtstd.html#1012108>`__ 61 - `Verifying the Server and Client Certificates <gtstd.html#1012108>`__ 62 63 - `Building NSS Programs <gtstd.html#1013274>`__ 64 65 .. rubric:: `Chapter 3 Selected SSL Types and Structures <ssltyp.html#1029792>`__ 66 :name: chapter_3_selected_ssl_types_and_structures 67 68 This chapter describes some of the most important types and structures used with the functions 69 described in the rest of this document, and how to manage the memory used for them. Additional 70 types are described with the functions that use them or in the header files. 71 72 - `Types and Structures <ssltyp.html#1030559>`__ 73 74 - `CERTCertDBHandle <ssltyp.html#1028465>`__ ` <ssltyp.html#1027387>`__ 75 - `CERTCertificate <ssltyp.html#1027387>`__ ` <ssltyp.html#1028593>`__ 76 - `PK11SlotInfo <ssltyp.html#1028593>`__ ` <ssltyp.html#1026076>`__ 77 - `SECItem <ssltyp.html#1026076>`__ ` <ssltyp.html#1026727>`__ 78 - `SECKEYPrivateKey <ssltyp.html#1026727>`__ ` <ssltyp.html#1026722>`__ 79 - `SECStatus <ssltyp.html#1026722>`__ 80 81 - `Managing SECItem Memory <ssltyp.html#1029645>`__ 82 83 - `SECItem_FreeItem <ssltyp.html#1030620>`__ ` <ssltyp.html#1030773>`__ 84 - `SECItem_ZfreeItem <ssltyp.html#1030773>`__ 85 86 .. rubric:: :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1047959` 87 :name: chapter_4_ssl_functions 88 89 This chapter describes the core SSL functions. 90 91 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1022864` 92 93 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1067601` 94 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1237143` 95 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1237143` 96 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1234224` 97 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1234224` 98 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1068466` 99 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1068466` 100 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1204897` 101 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1204897` 102 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1084747` 103 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1084747` 104 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1208119` 105 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1208119` 106 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1138601` 107 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1138601` 108 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1143851` 109 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1143851` 110 111 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1154189` 112 113 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1142625` 114 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1162055` 115 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1162055` 116 117 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1098841` 118 119 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1228530` 120 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1100285` 121 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1100285` 122 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1105952` 123 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1105952` 124 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1104647` 125 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1104647` 126 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1210463` 127 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1210463` 128 129 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1163855` 130 131 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1090577` 132 133 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1085950` 134 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1086543` 135 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1086543` 136 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1194921` 137 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1194921` 138 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1214758` 139 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1214758` 140 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1214800` 141 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1214800` 142 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1217647` 143 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1217647` 144 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1087792` 145 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1087792` 146 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1088040` 147 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1088040` 148 149 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1089578` 150 151 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1088805` 152 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1088888` 153 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1088888` 154 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1088928` 155 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1088928` 156 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1126622` 157 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1126622` 158 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1106762` 159 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1106762` 160 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1112702` 161 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1112702` 162 163 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1127321` 164 165 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1089420` 166 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1092785` 167 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1092785` 168 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1092805` 169 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1092805` 170 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1092869` 171 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1092869` 172 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1124562` 173 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1124562` 174 175 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1127893` 176 177 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1096168` 178 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1081175` 179 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1081175` 180 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1123385` 181 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1123385` 182 183 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1061582` 184 185 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1133431` 186 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1232052` 187 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1232052` 188 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1058001` 189 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1058001` 190 191 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1095840` 192 193 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1061858` 194 195 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1198429` 196 197 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1206365` 198 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1220189` 199 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1220189` 200 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1207298` 201 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1207298` 202 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1207350` 203 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1207350` 204 :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1231825` 205 - :ref:`mozilla_projects_nss_ssl_functions_sslfnc#1231825` 206 207 .. rubric:: `Chapter 5 Certificate Functions <sslcrt.html#1047959>`__ 208 :name: chapter_5_certificate_functions 209 210 This chapter describes the functions and related types used to work with a certificate 211 database such as the cert7.db database provided with Communicator. 212 213 - `Validating Certificates <sslcrt.html#1060423>`__ 214 215 - `CERT_VerifyCertNow <sslcrt.html#1058011>`__ ` <sslcrt.html#1050342>`__ 216 - `CERT_VerifyCertName <sslcrt.html#1050342>`__ ` <sslcrt.html#1056662>`__ 217 - `CERT_CheckCertValidTimes <sslcrt.html#1056662>`__ ` <sslcrt.html#1056760>`__ 218 - `NSS_CmpCertChainWCANames <sslcrt.html#1056760>`__ 219 220 - `Manipulating Certificates <sslcrt.html#1056436>`__ 221 222 - `CERT_DupCertificate <sslcrt.html#1058344>`__ ` <sslcrt.html#1050532>`__ 223 - `CERT_DestroyCertificate <sslcrt.html#1050532>`__ 224 225 - `Getting Certificate Information <sslcrt.html#1056475>`__ 226 227 - `CERT_FindCertByName <sslcrt.html#1050345>`__ ` <sslcrt.html#1050346>`__ 228 - `CERT_GetCertNicknames <sslcrt.html#1050346>`__ ` <sslcrt.html#1050349>`__ 229 - `CERT_FreeNicknames <sslcrt.html#1050349>`__ ` <sslcrt.html#1052308>`__ 230 - `CERT_GetDefaultCertDB <sslcrt.html#1052308>`__ ` <sslcrt.html#1056950>`__ 231 - `NSS_FindCertKEAType <sslcrt.html#1056950>`__ 232 233 - `Comparing SecItem Objects <sslcrt.html#1055384>`__ 234 235 - `SECITEM_CompareItem <sslcrt.html#1057028>`__ 236 237 .. rubric:: `Chapter 6 Key Functions <sslkey.html#1047959>`__ 238 :name: chapter_6_key_functions 239 240 This chapter describes two functions used to manipulate private keys and key databases such as 241 the key3.db database provided with Communicator. 242 243 - `SECKEY_GetDefaultKeyDB <sslkey.html#1051479>`__ ` <sslkey.html#1051017>`__ 244 - `SECKEY_DestroyPrivateKey <sslkey.html#1051017>`__ 245 246 .. rubric:: `Chapter 7 PKCS #11 Functions <pkfnc.html#1027946>`__ 247 :name: chapter_7_pkcs_11_functions 248 249 This chapter describes the core PKCS #11 functions that an application needs for communicating 250 with cryptographic modules. In particular, these functions are used for obtaining 251 certificates, keys, and passwords. 252 253 - `PK11_FindCertFromNickname <pkfnc.html#1035673>`__ ` <pkfnc.html#1026891>`__ 254 - `PK11_FindKeyByAnyCert <pkfnc.html#1026891>`__ ` <pkfnc.html#1030779>`__ 255 - `PK11_GetSlotName <pkfnc.html#1030779>`__ ` <pkfnc.html#1026964>`__ 256 - `PK11_GetTokenName <pkfnc.html#1026964>`__ ` <pkfnc.html#1026762>`__ 257 - `PK11_IsHW <pkfnc.html#1026762>`__ ` <pkfnc.html#1022948>`__ 258 - `PK11_IsPresent <pkfnc.html#1022948>`__ ` <pkfnc.html#1022991>`__ 259 - `PK11_IsReadOnly <pkfnc.html#1022991>`__ ` <pkfnc.html#1023128>`__ 260 - `PK11_SetPasswordFunc <pkfnc.html#1023128>`__ 261 262 .. rubric:: `Chapter 8 NSS and SSL Error Codes <sslerr.html#1013897>`__ 263 :name: chapter_8_nss_and_ssl_error_codes 264 265 NSS error codes are retrieved using the NSPR function PR_GetError. In addition to the error 266 codes defined by NSPR, PR_GetError retrieves the error codes described in this chapter. 267 268 - `SSL Error Codes <sslerr.html#1040263>`__ ` <sslerr.html#1039257>`__ 269 - `SEC Error Codes <sslerr.html#1039257>`__