[crypto] Split crypto_algorithm into {digest,cipher,pubkey}_algorithm
[people/lynusvaz/gpxe.git] / src / include / gpxe / crypto.h
1 #ifndef _GPXE_CRYPTO_H
2 #define _GPXE_CRYPTO_H
3
4 /** @file
5  *
6  * Cryptographic API
7  *
8  */
9
10 #include <stdint.h>
11 #include <stddef.h>
12
13 /** A message digest algorithm */
14 struct digest_algorithm {
15         /** Algorithm name */
16         const char *name;
17         /** Context size */
18         size_t ctxsize;
19         /** Block size */
20         size_t blocksize;
21         /** Digest size */
22         size_t digestsize;
23         /** Initialise digest
24          *
25          * @v ctx               Context
26          */
27         void ( * init ) ( void *ctx );
28         /** Update digest with new data
29          *
30          * @v ctx               Context
31          * @v src               Data to digest
32          * @v len               Length of data
33          *
34          * @v len is not necessarily a multiple of @c blocksize.
35          */
36         void ( * update ) ( void *ctx, const void *src, size_t len );
37         /** Finalise digest
38          *
39          * @v ctx               Context
40          * @v out               Buffer for digest output
41          */
42         void ( * final ) ( void *ctx, void *out );
43 };
44
45 /** A cipher algorithm */
46 struct cipher_algorithm {
47         /** Algorithm name */
48         const char *name;
49         /** Context size */
50         size_t ctxsize;
51         /** Block size */
52         size_t blocksize;
53         /** Set key
54          *
55          * @v ctx               Context
56          * @v key               Key
57          * @v keylen            Key length
58          * @ret rc              Return status code
59          */
60         int ( * setkey ) ( void *ctx, const void *key, size_t keylen );
61         /** Set initialisation vector
62          *
63          * @v ctx               Context
64          * @v iv                Initialisation vector
65          */
66         void ( * setiv ) ( void *ctx, const void *iv );
67         /** Encrypt data
68          *
69          * @v ctx               Context
70          * @v src               Data to encrypt
71          * @v dst               Buffer for encrypted data
72          * @v len               Length of data
73          * @ret rc              Return status code
74          *
75          * @v len is guaranteed to be a multiple of @c blocksize.
76          */
77         void ( * encrypt ) ( void *ctx, const void *src, void *dst,
78                              size_t len );
79         /** Decrypt data
80          *
81          * @v ctx               Context
82          * @v src               Data to decrypt
83          * @v dst               Buffer for decrypted data
84          * @v len               Length of data
85          * @ret rc              Return status code
86          *
87          * @v len is guaranteed to be a multiple of @c blocksize.
88          */
89         void ( * decrypt ) ( void *ctx, const void *src, void *dst,
90                              size_t len );
91 };
92
93 /** A public key algorithm */
94 struct pubkey_algorithm {
95         /** Algorithm name */
96         const char *name;
97         /** Context size */
98         size_t ctxsize;
99 };
100
101 static inline void digest_init ( struct digest_algorithm *digest,
102                                  void *ctx ) {
103         digest->init ( ctx );
104 }
105
106 static inline void digest_update ( struct digest_algorithm *digest,
107                                    void *ctx, const void *data, size_t len ) {
108         digest->update ( ctx, data, len );
109 }
110
111 static inline void digest_final ( struct digest_algorithm *digest,
112                                   void *ctx, void *out ) {
113         digest->final ( ctx, out );
114 }
115
116 static inline int cipher_setkey ( struct cipher_algorithm *cipher,
117                                   void *ctx, const void *key, size_t keylen ) {
118         return cipher->setkey ( ctx, key, keylen );
119 }
120
121 static inline void cipher_setiv ( struct cipher_algorithm *cipher,
122                                   void *ctx, const void *iv ) {
123         cipher->setiv ( ctx, iv );
124 }
125
126 static inline int is_stream_cipher ( struct cipher_algorithm *cipher ) {
127         return ( cipher->blocksize == 1 );
128 }
129
130 extern int cipher_encrypt ( struct cipher_algorithm *cipher,
131                             void *ctx, const void *src, void *dst,
132                             size_t len );
133 extern int cipher_decrypt ( struct cipher_algorithm *cipher,
134                             void *ctx, const void *src, void *dst,
135                             size_t len );
136
137 extern struct digest_algorithm digest_null;
138 extern struct cipher_algorithm cipher_null;
139 extern struct pubkey_algorithm pubkey_null;
140
141 #endif /* _GPXE_CRYPTO_H */