`nn::ssl` Namespace

Description

Namespace for the SSL communication API.

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.

Classes

`nn::ssl::CertStore`	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 `CertStore` instance, and then that `CertStore` instance is configured in the `Connection` class.
`nn::ssl::ClientCert`	Class representing an SSL client certificate. The client certificates used in a single SSL communication session first have their certificate data registered to a `ClientCert` instance, and then that `ClientCert` instance is configured in the `Connection` class.
`nn::ssl::Connection`	Class that represents SSL communication. One instance of this class handles SSL communication for one socket.
`nn::ssl::CrlStore`	Class representing a CRL store. The CRLs used in a single SSL communication session first have all their CRL data registered to a `CrlStore` instance, and then that `CrlStore` instance is configured in the `Connection` class.

Enumerated Types

	`VerifyOption`	Verification options.
	`InternalCaCert`	Definition of a device's internal CA certificates.
	`InternalCrl`	Definition of a device's internal certificate revocation list (CRL).
	`InternalClientCert`	Definition of a device's internal client certificates.
	`CertVerifyError`	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 `GetCertVerifyErrors` function gets these types of values as a result of verifying certificates.）
	`ResultCode`	Function result codes. Stored as `description` elements in the `Result` returned from API functions.

`typedef` Definitions

	`CertId`	Certificate ID.
	`CrlId`	CRL ID.
	`ConnectionHandle`	SSL connection ID.
	`CertStoreId`	Certificate store ID.
	`CrlStoreId`	CRL store ID.

Functions

Initialize/Finalize Entire Library
	`Initialize`	Initializes the SSL library. Processes linking the SSL library must call this function once before using the library.
	`Finalize`	Finalizes the SSL library. Processes linking the SSL library must call this function once after they are done using the library.
Pseudo-Random Number Functions
	`GatherRandomEntropy`	Gathers new entropy for random numbers. Note: SSL processes also gather their own entropy. This function is used to gather fresh entropy whenever you need it.
	`GenerateRandomBytes`	Gets a random number.
Other
	`NN_DEFINE_RESULT_CONST_LM`	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)."

Revision History

2010/06/14: Initial version.

CONFIDENTIAL