1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50<title>nn::ssl</title> 51 </head> 52 <body> 53<h1><CODE>nn::ssl</CODE> Namespace</h1> 54<h2>Description</h2> 55 <div class="section"> 56<p>Namespace for the SSL communication API.</p><p>Note: This library has been prepared for debugging purposes. If you intend to include it in your retail product, contact Nintendo at support@noa.com.<br /></p><!-- write here --></div> 57 <a name="class" id="class"> 58<h2>Classes</h2> 59 <div class="section"> 60 <table class="members"> 61 <tr> 62 <th> 63<a href="../../nn/ssl/CertStore/Overview.html"><CODE>nn::ssl::CertStore</CODE></a> 64 </th> 65<td>Class representing an SSL certificate store. The RootCA certificates used in a single SSL communication session first have all their certificate data registered to a <CODE>CertStore</CODE> instance, and then that <CODE>CertStore</CODE> instance is configured in the <CODE>Connection</CODE> class.</td> 66 </tr> 67 <tr> 68 <th> 69<a href="../../nn/ssl/ClientCert/Overview.html"><CODE>nn::ssl::ClientCert</CODE></a> 70 </th> 71<td>Class representing an SSL client certificate. The client certificates used in a single SSL communication session first have their certificate data registered to a <CODE>ClientCert</CODE> instance, and then that <CODE>ClientCert</CODE> instance is configured in the <CODE>Connection</CODE> class.</td> 72 </tr> 73 <tr> 74 <th> 75<a href="../../nn/ssl/Connection/Overview.html"><CODE>nn::ssl::Connection</CODE></a> 76 </th> 77<td>Class that represents SSL communication. One instance of this class handles SSL communication for one socket.</td> 78 </tr> 79 <tr> 80 <th> 81<a href="../../nn/ssl/CrlStore/Overview.html"><CODE>nn::ssl::CrlStore</CODE></a> 82 </th> 83<td>Class representing a CRL store. The CRLs used in a single SSL communication session first have all their CRL data registered to a <CODE>CrlStore</CODE> instance, and then that <CODE>CrlStore</CODE> instance is configured in the <CODE>Connection</CODE> class.</td> 84 </tr> 85 </table> 86 </div> 87 </a> <a name="enum" id="enum"> 88<h2>Enumerated Types</h2> 89 <div class="section"> 90 <table class="members"> 91 <tr> 92 <td width="100"> </td> 93 <th> 94<a href="../../nn/ssl/VerifyOption.html"><CODE>VerifyOption</CODE></a> 95 </th> 96<td>Verification options.</td> 97 </tr> 98 <tr> 99 <td width="100"> </td> 100 <th> 101<a href="../../nn/ssl/InternalCaCert.html"><CODE>InternalCaCert</CODE></a> 102 </th> 103<td>Definition of a device's internal CA certificates.</td> 104 </tr> 105 <tr> 106 <td width="100"> </td> 107 <th> 108<a href="../../nn/ssl/InternalCrl.html"><CODE>InternalCrl</CODE></a> 109 </th> 110<td>Definition of a device's internal certificate revocation list (CRL).</td> 111 </tr> 112 <tr> 113 <td width="100"> </td> 114 <th> 115<a href="../../nn/ssl/InternalClientCert.html"><CODE>InternalClientCert</CODE></a> 116 </th> 117<td>Definition of a device's internal client certificates.</td> 118 </tr> 119 <tr> 120 <td width="100"> </td> 121 <th> 122<a href="../../nn/ssl/CertVerifyError.html"><CODE>CertVerifyError</CODE></a> 123 </th> 124<td>Certificate verification results. (Each definition uses a single bit. You can define multiple errors at the same time using a bitwise OR of multiple definitions. The <CODE>GetCertVerifyErrors</CODE> function gets these types of values as a result of verifying certificates.）</td> 125 </tr> 126 <tr> 127 <td width="100"> </td> 128 <th> 129<a href="../../nn/ssl/ResultCode.html"><CODE>ResultCode</CODE></a> 130 </th> 131<td>Function result codes. Stored as <CODE>description</CODE> elements in the <CODE>Result</CODE> returned from API functions.</td> 132 </tr> </table> 133 </div> 134 </a> <a name="typedef" id="typedef"> 135<h2><CODE>typedef</CODE> Definitions</h2> 136 <div class="section"> 137 <table class="members"> 138 <tr> 139 <td width="100" /> 140 <th> 141<a href="../../nn/ssl/CertId.html"><CODE>CertId</CODE></a> 142 </th> 143<td>Certificate ID.</td> 144 </tr> 145 <tr> 146 <td width="100" /> 147 <th> 148<a href="../../nn/ssl/CrlId.html"><CODE>CrlId</CODE></a> 149 </th> 150<td>CRL ID.</td> 151 </tr> 152 <tr> 153 <td width="100" /> 154 <th> 155<a href="../../nn/ssl/ConnectionHandle.html"><CODE>ConnectionHandle</CODE></a> 156 </th> 157<td>SSL connection ID.</td> 158 </tr> 159 <tr> 160 <td width="100" /> 161 <th> 162<a href="../../nn/ssl/CertStoreId.html"><CODE>CertStoreId</CODE></a> 163 </th> 164<td>Certificate store ID.</td> 165 </tr> 166 <tr> 167 <td width="100" /> 168 <th> 169<a href="../../nn/ssl/CrlStoreId.html"><CODE>CrlStoreId</CODE></a> 170 </th> 171<td>CRL store ID.</td> 172 </tr> </table> 173 </div> 174 </a> <a name="function" id="function"> 175<h2>Functions</h2> 176 <div class="section"> 177 <table class="members"> 178 <tr> 179<th class="category" colspan="3">Initialize/Finalize Entire Library</th> 180 </tr> 181 <tr> 182 <td width="100"> </td> 183 <th> 184<a href="../../nn/ssl/Initialize.html"><CODE>Initialize</CODE></a> 185 </th> 186<td>Initializes the SSL library. Processes linking the SSL library must call this function once before using the library.</td> 187 </tr> 188 <tr> 189 <td width="100"> </td> 190 <th> 191<a href="../../nn/ssl/Finalize.html"><CODE>Finalize</CODE></a> 192 </th> 193<td>Finalizes the SSL library. Processes linking the SSL library must call this function once after they are done using the library.</td> 194 </tr> 195 <tr> 196<th class="category" colspan="3">Pseudo-Random Number Functions</th> 197 </tr> 198 <tr> 199 <td width="100"> </td> 200 <th> 201<a href="../../nn/ssl/GatherRandomEntropy.html"><CODE>GatherRandomEntropy</CODE></a> 202 </th> 203<td>Gathers new entropy for random numbers. <B>Note:</B> SSL processes also gather their own entropy. This function is used to gather fresh entropy whenever you need it.</td> 204 </tr> 205 <tr> 206 <td width="100"> </td> 207 <th> 208<a href="../../nn/ssl/GenerateRandomBytes.html"><CODE>GenerateRandomBytes</CODE></a> 209 </th> 210<td>Gets a random number.</td> 211 </tr> 212 <tr> 213<th class="category" colspan="3">Other</th> 214 </tr> 215 <tr> 216 <td width="100"> </td> 217 <th> 218<a href="../../nn/ssl/NN_DEFINE_RESULT_CONST_LM.html"><CODE>NN_DEFINE_RESULT_CONST_LM</CODE></a> 219 </th> 220<td>Returns a result that indicates the following error: "Error caused by SSL protocol failure (for example, when client certificate authentication fails on the server side)."</td> 221 </tr> </table> 222 </div> 223 </a> 224<h2>Revision History</h2> 225 <div class="section"> 226 <dl class="history"> 227 <dt>2010/06/14</dt> 228<dd>Initial version.<br /> 229 </dd> 230 </dl> 231 </div> 232 <hr><p>CONFIDENTIAL</p></body> 233</html>