RSA BSAFE Crypto-C	Cryptographic Components for C
		Search

---

atypes.h

Go to the documentation of this file.

/* $Id: atypes.h,v 1.34 2004/12/14 04:38:27 sparki Exp $ */
/*
 * Copyright (C) 1998-2004 RSA Security Inc. All rights reserved.
 *
 * This work contains proprietary information of RSA Security.
 * Distribution is limited to authorized licensees of RSA
 * Security. Any unauthorized reproduction, distribution or
 * modification of this work is strictly prohibited.
 */

#ifndef _ATYPES_H_
#define _ATYPES_H_ 1

#include "bsfmacro.h"
#include "bsfplatf.h"

#include "aglobal.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
  unsigned char *key;              /* An 8-Byte Data
                                    * Encryption Standard (DES) key
                                    */
  unsigned char *inputWhitener;    /* An 8-Byte input whitener */
  unsigned char *outputWhitener;   /* An eight-Byte output whitener */
} A_DESX_KEY;

typedef struct {
  ITEM prime;                        /* The prime */
  ITEM base;                         /* The base */
  unsigned int exponentBits;
} A_DH_KEY_AGREE_PARAMS;

typedef struct {
  unsigned int primeBits;
  unsigned int exponentBits;
} A_DH_PARAM_GEN_PARAMS;

typedef struct {
  unsigned int primeBits;
  unsigned int subPrimeBits;
  unsigned int seedBytesLen;
} A_PQG_PARAM_GEN_PARAMS;


typedef struct {
  ITEM prime;                           /* The prime (p) */
  ITEM subPrime;                        /* The sub prime (q) */
  ITEM base;                            /* The base (g) */
  ITEM seed;                                     /* As per FIPS 186 standard */
  unsigned int counterValue;            /* As per FIPS 186 standard  */
} A_PQG_PARAMS;

typedef A_PQG_PARAMS A_DSA_PARAMS;

/* Note that fieldElementBits is not contained in A_EC_PARAMS,
     but can be easily recovered from fieldInfo. */

/* The following #define's are for fieldType.
     FT_FP is odd prime characteristic
     FT_F2_ONB is characteristic 2, optimal normal basis
     FT_F2_POLYNOMIAL is characteristic 2, polynomial basis
 */
#define FT_FP             0
#define FT_F2_ONB         1
#define FT_F2_POLYNOMIAL  2

/* The following definitions are extensions to overload curve
    names over field type.  Field type is implicit in the curve name.
    The curve name is used to look up the curve parameters
    and a valid field type FT_FP, FT_F2 ... is substituted.
 */
typedef enum {
    FT_NULL_CURVE=0x2FAB,
    FT_C2PNB163V1=0x1000, /* Prevent definition overlap */
    FT_C2PNB163V2,
    FT_C2PNB163V3,
    FT_C2PNB176W1,
    FT_C2TNB191V1,
    FT_C2TNB191V2,
    FT_C2TNB191V3,
    FT_C2ONB191V4,
    FT_C2ONB191V5,
    FT_C2PNB208W1,
    FT_C2TNB239V1,
    FT_C2TNB239V2,
    FT_C2TNB239V3,
    FT_C2ONB239V4,
    FT_C2ONB239V5,
    FT_C2PNB272W1,
    FT_C2PNB304W1,
    FT_C2TNB359V1,
    FT_C2PNB368W1,
    FT_C2TNB431R1,
    FT_PRIME192V1,
    FT_PRIME192V2,
    FT_PRIME192V3,
    FT_PRIME239V1,
    FT_PRIME239V2,
    FT_PRIME239V3,
    FT_PRIME256V1,
    FT_NIST_PRIME224,
    FT_NIST_PRIME384,
    FT_NIST_PRIME521,
    FT_X962_K2PNB163,
    FT_X962_K2ONB163,
    FT_X962_B2PNB163,
    FT_X962_B2ONB163,
    FT_X962_K2TNB233,
    FT_X962_K2ONB233,
    FT_X962_B2TNB233,
    FT_X962_B2ONB233,
    FT_X962_K2PNB283,
    FT_X962_K2ONB283,
    FT_X962_B2PNB283,
    FT_X962_B2ONB283,
    FT_X962_K2TNB409,
    FT_X962_K2ONB409,
    FT_X962_B2TNB409,
    FT_X962_B2ONB409,
    FT_X962_K2TNB571,
    FT_X962_K2ONB571,
    FT_X962_B2TNB571,
    FT_X962_B2ONB571,
    FT_PRIME192QV1,
    FT_NIST_PRIME224Q,
    FT_PRIME256QV1,
    FT_NIST_PRIME384Q,
    FT_NIST_PRIME521Q
} FT_X962_NAMED_CURVE_TYPE;

