rules.h

 
/* SPDX-FileCopyrightText: Copyright 2021 Rick van Rein <rick@openfortress.nl>
 * SPDX-License-Identifier: BSD-2-Clause
 */
 
 
#ifndef ARPA2_RULES_H
#define ARPA2_RULES_H
 
 
#include <stdbool.h>
#include <stdint.h>
 
#include <arpa2/identity.h>
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef char *rules_domain;
 
 
typedef uint8_t rules_type [16];
 
 
typedef uint8_t *rules_typeref;
 
 
typedef char *rules_name;
 
 
typedef char const *rules_varray_ptr [26];
 
typedef unsigned rules_varray_len [26];
 
 
#define RULES_VARINDEX(c) (c - 'a')
 
 
typedef uint32_t rules_flags;
 
 
#define RULES_FLAG(c) ( 1 << (c - 'A') )
 
 
typedef char const *rules_trigger;
 
 
void rules_init (void);
 
 
void rules_fini (void);
 
 
/* Forward reference.  */
struct rules_request;
 
 
typedef bool (*rules_flags_upcall) (
                        struct rules_request *self);
 
 
typedef bool (*rules_trigger_upcall) (
                        struct rules_request *self,
                        rules_trigger trigger_name,
                        unsigned tigger_namelen);
 
 
typedef bool (*rules_selector_upcall) (
                        struct rules_request *self,
                        const a2sel_t *selector);
 
 
typedef bool (*rules_endrule_upcall) (
                        struct rules_request *self);
 
 
typedef bool (*rules_endruleset_upcall) (
                        struct rules_request *self);
 
 
struct rules_request {
        /* Override rules_process() for use in rules_dbiterate() */
        bool (*rules_process_override) (struct rules_request *req,
                        const char *ruleset, unsigned rulesetlen,
                        bool permit_selector);
        /* Context fields for the rules_process functions */
        rules_domain opt_domain;
        rules_typeref opt_type;
        rules_name opt_name;
        a2sel_quickiter opt_qiter;
        /* Callback functions, inasfar as supported by the Access Type */
        rules_flags_upcall      optcb_flags;
        rules_trigger_upcall    optcb_trigger;
        rules_selector_upcall   optcb_selector;
        rules_endrule_upcall    optcb_endrule;
        rules_endruleset_upcall optcb_endruleset;
        /* Output fields to upcalls (cleared at the end) */
        char const *flags_rawstr;
        rules_flags flags;
        rules_varray_ptr varray_str;
        rules_varray_len varray_strlen;
};
 
 
bool rules_process (struct rules_request *req,
                        const char *ruleset, unsigned rulesetlen,
                        bool permit_selector);
 
 
bool rules_dbiterate (struct rules_request *req,
                        const uint8_t *svckey, unsigned svckeylen,
                        const rules_name name,
                        const a2sel_t *iter0);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* ARPA2_RULES_H */