pk.h 4.26 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/**
 * \file pk.h
 *
 * \brief Public Key abstraction layer
 *
 *  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.
 */
#ifndef POLARSSL_PK_H
#define POLARSSL_PK_H

30 31 32 33 34 35
#include "config.h"

#if defined(POLARSSL_RSA_C)
#include "rsa.h"
#endif

36 37 38 39
#if defined(POLARSSL_ECDSA_C)
#include "ecdsa.h"
#endif

40
#define POLARSSL_ERR_PK_MALLOC_FAILED       -0x2F80  /**< Memory alloation failed. */
41
#define POLARSSL_ERR_PK_TYPE_MISMATCH       -0x2F00  /**< Type mismatch, eg attempt to use a RSA key as EC, or to modify key type */
42

43 44 45 46 47 48 49
#if defined(POLARSSL_RSA_C)
/**
 * Quick access to an RSA context inside a PK context.
 *
 * \warning You must make sure the PK context actually holds an RSA context
 * before using this macro!
 */
50
#define pk_rsa( pk )        ( (rsa_context *) (pk).data )
51
#endif /* POLARSSL_RSA_C */
52 53 54 55 56 57 58 59

#if defined(POLARSSL_ECP_C)
/**
 * Quick access to an EC context inside a PK context.
 *
 * \warning You must make sure the PK context actually holds an EC context
 * before using this macro!
 */
60
#define pk_ec( pk )         ( (ecp_keypair *) (pk).data )
61
#endif /* POLARSSL_ECP_C */
62 63


64 65 66 67 68 69 70 71 72 73
#ifdef __cplusplus
extern "C" {
#endif

/**
 * \brief          Public key types
 */
typedef enum {
    POLARSSL_PK_NONE=0,
    POLARSSL_PK_RSA,
74 75
    POLARSSL_PK_ECKEY,
    POLARSSL_PK_ECKEY_DH,
76
    POLARSSL_PK_ECDSA,
77 78
} pk_type_t;

79 80 81 82 83
/**
 * \brief           Public key container
 */
typedef struct
{
84 85 86
    pk_type_t   type;       /**< Public key type */
    void *      data;       /**< Public key data */
    int         dont_free;  /**< True if data must not be freed */
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
} pk_context;

/**
 * \brief           Initialize a pk_context (as NONE)
 */
void pk_init( pk_context *ctx );

/**
 * \brief           Free a pk_context
 */
void pk_free( pk_context *ctx );

/**
 * \brief           Set a pk_context to a given type
 *
 * \param ctx       Context to initialize
 * \param type      Type of key
 *
105 106 107 108 109 110
 * \note            Once the type of a key has been set, it cannot be reset.
 *                  If you want to do so, you need to use pk_free() first.
 *
 * \return          O on success,
 *                  POLARSSL_ERR_PK_MALLOC_FAILED on memory allocation fail,
 *                  POLARSSL_ERR_PK_TYPE_MISMATCH on attempts to reset type.
111 112 113
 */
int pk_set_type( pk_context *ctx, pk_type_t type );

114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
#if defined(POLARSSL_ECDSA_C)
/**
 * \brief           Convert a generic EC key into an ECDSA context
 *
 * \param ctx       Context to convert
 *
 * \return          0 on success, or
 *                  POLARSSL_ERR_PK_MALLOC_FAILED or
 *                  POLARSSL_ERR_PK_TYPE_MISMATCH.
 */
int pk_ec_to_ecdsa( pk_context *ctx );

/**
 * \brief           Tell if a PK context can be used for ECDSA
 *
 * \param ctx       Context to check
 *
 * \return          0 if context cannot be used for ECDSA,
 *                  1 otherwise
 */
static inline int pk_can_ecdsa( pk_context ctx )
{
    return( ctx.type == POLARSSL_PK_ECKEY ||
            ctx.type == POLARSSL_PK_ECDSA );
}
#endif /* POLARSSL_ECDSA_C */

141 142 143 144 145 146 147 148 149 150 151 152 153
#if defined(POLARSSL_RSA_C)
/**
 * \brief           Wrap a RSA context in a PK context
 *
 * \param ctx       PK context to initiliaze
 * \param rsa       RSA context to use
 *
 * \note            The PK context must be freshly initialized.
 *
 * \return          O on success,
 *                  POLARSSL_ERR_PK_TYPE_MISMATCH if ctx was not empty.
 */
int pk_wrap_rsa( pk_context *ctx, const rsa_context *rsa);
154
#endif /* POLARSSL_RSA_C */
155

156 157 158 159 160
#ifdef __cplusplus
}
#endif

#endif /* pk.h */