#define FT_PRIME_BASE FT_PRIME192V1
/*
 * Used to retrieve the BER encoded name from the curve type.
 */
#define FT_LAST_X962_CURVE FT_PRIME256V1
#define FT_FIRST_NAMED_CURVE FT_C2PNB163V1
#define FT_LAST_NAMED_CURVE FT_NIST_PRIME521


/* The following #define's are for pointRepresentation which is always
     CI_NO_COMPRESS.  X9.62 compression is explicitly avoided.
     X9.62 ASN.1 encoding is maintained so that a HYBRID point
     can be read.  The "Compressed ~y value" on a hybrid point is
     completely ignored, since such values cannot be universally
     implemented across networks.
 */
#define CI_NO_COMPRESS  0
#define CI_HYBRID 1

/* compressIndicator is deprecated as of Crypto-C Version 4.3 */
#define compressIndicator pointRepresentation

typedef struct {
  unsigned int version;
  unsigned int fieldType;         /* The base field for elliptic curve           */
  unsigned int fieldElementBits;  /* The length of field element in bits.        */                                  /* element.                                     */
  unsigned int minOrderBits;      /* The minimum size of group generated by base */
  unsigned int trialDivBound;     /* The maximum size of second largest prime    */
                                                  /* subgroup of group generated by base     */
  unsigned int pointRepresentation; /* Reserved for future use */
  unsigned int tableLookup; /* The tableLookup option available for F_{2^m} only */

} A_EC_GEN_PARAMS;

typedef struct {
  unsigned int version;
  unsigned int fieldType;
  ITEM fieldInfo;
  ITEM coeffA;
  ITEM coeffB;
#if 1
  ITEM base;
#else
  ITEM base_P;    /* 1 Byte compression (4 == no compression), 2*((len-1)/2 Bytes) X,Y */
  ITEM base_Q;    /* 1 Byte compression (4 == no compression), 2*((len-1)/2 Bytes) X,Y */
#endif
  ITEM order;
  ITEM cofactor;                     /* The cofactor * order = # points on curve */
  unsigned int pointRepresentation; /* Reserved for future use */
  unsigned int fieldElementBits;
} A_EC_PARAMS;

typedef struct {
  A_EC_PARAMS curveParams; /* Must be first field to support pointer casting */
  ITEM publicKey;
} A_EC_PUBLIC_KEY;

typedef struct {
  A_EC_PUBLIC_KEY key; /* Must be first field to support pointer casting */
  FT_X962_NAMED_CURVE_TYPE namedCurveType;
  POINTER ecInfo;                 /* If available, store EC_FP_INFO here. */
} A_EC_PUBLIC_KEY_EXTEND;

typedef struct {
  A_EC_PARAMS curveParams; /* Must be first field to support pointer casting */
  ITEM privateKey;
} A_EC_PRIVATE_KEY;

typedef struct {
  A_EC_PRIVATE_KEY key; /* Must be first field to support pointer casting */
  FT_X962_NAMED_CURVE_TYPE namedCurveType;
  POINTER ecInfo;                 /* If available, store EC_FP_INFO here. */
} A_EC_PRIVATE_KEY_EXTEND;

