1 /*
2  * URI-based user authentication using the HTTP basic method.
3  *
4  * Copyright 2006-2011 Willy Tarreau <w@1wt.eu>
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version
9  * 2 of the License, or (at your option) any later version.
10  *
11  */
12 
13 #ifndef _COMMON_URI_AUTH_H
14 #define _COMMON_URI_AUTH_H
15 
16 #include <common/config.h>
17 
18 #include <types/auth.h>
19 
20 /* This is a list of proxies we are allowed to see. Later, it should go in the
21  * user list, but before this we need to support de/re-authentication.
22  */
23 struct stat_scope {
24 	struct stat_scope *next;	/* next entry, NULL if none */
25 	int px_len;			/* proxy name length */
26 	char *px_id;			/* proxy id */
27 };
28 
29 /* later we may link them to support multiple URI matching */
30 struct uri_auth {
31 	int uri_len;			/* the prefix length */
32 	char *uri_prefix;		/* the prefix we want to match */
33 	char *auth_realm;		/* the realm reported to the client */
34 	char *node, *desc;		/* node name & description reported in this stats */
35 	int refresh;			/* refresh interval for the browser (in seconds) */
36 	unsigned int flags;		/* STAT_* flags from stats.h and for applet.ctx.stats.flags */
37 	struct stat_scope *scope;	/* linked list of authorized proxies */
38 	struct userlist *userlist;	/* private userlist to emulate legacy "stats auth user:password" */
39 	struct list http_req_rules;	/* stats http-request rules : allow/deny/auth */
40 	struct list admin_rules;	/* 'stats admin' rules (chained) */
41 	struct uri_auth *next;		/* Used at deinit() to build a list of unique elements */
42 };
43 
44 /* This is the default statistics URI */
45 #ifdef CONFIG_STATS_DEFAULT_URI
46 #define STATS_DEFAULT_URI CONFIG_STATS_DEFAULT_URI
47 #else
48 #define STATS_DEFAULT_URI "/haproxy?stats"
49 #endif
50 
51 /* This is the default statistics realm */
52 #ifdef CONFIG_STATS_DEFAULT_REALM
53 #define STATS_DEFAULT_REALM CONFIG_STATS_DEFAULT_REALM
54 #else
55 #define STATS_DEFAULT_REALM "HAProxy Statistics"
56 #endif
57 
58 
59 struct stats_admin_rule {
60 	struct list list;	/* list linked to from the proxy */
61 	struct acl_cond *cond;	/* acl condition to meet */
62 };
63 
64 
65 /* Various functions used to set the fields during the configuration parsing.
66  * Please that all those function can initialize the root entry in order not to
67  * force the user to respect a certain order in the configuration file.
68  *
69  * Default values are used during initialization. Check STATS_DEFAULT_* for
70  * more information.
71  */
72 struct uri_auth *stats_check_init_uri_auth(struct uri_auth **root);
73 struct uri_auth *stats_set_uri(struct uri_auth **root, char *uri);
74 struct uri_auth *stats_set_realm(struct uri_auth **root, char *realm);
75 struct uri_auth *stats_set_refresh(struct uri_auth **root, int interval);
76 struct uri_auth *stats_set_flag(struct uri_auth **root, int flag);
77 struct uri_auth *stats_add_auth(struct uri_auth **root, char *user);
78 struct uri_auth *stats_add_scope(struct uri_auth **root, char *scope);
79 struct uri_auth *stats_set_node(struct uri_auth **root, char *name);
80 struct uri_auth *stats_set_desc(struct uri_auth **root, char *desc);
81 
82 #endif /* _COMMON_URI_AUTH_H */
83 
84 /*
85  * Local variables:
86  *  c-indent-level: 8
87  *  c-basic-offset: 8
88  * End:
89  */
90