Checkpoint commit: refactoring the request code in TIDS for better reuse
[trust_router.git] / include / tr_config.h
1 /*
2  * Copyright (c) 2012, JANET(UK)
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * 3. Neither the name of JANET(UK) nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
31  * OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  */
34
35 #ifndef TR_CONFIG_H
36 #define TR_CONFIG_H
37
38 #include <stdio.h>
39 #include <dirent.h>
40 #include <jansson.h>
41 #include <syslog.h>
42 #include <sys/time.h>
43 #include <talloc.h>
44
45 #include <tr_comm.h>
46 #include <tr_rp.h>
47 #include <tr_idp.h>
48 #include <trp_ptable.h>
49 #include <trp_internal.h>
50
51 #define TR_DEFAULT_MAX_TREE_DEPTH 12
52 #define TR_DEFAULT_TRPS_PORT 12308
53 #define TR_DEFAULT_TIDS_PORT 12309
54 #define TR_DEFAULT_LOG_THRESHOLD LOG_INFO
55 #define TR_DEFAULT_CONSOLE_THRESHOLD LOG_NOTICE
56 #define TR_DEFAULT_APC_EXPIRATION_INTERVAL 43200
57 #define TR_DEFAULT_TRP_CONNECT_INTERVAL 10
58 #define TR_DEFAULT_TRP_UPDATE_INTERVAL 30
59 #define TR_DEFAULT_TRP_SWEEP_INTERVAL 30
60 #define TR_DEFAULT_TID_REQ_TIMEOUT 5
61 #define TR_DEFAULT_TID_RESP_NUMER 2
62 #define TR_DEFAULT_TID_RESP_DENOM 3
63
64 typedef enum tr_cfg_rc {
65   TR_CFG_SUCCESS = 0,   /* No error */
66   TR_CFG_ERROR,         /* General processing error */
67   TR_CFG_BAD_PARAMS,    /* Bad parameters passed to tr_config function */
68   TR_CFG_NOPARSE,       /* Parsing error */
69   TR_CFG_NOMEM,         /* Memory allocation error */
70 } TR_CFG_RC;
71
72 typedef struct tr_cfg_internal {
73   unsigned int max_tree_depth;
74   unsigned int tids_port;
75   unsigned int trps_port;
76   unsigned int monitoring_port;
77   const char *hostname;
78   int log_threshold;
79   int console_threshold;
80   unsigned int cfg_poll_interval;
81   unsigned int cfg_settling_time;
82   unsigned int trp_sweep_interval;
83   unsigned int trp_update_interval;
84   unsigned int trp_connect_interval;
85   unsigned int tid_req_timeout;
86   unsigned int tid_resp_numer; /* numerator of fraction of AAA servers to wait for in unshared mode */
87   unsigned int tid_resp_denom; /* denominator of fraction of AAA servers to wait for in unshared mode */
88 } TR_CFG_INTERNAL;
89
90 typedef struct tr_cfg {
91   TR_CFG_INTERNAL *internal;            /* internal trust router config */
92   TR_RP_CLIENT *rp_clients;             /* locally associated RP Clients */
93   TRP_PTABLE *peers; /* TRP peer table */
94   TR_COMM_TABLE *ctable; /* communities/realms */
95   TR_AAA_SERVER *default_servers;       /* default server list */
96   /* TBD -- Global Filters */
97 } TR_CFG;
98
99 typedef struct tr_cfg_mgr {
100   TR_CFG *active;
101   TR_CFG *new;
102 } TR_CFG_MGR;
103
104 int tr_find_config_files(const char *config_dir, struct dirent ***cfg_files);
105 void tr_free_config_file_list(int n, struct dirent ***cfg_files);
106 TR_CFG_RC tr_parse_config(TR_CFG_MGR *cfg_mgr, unsigned int n_files, char **files_with_paths);
107 TR_CFG_RC tr_apply_new_config (TR_CFG_MGR *cfg_mgr);
108 TR_CFG_RC tr_cfg_validate (TR_CFG *trc);
109 TR_CFG *tr_cfg_new(TALLOC_CTX *mem_ctx);
110 TR_CFG_MGR *tr_cfg_mgr_new(TALLOC_CTX *mem_ctx);
111 void tr_cfg_free(TR_CFG *cfg);
112 void tr_cfg_mgr_free(TR_CFG_MGR *cfg);
113
114 void tr_print_config(TR_CFG *cfg);
115 void tr_print_comms(TR_COMM_TABLE *ctab);
116 void tr_print_comm_idps(TR_COMM_TABLE *ctab, TR_COMM *comm);
117 void tr_print_comm_rps(TR_COMM_TABLE *ctab, TR_COMM *comm);
118
119 TR_IDP_REALM *tr_cfg_find_idp (TR_CFG *cfg, TR_NAME *idp_id, TR_CFG_RC *rc);
120 TR_RP_CLIENT *tr_cfg_find_rp (TR_CFG *cfg, TR_NAME *rp_gss, TR_CFG_RC *rc);
121
122 #endif