/*********************************************************************
*
* RSA Public Key Encryption Library Header
*
*********************************************************************
* FileName: RSA.h
* Dependencies: BigInt.h
* Processor: PIC18, PIC24F, PIC24H, dsPIC30F, dsPIC33F, PIC32
* Compiler: Microchip C32 v1.05 or higher
* Microchip C30 v3.12 or higher
* Microchip C18 v3.30 or higher
* Company: Microchip Technology, Inc.
*
* Software License Agreement
*
* Copyright (C) 2002-2009 Microchip Technology Inc. All rights
* reserved.
*
* Microchip licenses to you the right to use, modify, copy, and
* distribute:
* (i) the Software when embedded on a Microchip microcontroller or
* digital signal controller product ("Device") which is
* integrated into Licensee's product; or
* (ii) ONLY the Software driver source files ENC28J60.c, ENC28J60.h,
* ENCX24J600.c and ENCX24J600.h ported to a non-Microchip device
* used in conjunction with a Microchip ethernet controller for
* the sole purpose of interfacing with the ethernet controller.
*
* You should refer to the license agreement accompanying this
* Software for additional information regarding your rights and
* obligations.
*
* THE SOFTWARE AND DOCUMENTATION ARE PROVIDED "AS IS" WITHOUT
* WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT
* LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS FOR A
* PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL
* MICROCHIP BE LIABLE FOR ANY INCIDENTAL, SPECIAL, INDIRECT OR
* CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF
* PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR SERVICES, ANY CLAIMS
* BY THIRD PARTIES (INCLUDING BUT NOT LIMITED TO ANY DEFENSE
* THEREOF), ANY CLAIMS FOR INDEMNITY OR CONTRIBUTION, OR OTHER
* SIMILAR COSTS, WHETHER ASSERTED ON THE BASIS OF CONTRACT, TORT
* (INCLUDING NEGLIGENCE), BREACH OF WARRANTY, OR OTHERWISE.
*
* IMPORTANT: The implementation and use of third party algorithms,
* specifications and/or other technology may require a license from
* various third parties. It is your responsibility to obtain
* information regarding any applicable licensing obligations.
*
*
* Author Date Comment
*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Elliott Wood 2/14/07 Original
* Elliott Wood 10/15/07 Modified API to support both ops
********************************************************************/
#ifndef __RSA_H
#define __RSA_H
#define RSA_KEY_WORDS (SSL_RSA_KEY_SIZE/BIGINT_DATA_SIZE) // Represents the number of words in a key
#define RSA_PRIME_WORDS (SSL_RSA_KEY_SIZE/BIGINT_DATA_SIZE/2) // Represents the number of words in an RSA prime
/****************************************************************************
Section:
State Machines and Status Codes
***************************************************************************/
// State machine for RSA processes
typedef enum
{
SM_RSA_IDLE = 0u, // Data is being initialized by the application
SM_RSA_ENCRYPT_START, // Initial state for encryption processes; encryption is ready to begin
SM_RSA_ENCRYPT, // RSA encryption is proceeding
SM_RSA_DECRYPT_START, // Initial state for decryption processes; decryption is ready to begin
SM_RSA_DECRYPT_FIND_M1, // First stage in the CRT decryption algorithm
SM_RSA_DECRYPT_FIND_M2, // Second stage in the CRT decryption algorithm
SM_RSA_DECRYPT_FINISH, // CRT values have been calculated, so finalize the operation
SM_RSA_DONE // RSA process is complete
} SM_RSA;
// Status response from RSA procedures
typedef enum
{
RSA_WORKING = 0u, // RSA is working through a calculation
RSA_FINISHED_M1, // RSA decryption has just completed calculation of the M1 CRT value
RSA_FINISHED_M2, // RSA decryption has just completed calculation of the M2 CRT value
RSA_DONE // The RSA calculation is complete
} RSA_STATUS;
// Indicates the data format for any RSA integer
typedef enum
{
RSA_BIG_ENDIAN = 0u, // Data expressed with the most significant byte first
RSA_LITTLE_ENDIAN // Data expressed with the least significant byte first
} RSA_DATA_FORMAT;
// Indicates the RSA operation to be completed
typedef enum
{
RSA_OP_ENCRYPT = 0u, // This is an encryption procedure
RSA_OP_DECRYPT // This is a decryption procedure
} RSA_OP;
/****************************************************************************
Section:
Function Prototypes
***************************************************************************/
void RSAInit(void);
BOOL RSABeginUsage(RSA_OP op, BYTE vKeyByteLen);
void RSAEndUsage(void);
void RSASetData(BYTE* data, BYTE len, RSA_DATA_FORMAT format);
void RSASetResult(BYTE* data, RSA_DATA_FORMAT format);
RSA_STATUS RSAStep(void);
#if defined(STACK_USE_RSA_ENCRYPT)
#define RSABeginEncrypt(a) RSABeginUsage(RSA_OP_ENCRYPT, a)
#define RSAEndEncrypt() RSAEndUsage()
void RSASetE(BYTE* data, BYTE len, RSA_DATA_FORMAT format);
void RSASetN(BYTE* data, RSA_DATA_FORMAT format);
#endif
#if defined(STACK_USE_RSA_DECRYPT)
#define RSABeginDecrypt() RSABeginUsage(RSA_OP_DECRYPT, SSL_RSA_KEY_SIZE/8)
#define RSAEndDecrypt() RSAEndUsage()
#endif
/****************************************************************************
Section:
BigInt Function Selection
Determines which BigInt functions to compile.
***************************************************************************/
#if defined(STACK_USE_RSA_ENCRYPT)
#define BI_USE_CONSTRUCTOR
#define BI_USE_ZERO
#define BI_USE_MOD
#define BI_USE_COMPARE
#define BI_USE_MAG_DIFF
#define BI_USE_MAG
#define BI_USE_MSB
#define BI_USE_MULTIPLY
#define BI_USE_SQUARE
#define BI_USE_COPY
#endif
#if defined(STACK_USE_RSA_DECRYPT)
#define BI_USE_CONSTRUCTOR
#define BI_USE_ZERO
#define BI_USE_COMPARE
#define BI_USE_MAG
#define BI_USE_MSB
#define BI_USE_MULTIPLY
#define BI_USE_SQUARE
#define BI_USE_ADD
#define BI_USE_SUBTRACT
#define BI_USE_COPY
#if defined(__18CXX)
#define BI_USE_CONSTRUCTOR_ROM
#define BI_USE_COPY_ROM
#define BI_USE_MOD_ROM
#define BI_USE_COMPARE_ROM
#define BI_USE_MAG_DIFF_ROM
#define BI_USE_MAG_ROM
#define BI_USE_MULTIPLY_ROM
#else
#define BI_USE_MAG_DIFF
#define BI_USE_MOD
#endif
#endif
#endif
|