source: libabac/abac.h @ 7764378

abac0-leak
Last change on this file since 7764378 was 7764378, checked in by Mei <mei@…>, 6 years ago

1) tweak according valgrind's leak report

  • Property mode set to 100644
File size: 11.5 KB
Line 
1#ifndef __ABAC_H__
2#define __ABAC_H__
3
4#include <time.h>  // for struct tm
5#include <stdio.h> // for FILE
6
7typedef struct _abac_context_t abac_context_t;
8typedef struct _abac_credential_t abac_credential_t;
9typedef struct _abac_id_cert_t abac_id_cert_t;
10typedef struct _abac_role_t abac_role_t;
11
12typedef struct _abac_id_t abac_id_t;
13typedef struct _abac_attribute_t abac_attribute_t;
14
15typedef struct _abac_list_t ABAC_LIST_T;
16
17#ifndef __ABAC_CHUNK_T__
18#define __ABAC_CHUNK_T__
19typedef struct _abac_chunk_t {
20    unsigned char *ptr;
21    int len;
22} abac_chunk_t;
23void abac_chunk_free(abac_chunk_t);
24
25#endif /* __ABAC_CHUNK_T__ */
26
27typedef struct abac_keyid_mapping_t abac_keyid_mapping_t;
28typedef struct abac_keyid_map_t abac_keyid_map_t;
29
30/*
31 * ABAC functions, operating on an ABAC context.
32 */
33abac_context_t *abac_context_new(void);
34abac_context_t *abac_context_dup(abac_context_t *ctx);
35void abac_context_free(abac_context_t *ctx);
36
37/* see the bottom of the file for possible return codes */
38int abac_context_load_id_file(abac_context_t *ctx, char *filename);
39int abac_context_load_id_chunk(abac_context_t *ctx, abac_chunk_t cert);
40int abac_context_load_id_id(abac_context_t *ctx, abac_id_t *cert);
41int abac_context_load_attribute_file(abac_context_t *ctx, char *filename);
42int abac_context_load_attribute_chunk(abac_context_t *ctx, abac_chunk_t cert);
43
44/* load an entire directory full of certs */
45void abac_context_load_directory(abac_context_t *ctx, char *path);
46
47/* abac query, returns a NULL-terminated array of credentials on success, NULL on fail */
48abac_credential_t **abac_context_query(abac_context_t *ctx, char *role, char *principal, int *success);
49
50/* get all the credentials from the context, returns a NULL-terminated array of credentials */
51abac_credential_t **abac_context_credentials(abac_context_t *ctx);
52
53/* get all the principals from the context, returns a NULL-terminated array of credentials */
54abac_id_cert_t **abac_context_principals(abac_context_t *ctx);
55
56/* use this to free the results of either of the previous two functions */
57void abac_context_credentials_free(abac_credential_t **credentials);
58/* Used to pretty print */
59int abac_context_set_nickname(abac_context_t *ctxt, char *key, char*nick);
60char *abac_context_expand_key(abac_context_t *ctxt, char *s );
61char *abac_context_expand_nickname(abac_context_t *ctxt, char *s );
62abac_keyid_map_t *abac_context_get_keyid_map(abac_context_t *ctxt);
63
64/*
65 * Operations on credentials
66 */
67abac_role_t *abac_credential_head(abac_credential_t *cred);
68abac_role_t *abac_credential_tail(abac_credential_t *cred);
69abac_chunk_t abac_credential_attribute_cert(abac_credential_t *cred);
70abac_chunk_t abac_credential_issuer_cert(abac_credential_t *cred);
71
72abac_credential_t *abac_credential_dup(abac_credential_t *cred);
73void abac_credential_free(abac_credential_t *cred);
74char *abac_id_cert_keyid(abac_id_cert_t *);
75
76/*
77 * Operations on roles.
78 */
79abac_role_t *abac_role_principal_new(char *principal);
80abac_role_t *abac_role_role_new(char *principal, char *abac_role_name);
81abac_role_t *abac_role_linking_new(char *principal, char *linked_role, char *abac_role_name);
82
83void abac_role_free(abac_role_t *role);
84
85abac_role_t *abac_role_from_string(char *string);
86abac_role_t *abac_role_dup(abac_role_t *role);
87
88int abac_role_is_principal(abac_role_t *role);
89int abac_role_is_role(abac_role_t *role);
90int abac_role_is_linking(abac_role_t *role);
91int abac_role_is_intersection(abac_role_t *role);
92
93char *abac_role_string(abac_role_t *role);
94char *abac_role_short_string(abac_role_t *role, abac_context_t *ctxt);
95char *abac_role_linked_role(abac_role_t *role);
96char *abac_role_linking_role(abac_role_t *role);
97char *abac_role_role_name(abac_role_t *role);
98char *abac_role_principal(abac_role_t *role);
99
100char *abac_role_attr_key(abac_role_t *head_role, abac_role_t *tail_role);
101
102/*
103 * Operations on ID
104 */
105// create an ID from an X.509 certificate
106abac_id_t *abac_id_from_file(char *);
107
108// create an ID from a X.509 certificate PEM chunk
109abac_id_t *abac_id_from_chunk(abac_chunk_t chunk);
110
111// load an X.509 private key from a file
112int abac_id_privkey_from_file(abac_id_t *id, char *filename);
113
114// load an X.509 private key from a chunk
115int abac_id_privkey_from_chunk(abac_id_t *id, abac_chunk_t chunk);
116
117// generate an ID
118// returns one of ABAC_SUCCESS or ABAC_GENERATE_* (see top)
119int abac_id_generate(abac_id_t **ret, char *cn, long validity);
120
121// generate an ID using supplied private key
122// returns one of ABAC_SUCCESS or ABAC_GENERATE_* (see top)
123int abac_id_generate_with_key(abac_id_t **ret, char *cn, long validity, char *keyfile);
124
125// get the SHA1 keyid, pointer is valid for the lifetime of the object
126char *abac_id_keyid(abac_id_t *id);
127
128// get the CN of keyid, pointer is valid for the lifetime of the object
129char *abac_id_cn(abac_id_t *id);
130
131// get the name of the issuer
132// caller must free the returned string
133char *abac_id_issuer(abac_id_t *id);
134
135// get the DN of the subject
136// caller must free the returned string
137char *abac_id_subject(abac_id_t *id);
138
139// check if the cert is still valid
140int abac_id_still_valid(abac_id_t *id);
141
142// check if the principal cert's keyid is specified
143int abac_id_has_keyid(abac_id_t *id, char *);
144
145// check if the cert is has a private key
146int abac_id_has_privkey(abac_id_t *id);
147
148// get the validity period of the cert
149int abac_id_validity(abac_id_t *id, struct tm *not_before, struct tm *not_after);
150
151// default filename for the cert: ${CN}_ID.pem
152// caller must free the returned string
153char *abac_id_cert_filename(abac_id_t *id);
154
155// write the cert fo an open file pointer
156int abac_id_write_cert(abac_id_t *id, FILE *out);
157
158// default filename for the private key: ${CN}_key.pem
159// caller must free the return value
160char *abac_id_privkey_filename(abac_id_t *id);
161
162// write the private key to a file
163// it is recommended that you open this file mode 0600
164// returns false if there's no private key loaded
165int abac_id_write_privkey(abac_id_t *id, FILE *out);
166
167// get a chunk representing the cert
168// you must free the ptr of the chunk when done
169abac_chunk_t abac_id_cert_chunk(abac_id_t *id);
170
171// get a chunk representing the private key of the id
172abac_chunk_t abac_id_privkey_chunk(abac_id_t *id);
173
174// dup an ID (increases its refcount)
175abac_id_t *abac_id_dup(abac_id_t *id);
176
177// destroy the id
178// decreases refcount and destroys when it hits 0
179void abac_id_free(abac_id_t *id);
180
181/*
182 * Operations on Attribute
183 */
184//
185// Here's the skinny:
186//  Attribute cert objects don't contain an actual cert until they're baked.
187//  First you construct the object using abac_attribute_create, then you add
188//  subjects to it using abac_attribute_{principal,role,linking_role}.
189//  Finally you bake it. Once you've done that, you can keep it as XML chunk
190//  or write it to a file.
191//
192
193// create an attribute cert
194// validity is in days
195// returns one of CREDDY_SUCCESS or CREDDY_ATTRIBUTE_* (see top)
196int abac_attribute_create(abac_attribute_t **attr, abac_id_t *issuer, char *role, long validity);
197
198// add a head string to the cert
199void abac_attribute_set_head(abac_attribute_t *attr, char *string);
200
201// return the head string of the attribute
202char *abac_attribute_get_head(abac_attribute_t *);
203
204// add a principal subject to the cert
205int abac_attribute_principal(abac_attribute_t *attr, char *keyid);
206
207// add a role subject
208int abac_attribute_role(abac_attribute_t *attr, char *keyid, char *role);
209
210// add a linking role subject
211int abac_attribute_linking_role(abac_attribute_t *attr, char *keyid, char *role, char *linked);
212
213// create the attribute cert once all the subjects have been added
214// can return 0 if there are no subjects or there's a problem building the cert
215int abac_attribute_bake(abac_attribute_t *attr);
216int abac_attribute_bake_context(abac_attribute_t *attr, abac_context_t *ctxt);
217
218// returns true iff the cert's been baked
219int abac_attribute_baked(abac_attribute_t *attr);
220
221// write the cert to a file. returns 0 if the cert hasn't been baked
222int abac_attribute_write(abac_attribute_t *attr, FILE *out);
223int abac_attribute_write_file(abac_attribute_t *attr, const char *fname);
224
225/*
226 * Return the number of tail strings
227 */
228int abac_attribute_get_ntails(abac_attribute_t *a);
229
230/*
231 * Return the nth tail string or NULL if it is undefined
232 */
233char *abac_attribute_get_tail_n(abac_attribute_t *a, int n);
234
235// get chunked cert
236// returns 0 if the cert isn't baked
237abac_chunk_t abac_attribute_cert_chunk(abac_attribute_t *);
238
239// destroy the cert
240void abac_attribute_free(abac_attribute_t *);
241
242// load a list of attr cert from file (aborts on fail)
243ABAC_LIST_T *abac_attribute_certs_from_file(ABAC_LIST_T *,char *);
244
245// load a list of attr cert from chunk (aborts on fail)
246ABAC_LIST_T *abac_attribute_certs_from_chunk(ABAC_LIST_T *,abac_chunk_t);
247
248        // get the attribute role string
249char *abac_attribute_role_string(abac_attribute_t *attr);
250
251// get the issuer id of an attribute
252abac_id_t *abac_attribute_issuer_id(abac_attribute_t *ptr);
253
254// get the attribute output format
255char *abac_attribute_get_output_format(abac_attribute_t *);
256
257// set the attribute output format
258// Valid formats GENIv1.0, GENIv1.1
259void abac_attribute_set_output_format(abac_attribute_t *, char *);
260
261// get the validity period of the attribute cert
262int abac_attribute_validity(abac_attribute_t *attr, struct tm *not_before, struct tm *not_after);
263abac_keyid_map_t *abac_attribute_get_keyid_map(abac_attribute_t *);
264
265// return the principal from an attribute's role string
266// callee must free the space
267char *abac_attribute_get_principal(abac_attribute_t *attr);
268
269// check if the attribute cert is still valid
270int abac_attribute_still_valid(abac_attribute_t *attr);
271
272/* abac name mappings.  These are used internally, mostly */
273abac_keyid_mapping_t *abac_keyid_mapping_new(char *k, char *v);
274void abac_keyid_mapping_free(abac_keyid_mapping_t *m);
275abac_keyid_map_t *abac_keyid_map_new();
276abac_keyid_map_t *abac_keyid_map_dup(abac_keyid_map_t *);
277abac_keyid_map_t *abac_keyid_map_clone(abac_keyid_map_t *);
278void abac_keyid_map_free(abac_keyid_map_t *m); 
279char *abac_keyid_map_key_to_nickname(abac_keyid_map_t *m, char *key);
280char *abac_keyid_map_nickname_to_key(abac_keyid_map_t *m, char *nick); 
281int abac_keyid_map_remove_keyid(abac_keyid_map_t *m, char *key); 
282int abac_keyid_map_add_nickname(abac_keyid_map_t *m, char *key, char *nick);
283void abac_keyid_map_merge(abac_keyid_map_t *d, abac_keyid_map_t *s, 
284        int overwrite);
285char *abac_keyid_map_expand_key(abac_keyid_map_t *m, char *s); 
286char *abac_keyid_map_expand_nickname(abac_keyid_map_t *m, char *s);
287/*
288 * Return code for libabac
289 */
290#define ABAC_RC_SUCCESS                0
291#define ABAC_RC_FAILURE                1
292
293/*
294 * Error codes for loading certificates.
295 */
296#define ABAC_CERT_SUCCESS           0   // certificate loaded, all is well
297#define ABAC_CERT_INVALID           -1  // invalid format; also file not found
298#define ABAC_CERT_BAD_SIG           -2  // invalid signature
299#define ABAC_CERT_MISSING_ISSUER    -3  // missing ID cert that issued the attribute cert
300#define ABAC_CERT_BAD_PRINCIPAL     -4  // Principal of attribute cert issuer has mismatch keyid
301#define ABAC_CERT_INVALID_ISSUER    -5  // Issuer of attribute cert is invalid
302#define ABAC_CERT_SIGNER_NOKEY      -6  // Signer of attribute cert is missing private key
303
304/*
305 * Error codes for IDs and Attributes
306 */
307#define ABAC_SUCCESS                          0
308#define ABAC_FAILURE                          1 /* catch all */
309#define ABAC_GENERATE_INVALID_CN             -1
310#define ABAC_GENERATE_INVALID_VALIDITY       -2
311#define ABAC_ATTRIBUTE_ISSUER_NOKEY          -3
312#define ABAC_ATTRIBUTE_INVALID_ROLE          -4
313#define ABAC_ATTRIBUTE_INVALID_VALIDITY      -5
314#define ABAC_ATTRIBUTE_INVALID_ISSUER        -6
315
316
317
318#endif /* __ABAC_H__ */
Note: See TracBrowser for help on using the repository browser.