MCL/sf/os/security: crypto/weakcrypto/docs/pbe.dox@e60b2dbc57a0 (annotated)

0 2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	1	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	2	@page mainpage_pbe Password Based Encryption (PBE)
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	3
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	4
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	5	- @ref pbe_What
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	6	- @ref pbe_How
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	7	- @ref pbe_example
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	8	- @ref pbe_files
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	9
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	10	@section pbe_What What is PBE?
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	11
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	12	%PBE provides an API to encrypt and decrypt data with a user-supplied password. It is intended to be used by
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	13	applications, such as editors or database programs, that might provide the ability to encrypt a user's documents.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	14	It aims to be secure and easy to use, and attempts to overcome the common pitfalls of encryption based on
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	15	user-supplied passwords. Specifically, it uses a
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	16	<A HREF="http://www.rsasecurity.com/rsalabs/pkcs/pkcs-5/index.html">PKCS#5</A>-based key derivation function to
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	17	create the symmetric key based on the user's password.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	18
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	19	<A HREF="http://www.rsasecurity.com/rsalabs/pkcs/pkcs-5/index.html">PKCS#5</A> is the Password Based Encryption
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	20	standard produced by RSA laboratories. It describes a method to generate a symmetric key based on a password.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	21	We use PKCS#5 v2.0, which is able to generate unlimited key length.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	22
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	23	The %PBE algorithm generates a symmetric key based on a password, which is provided by the user. To impede
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	24	dictionary attacks, the password is appended with a @ref salt before being digested to produce the key;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	25	the salt is generated using a @ref mainpage_rng "pseudo random number generator". Furthermore, the %PBE algorithm
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	26	by which the keys are derived is iterated a number of times, the default being @ref KDefaultIterations.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	27	As @ref TPBECipher "the ciphers" operate in @ref CBC mode, a randomly selected Initialization Vector (@ref IV) is
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	28	passed to them as a seed. Note that the salt value, iteration count value, and the @ref IV
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	29	(i.e., the <code>CPBEncryptParms</code> object) do not have to be kept secret and can be sent along with the
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	30	ciphertext.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	31
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	32	%PBE provides APIs for encrypting a single object (<code>CPBEncryptElement</code>) and multiple objects
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	33	(<code>CPBEncryptSet</code>). The latter is useful in the situation if one wants random access to an encrypted
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	34	source consisting of multiple, independent elements; for example a database or a store.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	35
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	36	@section pbe_How What is PBE used for?
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	37
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	38	%PBE is used to implement @ref secure_stream_encryption, which can be used, for example,:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	39	- to password protect a database file
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	40	- to store contacts encrypted on a mobile phone.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	41
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	42	@section pbe_example PBE example code
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	43
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	44	- @ref pbe_example_code
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	45
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	46	@section pbe_files Relevant files and classes
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	47
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	48	- <code>pbe.h</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	49	- <code>CPBEncryptElement</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	50	- <code>CPBEncryptSet</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	51	- <code>TPBPassword</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	52	- <code>@ref TPBECipher</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	53	- <code>pbebase.h</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	54	- <code>CPBEncryptor</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	55	- <code>CPBDecryptor</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	56	- <code>CPBEncryptionBase</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	57	- <code>pbedata.h</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	58	- <code>CPBEncryptParms</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	59	- <code>CPBAuthData</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	60	- <code>CPBEncryptionData </code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	61	- <code>pbesymmetricfactory.h</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	62	- <code>PBE</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	63	- <code>constants</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	64	<!--
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	65	- <code>pbencryptor.h</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	66	- <code>CPBEncryptorElement</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	67	- <code>CPBDecryptorElement</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	68	- <code>CPBEncryptorSet</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	69	- <code>CPBDecryptorSet</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	70	- <code>pkcs5kdf.h</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	71	- <code>TPKCS5KDF</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	72	- <code>@ref KDefaultIterations</code>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	73	-->
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	74
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	75	<!--
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	76	Also, see <A HREF="http://www.rsasecurity.com/rsalabs/pkcs/pkcs-12/index.html">PKCS#12</A>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	77	The Personal Information Exchange Syntax Standard
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	78	-->
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	79
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	80	*/

author	asimpson@symbian.org
	Thu, 15 Oct 2009 17:48:29 +0100
branch	RCL_1
changeset 13	e60b2dbc57a0
parent 0	2c201484c85f
permissions	-rw-r--r--