blob: e669880486e7ba556a906e2d0ca58220ab4ffc02 [file] [log] [blame]
willy tarreau9e138862006-05-14 23:06:28 +02001/*
2 * URI-based user authentication using the HTTP basic method.
3 *
Willy Tarreaubbd42122007-07-25 07:26:38 +02004 * Copyright 2006-2007 Willy Tarreau <w@1wt.eu>
willy tarreau9e138862006-05-14 23:06:28 +02005 *
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
Willy Tarreau2dd0d472006-06-29 17:53:05 +020013#ifndef _COMMON_URI_AUTH_H
14#define _COMMON_URI_AUTH_H
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020015
16#include <common/config.h>
17
Krzysztof Piotr Oledzki96105042010-01-29 17:50:44 +010018#include <types/auth.h>
19
willy tarreau1f431b52006-05-21 14:46:15 +020020/* 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 */
23struct 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
Krzysztof Oledzkid9db9272007-10-15 10:05:11 +020029#define ST_HIDEVER 0x00000001 /* do not report the version and reldate */
Krzysztof Piotr Oledzki48cb2ae2009-10-02 22:51:14 +020030#define ST_SHNODE 0x00000002 /* show node name */
31#define ST_SHDESC 0x00000004 /* show description */
Krzysztof Piotr Oledzki15514c22010-01-04 16:03:09 +010032#define ST_SHLGNDS 0x0000008 /* show legends */
Krzysztof Oledzkid9db9272007-10-15 10:05:11 +020033
willy tarreau9e138862006-05-14 23:06:28 +020034/* later we may link them to support multiple URI matching */
35struct uri_auth {
36 int uri_len; /* the prefix length */
37 char *uri_prefix; /* the prefix we want to match */
38 char *auth_realm; /* the realm reported to the client */
Krzysztof Piotr Oledzki48cb2ae2009-10-02 22:51:14 +020039 char *node, *desc; /* node name & description reported in this stats */
Willy Tarreaubbd42122007-07-25 07:26:38 +020040 int refresh; /* refresh interval for the browser (in seconds) */
Krzysztof Oledzkid9db9272007-10-15 10:05:11 +020041 int flags; /* some flags describing the statistics page */
willy tarreau1f431b52006-05-21 14:46:15 +020042 struct stat_scope *scope; /* linked list of authorized proxies */
Krzysztof Piotr Oledzki8c8bd452010-01-29 19:29:32 +010043 struct userlist *userlist; /* private userlist to emulate legacy "stats auth user:password" */
44 struct list req_acl; /* http stats ACL: allow/deny/auth */
Krzysztof Piotr Oledzki8001d612008-05-31 13:53:23 +020045 struct uri_auth *next; /* Used at deinit() to build a list of unique elements */
willy tarreau9e138862006-05-14 23:06:28 +020046};
47
48/* This is the default statistics URI */
49#ifdef CONFIG_STATS_DEFAULT_URI
50#define STATS_DEFAULT_URI CONFIG_STATS_DEFAULT_URI
51#else
52#define STATS_DEFAULT_URI "/haproxy?stats"
53#endif
54
55/* This is the default statistics realm */
56#ifdef CONFIG_STATS_DEFAULT_REALM
57#define STATS_DEFAULT_REALM CONFIG_STATS_DEFAULT_REALM
58#else
59#define STATS_DEFAULT_REALM "HAProxy Statistics"
60#endif
61
62
63/* Various functions used to set the fields during the configuration parsing.
64 * Please that all those function can initialize the root entry in order not to
65 * force the user to respect a certain order in the configuration file.
66 *
67 * Default values are used during initialization. Check STATS_DEFAULT_* for
68 * more information.
69 */
70struct uri_auth *stats_check_init_uri_auth(struct uri_auth **root);
71struct uri_auth *stats_set_uri(struct uri_auth **root, char *uri);
72struct uri_auth *stats_set_realm(struct uri_auth **root, char *realm);
Willy Tarreaubbd42122007-07-25 07:26:38 +020073struct uri_auth *stats_set_refresh(struct uri_auth **root, int interval);
Krzysztof Oledzkid9db9272007-10-15 10:05:11 +020074struct uri_auth *stats_set_flag(struct uri_auth **root, int flag);
willy tarreau9e138862006-05-14 23:06:28 +020075struct uri_auth *stats_add_auth(struct uri_auth **root, char *user);
willy tarreau1f431b52006-05-21 14:46:15 +020076struct uri_auth *stats_add_scope(struct uri_auth **root, char *scope);
Krzysztof Piotr Oledzki48cb2ae2009-10-02 22:51:14 +020077struct uri_auth *stats_set_node(struct uri_auth **root, char *name);
78struct uri_auth *stats_set_desc(struct uri_auth **root, char *desc);
willy tarreau9e138862006-05-14 23:06:28 +020079
Willy Tarreau2dd0d472006-06-29 17:53:05 +020080#endif /* _COMMON_URI_AUTH_H */
Willy Tarreaubbd42122007-07-25 07:26:38 +020081
82/*
83 * Local variables:
84 * c-indent-level: 8
85 * c-basic-offset: 8
86 * End:
87 */