PolarSSL v1.3.1
|
Public Key abstraction layer. More...
Go to the source code of this file.
Data Structures | |
struct | pk_debug_item |
Item to send to the debug module. More... | |
struct | pk_info_t |
Public key information and operations. More... | |
struct | pk_context |
Public key container. More... | |
Macros | |
#define | POLARSSL_ERR_PK_MALLOC_FAILED -0x2F80 |
Memory alloation failed. More... | |
#define | POLARSSL_ERR_PK_TYPE_MISMATCH -0x2F00 |
Type mismatch, eg attempt to encrypt with an ECDSA key. More... | |
#define | POLARSSL_ERR_PK_BAD_INPUT_DATA -0x2E80 |
Bad input parameters to function. More... | |
#define | POLARSSL_ERR_PK_FILE_IO_ERROR -0x2E00 |
Read/write of file failed. More... | |
#define | POLARSSL_ERR_PK_KEY_INVALID_VERSION -0x2D80 |
Unsupported key version. More... | |
#define | POLARSSL_ERR_PK_KEY_INVALID_FORMAT -0x2D00 |
Invalid key tag or value. More... | |
#define | POLARSSL_ERR_PK_UNKNOWN_PK_ALG -0x2C80 |
Key algorithm is unsupported (only RSA and EC are supported). More... | |
#define | POLARSSL_ERR_PK_PASSWORD_REQUIRED -0x2C00 |
Private key password can't be empty. More... | |
#define | POLARSSL_ERR_PK_PASSWORD_MISMATCH -0x2B80 |
Given private key password does not allow for correct decryption. More... | |
#define | POLARSSL_ERR_PK_INVALID_PUBKEY -0x2B00 |
The pubkey tag or value is invalid (only RSA and EC are supported). More... | |
#define | POLARSSL_ERR_PK_INVALID_ALG -0x2A80 |
The algorithm tag or value is invalid. More... | |
#define | POLARSSL_ERR_PK_UNKNOWN_NAMED_CURVE -0x2A00 |
Elliptic curve is unsupported (only NIST curves are supported). More... | |
#define | POLARSSL_ERR_PK_FEATURE_UNAVAILABLE -0x2980 |
Unavailable feature, e.g. More... | |
#define | pk_rsa(pk) ( (rsa_context *) (pk).pk_ctx ) |
Quick access to an RSA context inside a PK context. More... | |
#define | pk_ec(pk) ( (ecp_keypair *) (pk).pk_ctx ) |
Quick access to an EC context inside a PK context. More... | |
#define | POLARSSL_PK_DEBUG_MAX_ITEMS 3 |
Maximum number of item send for debugging, plus 1. More... | |
Typedefs | |
typedef int(* | pk_rsa_alt_decrypt_func )(void *ctx, int mode, size_t *olen, const unsigned char *input, unsigned char *output, size_t output_max_len) |
Types for RSA-alt abstraction. More... | |
typedef int(* | pk_rsa_alt_sign_func )(void *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, int hash_id, unsigned int hashlen, const unsigned char *hash, unsigned char *sig) |
typedef size_t(* | pk_rsa_alt_key_len_func )(void *ctx) |
Enumerations | |
enum | pk_type_t { POLARSSL_PK_NONE =0, POLARSSL_PK_RSA, POLARSSL_PK_ECKEY, POLARSSL_PK_ECKEY_DH, POLARSSL_PK_ECDSA, POLARSSL_PK_RSA_ALT } |
Public key types. More... | |
enum | pk_debug_type { POLARSSL_PK_DEBUG_NONE = 0, POLARSSL_PK_DEBUG_MPI, POLARSSL_PK_DEBUG_ECP } |
Types for interfacing with the debug module. More... | |
Functions | |
const pk_info_t * | pk_info_from_type (pk_type_t pk_type) |
Return information associated with the given PK type. More... | |
void | pk_init (pk_context *ctx) |
Initialize a pk_context (as NONE) More... | |
void | pk_free (pk_context *ctx) |
Free a pk_context. More... | |
int | pk_init_ctx (pk_context *ctx, const pk_info_t *info) |
Initialize a PK context with the information given and allocates the type-specific PK subcontext. More... | |
int | pk_init_ctx_rsa_alt (pk_context *ctx, void *key, pk_rsa_alt_decrypt_func decrypt_func, pk_rsa_alt_sign_func sign_func, pk_rsa_alt_key_len_func key_len_func) |
Initialize an RSA-alt context. More... | |
size_t | pk_get_size (const pk_context *ctx) |
Get the size in bits of the underlying key. More... | |
static size_t | pk_get_len (const pk_context *ctx) |
Get the length in bytes of the underlying key. More... | |
int | pk_can_do (pk_context *ctx, pk_type_t type) |
Tell if a context can do the operation given by type. More... | |
int | pk_verify (pk_context *ctx, md_type_t md_alg, const unsigned char *hash, size_t hash_len, const unsigned char *sig, size_t sig_len) |
Verify signature. More... | |
int | pk_sign (pk_context *ctx, md_type_t md_alg, const unsigned char *hash, size_t hash_len, unsigned char *sig, size_t *sig_len, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng) |
Make signature. More... | |
int | pk_decrypt (pk_context *ctx, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen, size_t osize, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng) |
Decrypt message. More... | |
int | pk_encrypt (pk_context *ctx, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen, size_t osize, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng) |
Encrypt message. More... | |
int | pk_debug (const pk_context *ctx, pk_debug_item *items) |
Export debug information. More... | |
const char * | pk_get_name (const pk_context *ctx) |
Access the type name. More... | |
pk_type_t | pk_get_type (const pk_context *ctx) |
Get the key type. More... | |
int | pk_parse_key (pk_context *ctx, const unsigned char *key, size_t keylen, const unsigned char *pwd, size_t pwdlen) |
Parse a private key. More... | |
int | pk_parse_public_key (pk_context *ctx, const unsigned char *key, size_t keylen) |
Parse a public key. More... | |
int | pk_parse_keyfile (pk_context *ctx, const char *path, const char *password) |
Load and parse a private key. More... | |
int | pk_parse_public_keyfile (pk_context *ctx, const char *path) |
Load and parse a public key. More... | |
int | pk_write_key_der (pk_context *pk, unsigned char *buf, size_t size) |
Write a private key to a PKCS#1 or SEC1 DER structure Note: data is written at the end of the buffer! Use the return value to determine where you should start using the buffer. More... | |
int | pk_write_pubkey_der (pk_context *key, unsigned char *buf, size_t size) |
Write a public key to a SubjectPublicKeyInfo DER structure Note: data is written at the end of the buffer! Use the return value to determine where you should start using the buffer. More... | |
int | pk_write_pubkey_pem (pk_context *key, unsigned char *buf, size_t size) |
Write a public key to a PEM string. More... | |
int | pk_write_key_pem (pk_context *key, unsigned char *buf, size_t size) |
Write a private key to a PKCS#1 or SEC1 PEM string. More... | |
int | pk_parse_subpubkey (unsigned char **p, const unsigned char *end, pk_context *pk) |
Parse a SubjectPublicKeyInfo DER structure. More... | |
int | pk_write_pubkey (unsigned char **p, unsigned char *start, const pk_context *key) |
Write a subjectPublicKey to ASN.1 data Note: function works backwards in data buffer. More... | |
Public Key abstraction layer.
Public Key abstraction layer: wrapper functions.
Copyright (C) 2006-2013, Brainspark B.V.
This file is part of PolarSSL (http://www.polarssl.org) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
All rights reserved.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Definition in file pk.h.
#define pk_ec | ( | pk | ) | ( (ecp_keypair *) (pk).pk_ctx ) |
#define pk_rsa | ( | pk | ) | ( (rsa_context *) (pk).pk_ctx ) |
Quick access to an RSA context inside a PK context.
Definition at line 69 of file pk.h.
Referenced by x509_write_key_der(), x509_write_pubkey_der(), x509parse_key(), x509parse_keyfile(), x509parse_public_key(), and x509parse_public_keyfile().
#define POLARSSL_ERR_PK_BAD_INPUT_DATA -0x2E80 |
#define POLARSSL_ERR_PK_FEATURE_UNAVAILABLE -0x2980 |
#define POLARSSL_ERR_PK_FILE_IO_ERROR -0x2E00 |
#define POLARSSL_ERR_PK_INVALID_ALG -0x2A80 |
#define POLARSSL_ERR_PK_INVALID_PUBKEY -0x2B00 |
#define POLARSSL_ERR_PK_KEY_INVALID_FORMAT -0x2D00 |
#define POLARSSL_ERR_PK_KEY_INVALID_VERSION -0x2D80 |
#define POLARSSL_ERR_PK_MALLOC_FAILED -0x2F80 |
#define POLARSSL_ERR_PK_PASSWORD_MISMATCH -0x2B80 |
#define POLARSSL_ERR_PK_PASSWORD_REQUIRED -0x2C00 |
#define POLARSSL_ERR_PK_TYPE_MISMATCH -0x2F00 |
Type mismatch, eg attempt to encrypt with an ECDSA key.
Definition at line 48 of file pk.h.
Referenced by x509parse_key(), x509parse_keyfile(), x509parse_public_key(), and x509parse_public_keyfile().
#define POLARSSL_ERR_PK_UNKNOWN_NAMED_CURVE -0x2A00 |
#define POLARSSL_ERR_PK_UNKNOWN_PK_ALG -0x2C80 |
#define POLARSSL_PK_DEBUG_MAX_ITEMS 3 |
typedef int(* pk_rsa_alt_decrypt_func)(void *ctx, int mode, size_t *olen, const unsigned char *input, unsigned char *output, size_t output_max_len) |
typedef int(* pk_rsa_alt_sign_func)(void *ctx, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng, int mode, int hash_id, unsigned int hashlen, const unsigned char *hash, unsigned char *sig) |
enum pk_debug_type |
enum pk_type_t |
int pk_can_do | ( | pk_context * | ctx, |
pk_type_t | type | ||
) |
Tell if a context can do the operation given by type.
ctx | Context to test |
type | Target type |
Referenced by x509parse_key(), x509parse_keyfile(), x509parse_public_key(), and x509parse_public_keyfile().
int pk_debug | ( | const pk_context * | ctx, |
pk_debug_item * | items | ||
) |
Export debug information.
ctx | Context to use |
items | Place to write debug items |
int pk_decrypt | ( | pk_context * | ctx, |
const unsigned char * | input, | ||
size_t | ilen, | ||
unsigned char * | output, | ||
size_t * | olen, | ||
size_t | osize, | ||
int(*)(void *, unsigned char *, size_t) | f_rng, | ||
void * | p_rng | ||
) |
Decrypt message.
ctx | PK context to use |
input | Input to decrypt |
ilen | Input size |
output | Decrypted output |
olen | Decrypted message length |
osize | Size of the output buffer |
f_rng | RNG function |
p_rng | RNG parameter |
int pk_encrypt | ( | pk_context * | ctx, |
const unsigned char * | input, | ||
size_t | ilen, | ||
unsigned char * | output, | ||
size_t * | olen, | ||
size_t | osize, | ||
int(*)(void *, unsigned char *, size_t) | f_rng, | ||
void * | p_rng | ||
) |
Encrypt message.
ctx | PK context to use |
input | Message to encrypt |
ilen | Message size |
output | Encrypted output |
olen | Encrypted output length |
osize | Size of the output buffer |
f_rng | RNG function |
p_rng | RNG parameter |
void pk_free | ( | pk_context * | ctx | ) |
Free a pk_context.
Referenced by x509_write_key_der(), x509_write_pubkey_der(), x509parse_key(), x509parse_keyfile(), x509parse_public_key(), and x509parse_public_keyfile().
|
inlinestatic |
Get the length in bytes of the underlying key.
ctx | Context to use |
Definition at line 264 of file pk.h.
References pk_get_size().
const char* pk_get_name | ( | const pk_context * | ctx | ) |
Access the type name.
ctx | Context to use |
size_t pk_get_size | ( | const pk_context * | ctx | ) |
Get the size in bits of the underlying key.
ctx | Context to use |
Referenced by pk_get_len().
pk_type_t pk_get_type | ( | const pk_context * | ctx | ) |
Get the key type.
ctx | Context to use |
Return information associated with the given PK type.
pk_type | PK type to search for. |
Referenced by x509_write_key_der(), and x509_write_pubkey_der().
void pk_init | ( | pk_context * | ctx | ) |
Initialize a pk_context (as NONE)
Referenced by x509parse_key(), x509parse_keyfile(), x509parse_public_key(), and x509parse_public_keyfile().
int pk_init_ctx | ( | pk_context * | ctx, |
const pk_info_t * | info | ||
) |
Initialize a PK context with the information given and allocates the type-specific PK subcontext.
ctx | Context to initialize. Must be empty (type NONE). |
info | Information to use |
pk_init_ctx_rsa_alt()
instead. Referenced by x509_write_key_der(), and x509_write_pubkey_der().
int pk_init_ctx_rsa_alt | ( | pk_context * | ctx, |
void * | key, | ||
pk_rsa_alt_decrypt_func | decrypt_func, | ||
pk_rsa_alt_sign_func | sign_func, | ||
pk_rsa_alt_key_len_func | key_len_func | ||
) |
Initialize an RSA-alt context.
ctx | Context to initialize. Must be empty (type NONE). |
key | RSA key pointer |
decrypt_func | Decryption function |
sign_func | Signing function |
key_len_func | Function returning key length |
pk_init_ctx()
for RSA-alt. int pk_parse_key | ( | pk_context * | ctx, |
const unsigned char * | key, | ||
size_t | keylen, | ||
const unsigned char * | pwd, | ||
size_t | pwdlen | ||
) |
Parse a private key.
ctx | key to be initialized |
key | input buffer |
keylen | size of the buffer |
pwd | password for decryption (optional) |
pwdlen | size of the password |
Referenced by x509parse_key().
int pk_parse_keyfile | ( | pk_context * | ctx, |
const char * | path, | ||
const char * | password | ||
) |
Load and parse a private key.
ctx | key to be initialized |
path | filename to read the private key from |
password | password to decrypt the file (can be NULL) |
Referenced by x509parse_keyfile().
int pk_parse_public_key | ( | pk_context * | ctx, |
const unsigned char * | key, | ||
size_t | keylen | ||
) |
Parse a public key.
ctx | key to be initialized |
key | input buffer |
keylen | size of the buffer |
Referenced by x509parse_public_key().
int pk_parse_public_keyfile | ( | pk_context * | ctx, |
const char * | path | ||
) |
Load and parse a public key.
ctx | key to be initialized |
path | filename to read the private key from |
Referenced by x509parse_public_keyfile().
int pk_parse_subpubkey | ( | unsigned char ** | p, |
const unsigned char * | end, | ||
pk_context * | pk | ||
) |
Parse a SubjectPublicKeyInfo DER structure.
p | the position in the ASN.1 data |
end | end of the buffer |
pk | the key to fill |
int pk_sign | ( | pk_context * | ctx, |
md_type_t | md_alg, | ||
const unsigned char * | hash, | ||
size_t | hash_len, | ||
unsigned char * | sig, | ||
size_t * | sig_len, | ||
int(*)(void *, unsigned char *, size_t) | f_rng, | ||
void * | p_rng | ||
) |
Make signature.
ctx | PK context to use |
md_alg | Hash algorithm used (see notes) |
hash | Hash of the message to sign |
hash_len | Hash length or 0 (see notes) |
sig | Place to write the signature |
sig_len | Number of bytes written |
f_rng | RNG function |
p_rng | RNG parameter |
int pk_verify | ( | pk_context * | ctx, |
md_type_t | md_alg, | ||
const unsigned char * | hash, | ||
size_t | hash_len, | ||
const unsigned char * | sig, | ||
size_t | sig_len | ||
) |
Verify signature.
ctx | PK context to use |
md_alg | Hash algorithm used (see notes) |
hash | Hash of the message to sign |
hash_len | Hash length or 0 (see notes) |
sig | Signature to verify |
sig_len | Signature length |
int pk_write_key_der | ( | pk_context * | pk, |
unsigned char * | buf, | ||
size_t | size | ||
) |
Write a private key to a PKCS#1 or SEC1 DER structure Note: data is written at the end of the buffer! Use the return value to determine where you should start using the buffer.
key | private to write away |
buf | buffer to write to |
size | size of the buffer |
Referenced by x509_write_key_der().
int pk_write_key_pem | ( | pk_context * | key, |
unsigned char * | buf, | ||
size_t | size | ||
) |
Write a private key to a PKCS#1 or SEC1 PEM string.
key | private to write away |
buf | buffer to write to |
size | size of the buffer |
int pk_write_pubkey | ( | unsigned char ** | p, |
unsigned char * | start, | ||
const pk_context * | key | ||
) |
Write a subjectPublicKey to ASN.1 data Note: function works backwards in data buffer.
p | reference to current position pointer |
start | start of the buffer (for bounds-checking) |
key | public key to write away |
int pk_write_pubkey_der | ( | pk_context * | key, |
unsigned char * | buf, | ||
size_t | size | ||
) |
Write a public key to a SubjectPublicKeyInfo DER structure Note: data is written at the end of the buffer! Use the return value to determine where you should start using the buffer.
key | public key to write away |
buf | buffer to write to |
size | size of the buffer |
Referenced by x509_write_pubkey_der().
int pk_write_pubkey_pem | ( | pk_context * | key, |
unsigned char * | buf, | ||
size_t | size | ||
) |
Write a public key to a PEM string.
key | public key to write away |
buf | buffer to write to |
size | size of the buffer |