typedef struct {
  ITEM modulus;
  ITEM publicExponent;
  ITEM privateExponent;
  ITEM prime[2];                       /* The prime factors */
  ITEM primeExponent[2];               /* The exponents for prime factors */
  ITEM coefficient;                    /* The CRT coefficient */
} A_PKCS_RSA_PRIVATE_KEY;

typedef struct {
  ITEM modulus;
  ITEM publicExponent;
  ITEM privateExponent;
  unsigned int numberOfPrimes;
  ITEM *primes;                           /* The prime factors */
  ITEM *primeExponents;                   /* The exponents for prime factors */
  ITEM *coefficients;                     /* The CRT coefficient */
} A_PKCS_RSA_MULTI_PRIME_PRIVATE_KEY;

typedef struct {
  unsigned int effectiveKeyBits;
  unsigned char *iv;
} A_RC2_CBC_PARAMS;

typedef struct {
  unsigned int effectiveKeyBits;
} A_RC2_PARAMS;

typedef struct {
  unsigned int version;
  unsigned int rounds;
  unsigned int wordSizeInBits;
  unsigned char *iv;
} A_RC5_CBC_PARAMS;

typedef struct {
  unsigned int version;
  unsigned int rounds;
  unsigned int wordSizeInBits;
} A_RC5_PARAMS;

typedef struct {
  A_RC5_CBC_PARAMS rc5Params;
  ITEM encryptingKey;
} A_RC5_KEY_ENCRYPTING_PARAMS;


typedef struct {
  ITEM modulus;
  ITEM prime[2];                             /* The prime factors */
  ITEM primeExponent[2];                     /* The exponents for prime factors */
  ITEM coefficient;                          /* The CRT coefficient */
} A_RSA_CRT_KEY;

typedef struct {
  ITEM modulus;                              /* The modulus */
  ITEM exponent;                             /* The exponent */
} A_RSA_KEY;

typedef struct {
  unsigned int modulusBits;
  ITEM publicExponent;
} A_RSA_KEY_GEN_PARAMS;

typedef struct {
  unsigned int modulusBits;
  unsigned int numberOfPrimes;
  ITEM publicExponent;
} A_RSA_MULTI_PRIME_KEY_GEN_PARAMS;

typedef struct {
  A_RSA_KEY_GEN_PARAMS keySpecs;
  unsigned int publicKeyUsage;
  unsigned int privateKeyUsage;
  UINT4 publicLifeTime;
  UINT4 privateLifeTime;
  unsigned int protectFlag;
} A_TOKEN_RSA_KEY_GEN_PARAMS;

typedef struct {
  ITEM y;                                  /* The public component */
  A_DSA_PARAMS params;                     /* The parameters (p, q, g) */
} A_DSA_PUBLIC_KEY;

typedef struct {
  ITEM x;                                  /* The private component */
  A_DSA_PARAMS params;                     /* The parameters (p, q, g) */
} A_DSA_PRIVATE_KEY;

typedef struct {
  unsigned int numMatchBits;
  unsigned int numIndexBits;
} A_LZ77_COMPRESS_PARAMS;

typedef struct {
  unsigned int encryptionBlockLen;
} A_PKCS_PARAMS;

/* Information data structure used by FIPS Secure Hash Algorithm (SHA) random
   number generator */
typedef struct {
ITEM prime;
ITEM seed;
} A_SHA_RANDOM_PARAMS;

/* Information data structure used by the X9.31 SHA Random number generator */
typedef struct {
unsigned int numberOfStreams;
ITEM seed;
/* ITEM q;  Left off unless it's seen to be important. */
} A_X931_RANDOM_PARAMS;

#define EC_RAND_STRENGTH_DEFAULT     128

#define EC_RAND_STRENGTH_MAX         256

#define EC_RAND_PRED_RESIST_OFF     0

