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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
/*
SSSD - auth utils
Copyright (C) Simo Sorce <simo@redhat.com> 2012
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __AUTHTOK_H__
#define __AUTHTOK_H__
#include "util/util.h"
#include "util/authtok-utils.h"
#include "sss_client/sss_cli.h"
/* Use sss_authtok_* accesor functions instead of struct sss_auth_token
*/
struct sss_auth_token;
/**
* @brief Returns the token type
*
* @param tok A pointer to an sss_auth_token
*
* @return A sss_authtok_type (empty, password, ...)
*/
enum sss_authtok_type sss_authtok_get_type(struct sss_auth_token *tok);
/**
* @brief Returns the token size
*
* @param tok A pointer to an sss_auth_token
*
* @return The current size of the token payload
*/
size_t sss_authtok_get_size(struct sss_auth_token *tok);
/**
* @brief Get the data buffer
*
* @param tok A pointer to an sss_auth_token
*
* @return A pointer to the token payload
*/
uint8_t *sss_authtok_get_data(struct sss_auth_token *tok);
/**
* @brief Returns a const string if the auth token is of type
SSS_AUTHTOK_TYPE_PASSWORD, otherwise it returns an error
*
* @param tok A pointer to an sss_auth_token
* @param pwd A pointer to a const char *, that will point to a null
* terminated string
* @param len The length of the password string
*
* @return EOK on success
* ENOENT if the token is empty
* EACCESS if the token is not a password token
*/
errno_t sss_authtok_get_password(struct sss_auth_token *tok,
const char **pwd, size_t *len);
/**
* @brief Set a password into a an auth token, replacing any previous data
*
* @param tok A pointer to a sss_auth_token structure to change, also
* used as a memory context to allocate the internal data.
* @param password A string
* @param len The length of the string or, if 0 is passed,
* then strlen(password) will be used internally.
*
* @return EOK on success
* ENOMEM on error
*/
errno_t sss_authtok_set_password(struct sss_auth_token *tok,
const char *password, size_t len);
/**
* @brief Returns a const string if the auth token is of type
SSS_AUTHTOK_TYPE_CCFILE, otherwise it returns an error
*
* @param tok A pointer to an sss_auth_token
* @param ccfile A pointer to a const char *, that will point to a null
* terminated string, also used as a memory context use to allocate the internal data
* @param len The length of the string
*
* @return EOK on success
* ENOENT if the token is empty
* EACCESS if the token is not a password token
*/
errno_t sss_authtok_get_ccfile(struct sss_auth_token *tok,
const char **ccfile, size_t *len);
/**
* @brief Set a cc file name into a an auth token, replacing any previous data
*
* @param tok A pointer to a sss_auth_token structure to change, also
* used as a memory context to allocate the internal data.
* @param ccfile A null terminated string
* @param len The length of the string
*
* @return EOK on success
* ENOMEM on error
*/
errno_t sss_authtok_set_ccfile(struct sss_auth_token *tok,
const char *ccfile, size_t len);
/**
* @brief Resets an auth token to the empty status
*
* @param tok A pointer to a sss_auth_token structure to reset
*
* NOTE: This function uses safezero() on the payload if the type
* is SSS_AUTHTOK_TYPE_PASSWORD
*/
void sss_authtok_set_empty(struct sss_auth_token *tok);
/**
* @brief Set an auth token by type, replacing any previous data
*
* @param tok A pointer to a sss_auth_token structure to change, also
* used as a memory context to allocate the internal data.
* @param type A valid authtok type
* @param data A data pointer
* @param len The length of the data
*
* @return EOK on success
* ENOMEM or EINVAL on error
*/
errno_t sss_authtok_set(struct sss_auth_token *tok,
enum sss_authtok_type type,
const uint8_t *data, size_t len);
/**
* @brief Copy an auth token from source to destination
*
* @param src The source auth token
* @param dst The destination auth token, also used as a memory context
* to allocate dst internal data.
*
* @return EOK on success
* ENOMEM on error
*/
errno_t sss_authtok_copy(struct sss_auth_token *src,
struct sss_auth_token *dst);
/**
* @brief Uses safezero to wipe the password from memory if the
* authtoken contains a password, otherwise does nothing.
*
* @param tok A pointer to a sss_auth_token structure to change
*
* NOTE: This function should only be used in destructors or similar
* functions where freing the actual string is unsafe and where it can
* be guaranteed that the auth token will not be used anymore.
* Use sss_authtok_set_empty() in normal circumstances.
*/
void sss_authtok_wipe_password(struct sss_auth_token *tok);
/**
* @brief Create new empty struct sss_auth_token.
*
* @param mem_ctx A memory context use to allocate the internal data
* @return A pointer to new empty struct sss_auth_token
* NULL in case of failure
*
* NOTE: This function is the only way, how to create new empty
* struct sss_auth_token.
*/
struct sss_auth_token *sss_authtok_new(TALLOC_CTX *mem_ctx);
/**
* @brief Set authtoken with 2FA data
*
* @param tok A pointer to a sss_auth_token structure to change, also
* used as a memory context to allocate the internal data.
* @param[in] fa1 First authentication factor, null terminated
* @param[in] fa1_len Length of the first authentication factor, if 0
* strlen() will be called internally
* @param[in] fa2 Second authentication factor, null terminated
* @param[in] fa2_len Length of the second authentication factor, if 0
* strlen() will be called internally
*
* @return EOK on success
* ENOMEM if memory allocation failed
* EINVAL if input data is not consistent
*/
errno_t sss_authtok_set_2fa(struct sss_auth_token *tok,
const char *fa1, size_t fa1_len,
const char *fa2, size_t fa2_len);
/**
* @brief Get 2FA factors from authtoken
*
* @param tok A pointer to a sss_auth_token structure to change, also
* used as a memory context to allocate the internal data.
* @param[out] fa1 A pointer to a const char *, that will point to a
* null terminated string holding the first
* authentication factor, may not be modified or freed
* @param[out] fa1_len Length of the first authentication factor
* @param[out] fa2 A pointer to a const char *, that will point to a
* null terminated string holding the second
* authentication factor, may not be modified or freed
* @param[out] fa2_len Length of the second authentication factor
*
* @return EOK on success
* ENOMEM if memory allocation failed
* EINVAL if input data is not consistent
* ENOENT if the token is empty
* EACCESS if the token is not a 2FA token
*/
errno_t sss_authtok_get_2fa(struct sss_auth_token *tok,
const char **fa1, size_t *fa1_len,
const char **fa2, size_t *fa2_len);
/**
* @brief Set a Smart Card pin into a an auth token, replacing any previous data
*
* @param tok A pointer to a sss_auth_token structure to change, also
* used as a memory context to allocate the internal data.
* @param pin A string
* @param len The length of the string or, if 0 is passed,
* then strlen(password) will be used internally.
*
* @return EOK on success
* ENOMEM on error
*/
errno_t sss_authtok_set_sc_pin(struct sss_auth_token *tok, const char *pin,
size_t len);
/**
* @brief Returns a Smart Card pin as const string if the auth token is of
* type SSS_AUTHTOK_TYPE_SC_PIN, otherwise it returns an error
*
* @param tok A pointer to an sss_auth_token
* @param pin A pointer to a const char *, that will point to a null
* terminated string
* @param len The length of the pin string
*
* @return EOK on success
* ENOENT if the token is empty
* EACCESS if the token is not a Smart Card pin token
*/
errno_t sss_authtok_get_sc_pin(struct sss_auth_token *tok, const char **pin,
size_t *len);
/**
* @brief Sets an auth token to type SSS_AUTHTOK_TYPE_SC_KEYPAD, replacing any
* previous data
*
* @param tok A pointer to a sss_auth_token structure to change, also
* used as a memory context to allocate the internal data.
*/
void sss_authtok_set_sc_keypad(struct sss_auth_token *tok);
#endif /* __AUTHTOK_H__ */
|
