1 /* Attribution notice: Rainbow have generously allowed me to reproduce
2 * the necessary definitions here from their API. This means the support
3 * can build independently of whether application builders have the
4 * API or hardware. This will allow developers to easily produce software
5 * that has latent hardware support for any users that have accelertors
6 * installed, without the developers themselves needing anything extra.
8 * I have only clipped the parts from the CryptoSwift header files that
9 * are (or seem) relevant to the CryptoSwift support code. This is
10 * simply to keep the file sizes reasonable.
15 /* NB: These type widths do *not* seem right in general, in particular
16 * they're not terribly friendly to 64-bit architectures (unsigned long)
17 * will be 64-bit on IA-64 for a start. I'm leaving these alone as they
18 * agree with Rainbow's API and this will only be called into question
19 * on platforms with Rainbow support anyway! ;-) */
23 #endif /* __cplusplus */
25 typedef long SW_STATUS; /* status */
26 typedef unsigned char SW_BYTE; /* 8 bit byte */
27 typedef unsigned short SW_U16; /* 16 bit number */
30 typedef __uint32_t SW_U32;
32 typedef unsigned long SW_U32; /* 32 bit integer */
36 typedef struct _SW_U64 {
39 } SW_U64; /* 64 bit integer */
41 typedef longlong SW_U64
42 #else /* Unix variants */
43 typedef struct _SW_U64 {
46 } SW_U64; /* 64 bit integer */
51 #define SW_ERR_BASE (-10000L)
52 #define SW_ERR_NO_CARD (SW_ERR_BASE-1) /* The Card is not present */
53 #define SW_ERR_CARD_NOT_READY (SW_ERR_BASE-2) /* The card has not powered */
55 #define SW_ERR_TIME_OUT (SW_ERR_BASE-3) /* Execution of a command */
57 #define SW_ERR_NO_EXECUTE (SW_ERR_BASE-4) /* The Card failed to */
58 /* execute the command */
59 #define SW_ERR_INPUT_NULL_PTR (SW_ERR_BASE-5) /* a required pointer is */
61 #define SW_ERR_INPUT_SIZE (SW_ERR_BASE-6) /* size is invalid, too */
62 /* small, too large. */
63 #define SW_ERR_INVALID_HANDLE (SW_ERR_BASE-7) /* Invalid SW_ACC_CONTEXT */
65 #define SW_ERR_PENDING (SW_ERR_BASE-8) /* A request is already out- */
66 /* standing at this */
68 #define SW_ERR_AVAILABLE (SW_ERR_BASE-9) /* A result is available. */
69 #define SW_ERR_NO_PENDING (SW_ERR_BASE-10)/* No request is pending. */
70 #define SW_ERR_NO_MEMORY (SW_ERR_BASE-11)/* Not enough memory */
71 #define SW_ERR_BAD_ALGORITHM (SW_ERR_BASE-12)/* Invalid algorithm type */
72 /* in SW_PARAM structure */
73 #define SW_ERR_MISSING_KEY (SW_ERR_BASE-13)/* No key is associated with */
75 /* swAttachKeyParam() is */
77 #define SW_ERR_KEY_CMD_MISMATCH \
78 (SW_ERR_BASE-14)/* Cannot perform requested */
79 /* SW_COMMAND_CODE since */
80 /* key attached via */
81 /* swAttachKeyParam() */
82 /* cannot be used for this*/
83 /* SW_COMMAND_CODE. */
84 #define SW_ERR_NOT_IMPLEMENTED \
85 (SW_ERR_BASE-15)/* Not implemented */
86 #define SW_ERR_BAD_COMMAND (SW_ERR_BASE-16)/* Bad command code */
87 #define SW_ERR_BAD_ITEM_SIZE (SW_ERR_BASE-17)/* too small or too large in */
88 /* the "initems" or */
90 #define SW_ERR_BAD_ACCNUM (SW_ERR_BASE-18)/* Bad accelerator number */
91 #define SW_ERR_SELFTEST_FAIL (SW_ERR_BASE-19)/* At least one of the self */
92 /* test fail, look at the */
93 /* selfTestBitmap in */
94 /* SW_ACCELERATOR_INFO for*/
96 #define SW_ERR_MISALIGN (SW_ERR_BASE-20)/* Certain alogrithms require*/
97 /* key materials aligned */
98 /* in certain order, e.g. */
100 #define SW_ERR_OUTPUT_NULL_PTR \
101 (SW_ERR_BASE-21)/* a required pointer is */
103 #define SW_ERR_OUTPUT_SIZE \
104 (SW_ERR_BASE-22)/* size is invalid, too */
105 /* small, too large. */
106 #define SW_ERR_FIRMWARE_CHECKSUM \
107 (SW_ERR_BASE-23)/* firmware checksum mismatch*/
108 /* download failed. */
109 #define SW_ERR_UNKNOWN_FIRMWARE \
110 (SW_ERR_BASE-24)/* unknown firmware error */
111 #define SW_ERR_INTERRUPT (SW_ERR_BASE-25)/* request is abort when */
112 /* it's waiting to be */
114 #define SW_ERR_NVWRITE_FAIL (SW_ERR_BASE-26)/* error in writing to Non- */
115 /* volatile memory */
116 #define SW_ERR_NVWRITE_RANGE (SW_ERR_BASE-27)/* out of range error in */
117 /* writing to NV memory */
118 #define SW_ERR_RNG_ERROR (SW_ERR_BASE-28)/* Random Number Generation */
120 #define SW_ERR_DSS_FAILURE (SW_ERR_BASE-29)/* DSS Sign or Verify failure*/
121 #define SW_ERR_MODEXP_FAILURE (SW_ERR_BASE-30)/* Failure in various math */
123 #define SW_ERR_ONBOARD_MEMORY (SW_ERR_BASE-31)/* Error in accessing on - */
125 #define SW_ERR_FIRMWARE_VERSION \
126 (SW_ERR_BASE-32)/* Wrong version in firmware */
128 #define SW_ERR_ZERO_WORKING_ACCELERATOR \
129 (SW_ERR_BASE-44)/* All accelerators are bad */
136 #define SW_ALG_NVDATA 4
139 #define SW_CMD_MODEXP_CRT 1 /* perform Modular Exponentiation using */
140 /* Chinese Remainder Theorem (CRT) */
141 #define SW_CMD_MODEXP 2 /* perform Modular Exponentiation */
142 #define SW_CMD_DSS_SIGN 3 /* perform DSS sign */
143 #define SW_CMD_DSS_VERIFY 4 /* perform DSS verify */
144 #define SW_CMD_RAND 5 /* perform random number generation */
145 #define SW_CMD_NVREAD 6 /* perform read to nonvolatile RAM */
146 #define SW_CMD_NVWRITE 7 /* perform write to nonvolatile RAM */
148 typedef SW_U32 SW_ALGTYPE; /* alogrithm type */
149 typedef SW_U32 SW_STATE; /* state */
150 typedef SW_U32 SW_COMMAND_CODE; /* command code */
151 typedef SW_U32 SW_COMMAND_BITMAP[4]; /* bitmap */
153 typedef struct _SW_LARGENUMBER {
154 SW_U32 nbytes; /* number of bytes in the buffer "value" */
155 SW_BYTE* value; /* the large integer as a string of */
156 /* bytes in network (big endian) order */
159 typedef struct _SW_CRT {
160 SW_LARGENUMBER p; /* prime number p */
161 SW_LARGENUMBER q; /* prime number q */
162 SW_LARGENUMBER dmp1; /* exponent1 */
163 SW_LARGENUMBER dmq1; /* exponent2 */
164 SW_LARGENUMBER iqmp; /* CRT coefficient */
167 typedef struct _SW_EXP {
168 SW_LARGENUMBER modulus; /* modulus */
169 SW_LARGENUMBER exponent;/* exponent */
172 typedef struct _SW_DSA {
173 SW_LARGENUMBER p; /* */
174 SW_LARGENUMBER q; /* */
175 SW_LARGENUMBER g; /* */
176 SW_LARGENUMBER key; /* private/public key */
179 typedef struct _SW_NVDATA {
180 SW_U32 accnum; /* accelerator board number */
181 SW_U32 offset; /* offset in byte */
184 typedef struct _SW_PARAM {
185 SW_ALGTYPE type; /* type of the alogrithm */
194 typedef SW_U32 SW_CONTEXT_HANDLE; /* opaque context handle */
197 /* Now the OpenSSL bits, these function types are the for the function
198 * pointers that will bound into the Rainbow shared libraries. */
199 typedef SW_STATUS t_swAcquireAccContext(SW_CONTEXT_HANDLE *hac);
200 typedef SW_STATUS t_swAttachKeyParam(SW_CONTEXT_HANDLE hac,
201 SW_PARAM *key_params);
202 typedef SW_STATUS t_swSimpleRequest(SW_CONTEXT_HANDLE hac,
204 SW_LARGENUMBER pin[],
206 SW_LARGENUMBER pout[],
208 typedef SW_STATUS t_swReleaseAccContext(SW_CONTEXT_HANDLE hac);
212 #endif /* __cplusplus */