source: libabac/abac.h @ adc0815

Revision adc0815, 11.2 KB checked in by Mei <mei@…>, 12 months ago (diff)

1) wrap up abac.hh doc first round
  • Property mode set to 100644
Line 
1#ifndef __ABAC_H__
2#define __ABAC_H__
3
4#include <stdlib.h>
5#include <abac_list.h>
6#include <abac_stack.h>
7#include <abac_common.h>
8
9extern int ABAC_IN_QUERY;
10
11typedef struct _abac_context_t abac_context_t;
12typedef struct _abac_credential_t abac_credential_t;
13typedef struct _abac_aspect_t abac_aspect_t;
14typedef struct _abac_attribute_t abac_attribute_t;
15typedef struct _abac_id_t abac_id_t;
16typedef struct _abac_id_credential_t abac_id_credential_t;
17
18typedef struct _abac_condition_t abac_condition_t;
19typedef struct _abac_term_t abac_term_t;
20typedef struct _abac_item_t abac_item_t;
21typedef struct _abac_param_list_t abac_param_list_t;
22
23/*
24 * ABAC functions, operating on an ABAC context.
25 */
26abac_context_t *abac_context_new(void);
27abac_context_t *abac_context_dup(abac_context_t *ctx);
28abac_context_t *abac_context_dup(abac_context_t *ctx);
29void abac_context_free(abac_context_t *ctx);
30
31/* see the bottom of the file for possible return codes */
32int abac_context_load_id_id(abac_context_t *ctx, abac_id_t *);
33int abac_context_load_id_id_file_key_file(abac_context_t *ctx, char *filename, char* keyfielname);
34int abac_context_load_id_idkey_file(abac_context_t *ctx, char *filename);
35int abac_context_load_id_chunk(abac_context_t *ctx, abac_chunk_t cert);
36int abac_context_load_attribute_attribute(abac_context_t *ctx, abac_attribute_t *);
37int abac_context_load_attribute_file(abac_context_t *ctx, char *filename);
38int abac_context_load_attribute_chunk(abac_context_t *ctx, abac_chunk_t cert);
39
40/* load an entire directory full of certs */
41void abac_context_load_directory(abac_context_t *ctx, char *path);
42
43/* abac query, returns a NULL-terminated array of credentials on success, NULL on fail */
44abac_credential_t **abac_context_query(abac_context_t *ctx, char *role, char *principal, int *success);
45abac_credential_t **abac_context_query_with_structure(abac_context_t *, abac_aspect_t*, abac_aspect_t*, int*);
46
47/* get all the credentials from the context, returns a NULL-terminated array of credentials */
48abac_credential_t **abac_context_credentials(abac_context_t *);
49abac_id_credential_t **abac_context_principals(abac_context_t *);
50
51/* use this to free the results of either of the previous two functions */
52void abac_context_credentials_free(abac_credential_t **);
53void abac_context_principals_free(abac_id_credential_t **);
54/*
55 * Operations on credentials
56 */
57abac_aspect_t *abac_credential_head(abac_credential_t *cred);
58abac_aspect_t *abac_credential_tail(abac_credential_t *cred);
59abac_chunk_t abac_credential_attribute_cert(abac_credential_t *cred);
60abac_chunk_t abac_credential_issuer_cert(abac_credential_t *cred);
61abac_credential_t *abac_credential_lookup(char *cred_string);
62abac_id_credential_t *abac_id_credential_lookup(char*);
63abac_id_t *abac_id_credential_id(abac_id_credential_t *ptr);
64
65abac_credential_t *abac_credential_dup(abac_credential_t *cred);
66abac_attribute_t *abac_credential_attribute(abac_credential_t *cred);
67void abac_credential_free(abac_credential_t *cred);
68
69/*
70 * Operations on aspect.
71 */
72abac_aspect_t *abac_aspect_role_principal_create(char *principal_name);
73abac_aspect_t *abac_aspect_oset_principal_create(char *principal_name);
74abac_aspect_t *abac_aspect_oset_object_create(abac_term_t *object);
75abac_aspect_t *abac_aspect_role_create(char *principal_name, char *role_name);
76abac_aspect_t *abac_aspect_oset_create(char *principal_name, char *oset_name);
77
78bool abac_aspect_is_principal(abac_aspect_t *ptr);
79abac_aspect_t *abac_aspect_dup(abac_aspect_t *ptr);
80char *abac_aspect_string(abac_aspect_t *ptr);
81bool abac_aspect_is_linking(abac_aspect_t *ptr);
82char *abac_aspect_typed_string(abac_aspect_t *ptr);
83abac_aspect_t *abac_aspect_add_param(abac_aspect_t *ptr, abac_term_t *param);
84abac_aspect_t *abac_aspect_add_linked_param(abac_aspect_t *ptr, abac_term_t *param);
85bool abac_aspect_is_object(abac_aspect_t *ptr);
86char *abac_aspect_principal_name(abac_aspect_t *ptr);
87char* abac_aspect_type_string(abac_aspect_t *ptr);
88char *abac_aspect_aspect_name(abac_aspect_t *ptr);
89int abac_aspect_aspect_type(abac_aspect_t *ptr);
90abac_param_list_t *abac_aspect_aspect_params(abac_aspect_t *ptr);
91abac_param_list_t *abac_aspect_linked_role_params(abac_aspect_t *ptr);
92abac_aspect_t *abac_aspect_oset_linking_new(char *principal_name, 
93                              char *linked_role_name, char *oset_name);
94abac_aspect_t *abac_aspect_role_linking_new(char *principal_name,
95                              char *linked_role_name, char *role_name);
96abac_aspect_t *abac_aspect_role_new(char *principal_name, char *role_name);
97abac_aspect_t *abac_aspect_oset_new(char *principal_name, char *oset_name);
98abac_aspect_t *abac_aspect_oset_principal_new(char *principal_name);
99abac_aspect_t *abac_aspect_role_principal_new(char *principal_name);
100abac_aspect_t *abac_aspect_oset_object_new(abac_term_t *object);
101char *abac_aspect_linked_role_name(abac_aspect_t *ptr);
102char *abac_aspect_object_name(abac_aspect_t *ptr);
103char *abac_aspect_object_type(abac_aspect_t *ptr);
104abac_list_t *abac_aspect_prereqs(abac_aspect_t *ptr);
105char *abac_aspect_string_with_condition(abac_aspect_t *);
106char *abac_aspect_typed_string_with_condition(abac_aspect_t *);
107char *abac_aspect_principal_principalname(abac_aspect_t *ptr);
108void abac_print_aspect_string_with_condition(abac_aspect_t *ptr,FILE *fp);
109char *abac_aspect_aspect_param_string(abac_aspect_t *ptr);
110abac_aspect_t *abac_aspect_intersection_new(abac_aspect_t *);
111abac_aspect_t *abac_aspect_add_intersecting_aspect(abac_aspect_t *ptr, abac_aspect_t *aspect);
112abac_id_t *abac_aspect_get_issuer_id(abac_aspect_t *ptr);
113int abac_aspect_intersecting_aspect_type(abac_aspect_t *ptr);
114
115/* abac_attribute */
116bool abac_attribute_is_role(abac_attribute_t *ptr);
117abac_chunk_t abac_attribute_cert_chunk(abac_attribute_t *ptr);
118int abac_attribute_write(abac_attribute_t *ptr, FILE *out);
119int abac_attribute_bake(abac_attribute_t *ptr);
120int abac_attribute_baked(abac_attribute_t *ptr);
121abac_aspect_t *abac_attribute_head(abac_attribute_t *ptr);
122abac_aspect_t *abac_attribute_tail(abac_attribute_t *ptr);
123int abac_attribute_lastone(abac_attribute_t *ptr);
124int abac_attribute_create(abac_attribute_t **ret,abac_aspect_t *head, abac_aspect_t *tail,int validity);
125abac_attribute_t *abac_attribute_set_head(abac_attribute_t *ptr, abac_aspect_t *);
126abac_attribute_t *abac_attribute_add_tail(abac_attribute_t *ptr, abac_aspect_t *);
127abac_attribute_t *abac_attribute_dup(abac_attribute_t *ptr);
128abac_aspect_t **abac_attribute_tail_vectorized(abac_attribute_t *ptr);
129void abac_attribute_free(abac_attribute_t *ptr);
130void abac_aspects_free(abac_aspect_t **aspects);
131
132/*
133 * Operations on term/params.
134 */
135int abac_max_item_type();
136int abac_min_item_type();
137int abac_target_item_type();
138
139void abac_condition_add_range_integer_item(abac_condition_t *ptr, int itype, int val);
140void abac_condition_add_range_float_item(abac_condition_t *ptr, int itype, float val);
141void abac_condition_add_range_time_item(abac_condition_t *ptr, int itype, char* val);
142void abac_condition_add_range_urn_item(abac_condition_t *ptr, char *val);
143void abac_condition_add_range_string_item(abac_condition_t *ptr, char *val);
144void abac_condition_add_range_boolean_item(abac_condition_t *ptr, char* val);
145
146abac_condition_t *abac_condition_create(char *vtype);
147abac_condition_t *abac_condition_create_from_aspect(abac_aspect_t *ptr);
148abac_condition_t *abac_condition_dup(abac_condition_t *ptr);
149void abac_condition_free(abac_condition_t *ptr);
150char *abac_condition_typed_string(abac_condition_t *ptr);
151char *abac_condition_string(abac_condition_t *ptr);
152char *abac_term_to_time(char *string);
153int abac_term_isvar(abac_term_t *term);
154char *abac_term_typed_string(abac_term_t *ptr);
155char *abac_term_string(abac_term_t *ptr);
156char *abac_term_type_name(abac_term_t *term);
157abac_term_t *abac_term_dup(abac_term_t *ptr);
158abac_term_t *abac_term_create(int, char*, abac_condition_t*);
159abac_term_t *abac_term_named_create(int, char*);
160bool abac_term_is_numeric(abac_term_t *);
161bool abac_term_is_alpha(abac_term_t *);
162bool abac_term_is_time(abac_term_t *);
163bool abac_term_is_integer_type(abac_term_t *term);
164bool abac_term_is_urn_type(abac_term_t *term);
165bool abac_term_is_string_type(abac_term_t *term);
166bool abac_term_is_time_type(abac_term_t *term);
167int abac_term_type(abac_term_t *term);
168abac_term_t *abac_term_add_constraint(abac_term_t *ptr, abac_condition_t *cond);
169abac_term_t *abac_term_new(int, char *, int, char *, void *);
170abac_term_t *abac_term_named_new(int, char *);
171void abac_term_free(abac_term_t *);
172bool abac_term_is_time_type(abac_term_t *);
173bool abac_term_is_string_type(abac_term_t *);
174char *abac_term_name(abac_term_t *);
175abac_condition_t *abac_term_constraint(abac_term_t *term);
176abac_param_list_t *abac_param_list_new(abac_term_t *term);
177abac_param_list_t *abac_param_list_free(abac_param_list_t *ptr);
178abac_param_list_t *abac_param_list_add_term(abac_param_list_t *, abac_term_t *term);
179char* abac_param_list_string(abac_param_list_t *ptr);
180char* abac_param_list_string_with_condition(abac_param_list_t *ptr);
181char* abac_param_list_typed_string_with_condition(abac_param_list_t *ptr);
182abac_term_t **abac_param_list_vectorize(abac_param_list_t *ptr);
183void abac_terms_free(abac_term_t **terms);
184int abac_verify_term_type(char *);
185
186/* from abac_verifier */
187char *abac_cn_with_sha(char*);
188char *abac_idtype_with_sha(char*);
189abac_stack_t *abac_verifier_dump_creds();
190abac_stack_t *abac_verifier_dump_principals();
191abac_id_credential_t *abac_verifier_add_id_credential(abac_id_t *a_id);
192
193/* from abac_id */
194char *abac_id_name(abac_id_t *ptr);
195char *abac_id_idtype_string(abac_id_t *ptr);
196int abac_id_lastone(abac_id_t *ptr);
197abac_id_t *abac_id_dup(abac_id_t *id);
198void abac_id_free(abac_id_t *id);
199char *abac_id_cn(abac_id_t *id);
200char *abac_id_keyid(abac_id_t *id);
201abac_id_t *abac_id_from_file(char *filename);
202int abac_id_load_privkey_file(abac_id_t *id, char *filename);
203int abac_id_write_privkey(abac_id_t *id, FILE *out);
204int abac_id_has_privkey(abac_id_t *id);
205void abac_id_write_cert(abac_id_t *id, FILE *out);
206int abac_id_generate(abac_id_t **ret, char *cn, int validity);
207abac_chunk_t abac_id_cert_chunk(abac_id_t *id);
208
209/* from abac_aspect */
210void abac_aspect_free(abac_aspect_t *);
211void abac_errx(int val, const char *string);
212
213/* from abac_pl_yap */
214void show_yap_db(const char *msg);
215
216/*
217 * Error codes for loading certificates.
218 */
219#define ABAC_CERT_SUCCESS           0   // certificate loaded, all is well
220#define ABAC_CERT_INVALID           -1  // invalid format; also file not found
221#define ABAC_CERT_BAD_SIG           -2  // invalid signature
222#define ABAC_CERT_MISSING_ISSUER    -3  // missing ID cert that issued the attribute cert
223#define ABAC_CERT_BAD_CN            -4  // ID cert is not matching CN=principal format
224#define ABAC_CERT_BAD_YAP           -5  // failed to insert into prolog engine
225#define ABAC_CERT_EXISTS            1   // ID already exists (does not default to a failure)
226
227#define ABAC_ID_SUCCESS                     0
228#define ABAC_ID_GENERATE_INVALID_CN        -1
229#define ABAC_ID_GENERATE_INVALID_VALIDITY  -2
230
231#define ABAC_ATTRIBUTE_SUCCESS              0
232#define ABAC_ATTRIBUTE_INVALID_ROLE        -1
233#define ABAC_ATTRIBUTE_INVALID_VALIDITY    -2
234#define ABAC_ATTRIBUTE_ISSUER_NOKEY        -3
235#define ABAC_ATTRIBUTE_FAIL                -4
236
237#define ABAC_TERM_SUCCESS                   0
238#define ABAC_TERM_FAIL                     -1
239
240
241#define USE(evalue) ((getenv(evalue)!=NULL)?1:0)
242
243#endif /* __ABAC_H__ */
Note: See TracBrowser for help on using the repository browser.