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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/*-
* Copyright 2016 Vsevolod Stakhov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef SRC_LIBCRYPTOBOX_KEYPAIR_H_
#define SRC_LIBCRYPTOBOX_KEYPAIR_H_
#include "config.h"
#include "cryptobox.h"
#include "ucl.h"
/**
* Keypair type
*/
enum rspamd_cryptobox_keypair_type {
RSPAMD_KEYPAIR_KEX = 0,
RSPAMD_KEYPAIR_SIGN
};
/**
* Opaque structure for the full (public + private) keypair
*/
struct rspamd_cryptobox_keypair;
/**
* Opaque structure for public only keypair
*/
struct rspamd_cryptobox_pubkey;
/**
* Creates new full keypair
* @param type type of the keypair
* @param alg algorithm for the keypair
* @return fresh keypair generated
*/
struct rspamd_cryptobox_keypair* rspamd_keypair_new (
enum rspamd_cryptobox_keypair_type type,
enum rspamd_cryptobox_mode alg);
/**
* Increase refcount for the specific keypair
* @param kp
* @return
*/
struct rspamd_cryptobox_keypair* rspamd_keypair_ref (
struct rspamd_cryptobox_keypair *kp);
/**
* Decrease refcount for the specific keypair (or destroy when refcount == 0)
* @param kp
*/
void rspamd_keypair_unref (struct rspamd_cryptobox_keypair *kp);
/**
* Increase refcount for the specific pubkey
* @param kp
* @return
*/
struct rspamd_cryptobox_pubkey* rspamd_pubkey_ref (
struct rspamd_cryptobox_pubkey *kp);
/**
* Load pubkey from base32 string
* @param b32 input string
* @param type type of key (signing or kex)
* @param alg algorithm of the key (nist or curve25519)
* @return new pubkey or NULL in case of error
*/
struct rspamd_cryptobox_pubkey* rspamd_pubkey_from_base32 (const gchar *b32,
gsize len,
enum rspamd_cryptobox_keypair_type type,
enum rspamd_cryptobox_mode alg);
/**
* Load pubkey from hex string
* @param hex input string
* @param type type of key (signing or kex)
* @param alg algorithm of the key (nist or curve25519)
* @return new pubkey or NULL in case of error
*/
struct rspamd_cryptobox_pubkey* rspamd_pubkey_from_hex (const gchar *hex,
gsize len,
enum rspamd_cryptobox_keypair_type type,
enum rspamd_cryptobox_mode alg);
/**
* Decrease refcount for the specific pubkey (or destroy when refcount == 0)
* @param kp
*/
void rspamd_pubkey_unref (struct rspamd_cryptobox_pubkey *kp);
/**
* Get type of keypair
*/
enum rspamd_cryptobox_keypair_type rspamd_keypair_type (
struct rspamd_cryptobox_keypair *kp);
/**
* Get type of pubkey
*/
enum rspamd_cryptobox_keypair_type rspamd_pubkey_type (
struct rspamd_cryptobox_pubkey *p);
/**
* Get algorithm of keypair
*/
enum rspamd_cryptobox_mode rspamd_keypair_alg (struct rspamd_cryptobox_keypair *kp);
/**
* Get algorithm of pubkey
*/
enum rspamd_cryptobox_mode rspamd_pubkey_alg (struct rspamd_cryptobox_pubkey *p);
/**
* Get cached NM for this specific pubkey
* @param p
* @return
*/
const guchar * rspamd_pubkey_get_nm (struct rspamd_cryptobox_pubkey *p);
/**
* Calculate and store nm value for the specified local key (performs ECDH)
* @param p
* @return
*/
const guchar * rspamd_pubkey_calculate_nm (struct rspamd_cryptobox_pubkey *p,
struct rspamd_cryptobox_keypair *kp);
/**
* Get raw public key id for a specified keypair (rspamd_cryptobox_HASHBYTES)
* @param kp
* @return
*/
const guchar * rspamd_keypair_get_id (struct rspamd_cryptobox_keypair *kp);
/**
* Get raw public key id for a specified key (rspamd_cryptobox_HASHBYTES)
* @param kp
* @return
*/
const guchar * rspamd_pubkey_get_id (struct rspamd_cryptobox_pubkey *pk);
/** Print pubkey */
#define RSPAMD_KEYPAIR_PUBKEY 0x1
/** Print secret key */
#define RSPAMD_KEYPAIR_PRIVKEY 0x2
/** Print key id */
#define RSPAMD_KEYPAIR_ID 0x4
/** Print short key id */
#define RSPAMD_KEYPAIR_ID_SHORT 0x8
/** Encode output with base 32 */
#define RSPAMD_KEYPAIR_BASE32 0x10
/** Human readable output */
#define RSPAMD_KEYPAIR_HUMAN 0x20
#define RSPAMD_KEYPAIR_HEX 0x40
/**
* Print keypair encoding it if needed
* @param key key to print
* @param how flags that specifies printing behaviour
* @return newly allocated string with keypair
*/
GString *rspamd_keypair_print (struct rspamd_cryptobox_keypair *kp,
guint how);
#endif /* SRC_LIBCRYPTOBOX_KEYPAIR_H_ */
|