#define EC_RAND_PRED_RESIST_ON      1

#define EC_CT_PRIME_FIELD       0

#define EC_CT_RANDOM_BINARY     1

#define EC_CT_KOBLITZ           2

#define EC_RAND_MODE_NORMAL     0

#define EC_RAND_MODE_TEST       1

/* Information data structure used by the X9.82 Part 3 Dual EC Deterministic
 * Random Bit Generator.
 */
typedef struct {
  unsigned int strength;
  int prediction_resistance;
  ITEM string;
  unsigned int curve_type;
  int (RSA_CALLING_CONV *hashAlgorithm) PROTO_LIST ((POINTER *));
  POINTER hashAlgParams;
  int mode;
} A_EC_RANDOM_PARAMS;
#define EC_RAND_CTX_STRENGTH_DEFAULT     0

#define EC_RAND_CTX_PRED_RESIST_DEFAULT  2

#define EC_RAND_CTX_MODE_DEFAULT         2

typedef struct {
  unsigned int strength;
  int prediction_resistance;
  ITEM additional_input;
  unsigned int mode;
} A_EC_RANDOM_CTX_PARAMS;
typedef int A_ENTROPY_CB_FUNCTION(POINTER data, unsigned char *buffer,
  unsigned int len, unsigned int *num, unsigned int *entropy);
/* Information data structure used by the Entropy Gathering functions. */
typedef struct {
  A_ENTROPY_CB_FUNCTION *cb;
  POINTER cb_data;
} A_ENTROPY_PARAMS;
#define ENTROPY_CTX_STRENGTH_DEFAULT     0

#define ENTROPY_CTX_MODE_DEFAULT         3

#define ENTROPY_MODE_NORMAL         EC_RAND_MODE_NORMAL

#define ENTROPY_MODE_TEST           EC_RAND_MODE_TEST

#define ENTROPY_MODE_TEST_SOURCE    2

typedef struct {
  unsigned int strength;
  unsigned int mode;
} A_ENTROPY_CTX_PARAMS;
typedef struct {
  unsigned int blockLen;   /* Must go first to be compatible with ahchform.c */
  unsigned int oidNum;     /* Reserved for future use */
  ITEM OID;                /* Object Identifier for BER Encoding */
  } A_X931_PARAMS;

typedef struct {
  unsigned int keyUsage;
  unsigned int keyLengthInBytes;
  UINT4 lifeTime;
  unsigned int protectFlag;
  unsigned char *cipherName;
} A_SYMMETRIC_KEY_SPECIFIER;

typedef struct {
  unsigned int keyUsage;
  unsigned int keyLengthInBytes;
  UINT4 lifeTime;
  unsigned int protectFlag;
} A_SYMMETRIC_KEY_DEFINER;

typedef struct {
  A_SYMMETRIC_KEY_DEFINER externalSpecs;
  unsigned char *keyOID;
  unsigned int keyOIDLen;
  UINT4 dateOfBirth;
} A_X509_ATTRIB_INFO;


typedef struct {
  unsigned int keyUsage;
  UINT4 lifeTime;
  unsigned int protectFlag;
} A_KEYPAIR_DEFINER;

typedef struct {
  A_KEYPAIR_DEFINER privateKeyDef;
  A_KEYPAIR_DEFINER publicKeyDef;
  POINTER keyParams;
  unsigned char *cipherName;
} A_KEYPAIR_SPECIFIER;

typedef struct {
  A_KEYPAIR_DEFINER externalSpecs;
  UINT4 dateOfBirth;
} A_X509_KEYPAIR_ATTRIB_INFO;

typedef struct {
    UINT4   errorCode;
    char    errorMsg[128];
} A_RSA_EXTENDED_ERROR;


#ifdef __cplusplus
}
#endif

#endif /* _ATYPES_H_ */

---

Copyright (c) 1999-2005 RSA Security Inc. All rights reserved. 068-001001-6210-001-000 - 6.2.1