source: libabac/abac_pl.h @ 9806e76

#ifndef __ABAC_H__
#define __ABAC_H__

#include <abac_common.h>
#include <abac_list.h>
#include <abac_stack.h>

typedef struct _abac_context_t abac_context_t;
typedef struct _abac_credential_t abac_credential_t;
typedef struct _abac_role_t abac_role_t;
typedef struct _abac_oset_t abac_oset_t;
typedef struct _abac_id_cert_t abac_id_cert_t;

typedef struct _abac_condition_t abac_condition_t;
typedef struct _abac_term_t abac_term_t;
typedef struct _abac_param_list_t abac_param_list_t;

/*
 * ABAC functions, operating on an ABAC context.
 */
abac_context_t *abac_context_new(void);
abac_context_t *abac_context_dup(abac_context_t *ctx);
void abac_context_free(abac_context_t *ctx);

/* see the bottom of the file for possible return codes */
int abac_context_load_id_file(abac_context_t *ctx, char *filename);
int abac_context_load_id_chunk(abac_context_t *ctx, abac_chunk_t cert);
int abac_context_load_attribute_file(abac_context_t *ctx, char *filename);
int abac_context_load_attribute_chunk(abac_context_t *ctx, abac_chunk_t cert);

/* load an entire directory full of certs */
void abac_context_load_directory(abac_context_t *ctx, char *path);

/* abac query, returns a NULL-terminated array of credentials on success, NULL on fail */
abac_credential_t **abac_context_query(abac_context_t *ctx, char *role, char *principal, int *success);

/* get all the credentials from the context, returns a NULL-terminated array of credentials */
abac_credential_t **abac_context_credentials(abac_context_t *ctx);

/* use this to free the results of either of the previous two functions */
void abac_context_credentials_free(abac_credential_t **credentials);

/*
 * Operations on credentials
 */
abac_role_t *abac_credential_head(abac_credential_t *cred);
abac_role_t *abac_credential_tail(abac_credential_t *cred);
abac_chunk_t abac_credential_attribute_cert(abac_credential_t *cred);
abac_chunk_t abac_credential_issuer_cert(abac_credential_t *cred);
abac_credential_t *abac_credential_lookup(char *cred_string);
char* abac_credential_clause(abac_credential_t *cred);

abac_credential_t *abac_credential_dup(abac_credential_t *cred);
void abac_credential_free(abac_credential_t *cred);

/*
 * Operations on roles.
 */
abac_role_t *abac_role_principal_new(char *principal);
abac_role_t *abac_role_role_new(char *principal, char *abac_role_name);
abac_role_t *abac_role_linking_new(char *principal, char *linked_role, char *abac_role_name);
abac_role_t *abac_role_intersection_new(char *name, abac_list_t *prereqs);

int abac_verify_roletype(char *type);
void abac_role_free(abac_role_t *role);

abac_role_t *abac_role_from_string(char *string);
abac_role_t *abac_role_dup(abac_role_t *role);

int abac_role_is_principal(abac_role_t *role);
int abac_role_is_role(abac_role_t *role);
int abac_role_is_linking(abac_role_t *role);
int abac_role_is_intersection(abac_role_t *role);

char *abac_role_string(abac_role_t *role);
char *abac_role_linked_role(abac_role_t *role);
char *abac_role_role_name(abac_role_t *role);
char *abac_role_role_param_string(abac_role_t *role);
char *abac_role_principal(abac_role_t *role);
abac_list_t *abac_role_prereqs(abac_role_t *role);

abac_param_list_t *abac_role_linked_role_params(abac_role_t *role);
abac_param_list_t *abac_role_role_params(abac_role_t *role);

char *abac_role_attr_key(abac_role_t *head_role, abac_role_t *tail_role);
char *abac_role_principal_cn(abac_role_t *role);
char *abac_role_string_with_condition(abac_role_t *);

/*
 * Operations on oset
 */
char *abac_oset_principal_cn(abac_oset_t *oset);
char *abac_oset_oset_name(abac_oset_t *oset);
abac_param_list_t *abac_oset_oset_params(abac_oset_t *);
int abac_oset_is_object(abac_oset_t *);
char *abac_oset_object_cn(abac_oset_t *);
char *abac_oset_linked_role(abac_oset_t *);
abac_param_list_t *abac_oset_linked_role_params(abac_oset_t *);
abac_list_t *abac_oset_prereqs(abac_oset_t *);
int abac_oset_is_intersection(abac_oset_t *);
abac_oset_t *abac_oset_principal_new(char *);
abac_oset_t *abac_oset_intersection_new(char *, abac_list_t *);
abac_oset_t *abac_oset_oset_new(char *, char *);
abac_oset_t *abac_oset_object_new(abac_term_t *);
char *abac_oset_principal(abac_oset_t *);
abac_oset_t *abac_oset_linking_new(char *, char *, char *);
char *abac_oset_string_with_condition(abac_oset_t *);
char *abac_oset_oset_param_string(abac_oset_t *);

/*
 * Operations on term/params.
 */
char *abac_term_to_time(char *string);
char *abac_term_type(int);
abac_term_t *abac_term_new(int, char *, char *, void *);
void abac_term_free(abac_term_t *);
int abac_term_is_time_type(int);
char *abac_term_name(abac_term_t *);
abac_condition_t *abac_term_constraint(abac_term_t *term);
abac_param_list_t *abac_param_list_new(abac_term_t *term);
abac_param_list_t *abac_param_list_free(abac_param_list_t *ptr);
abac_param_list_t *abac_param_list_add_term(abac_param_list_t *, abac_term_t *term);
char* abac_param_list_string(abac_param_list_t *ptr);
char* abac_param_list_string_with_condition(abac_param_list_t *ptr);

/* from abac_verifier */
char *abac_cn_with_sha(char*);
char *abac_keyid_type(int);

/*
 * Error codes for loading certificates.
 */
#define ABAC_CERT_SUCCESS           0   // certificate loaded, all is well
#define ABAC_CERT_INVALID           -1  // invalid format; also file not found
#define ABAC_CERT_BAD_SIG           -2  // invalid signature
#define ABAC_CERT_MISSING_ISSUER    -3  // missing ID cert that issued the attribute cert
#define ABAC_CERT_BAD_CN            -4  // ID cert is not matching CN=principal format
#define ABAC_CERT_BAD_YAP           -5  // failed to insert into prolog engine

#endif /* __ABAC_H__ */