5
* SQUID Web Proxy Cache http://www.squid-cache.org/
6
* ----------------------------------------------------------
8
* Squid is the result of efforts by numerous individuals from
9
* the Internet community; see the CONTRIBUTORS file for full
10
* details. Many organizations have provided support for Squid's
11
* development; see the SPONSORS file for full details. Squid is
12
* Copyrighted (C) 2001 by the Regents of the University of
13
* California; see the COPYRIGHT file for full details. Squid
14
* incorporates software developed and/or copyrighted by other
15
* sources; see the CREDITS file for full details.
17
* This program is free software; you can redistribute it and/or modify
18
* it under the terms of the GNU General Public License as published by
19
* the Free Software Foundation; either version 2 of the License, or
20
* (at your option) any later version.
22
* This program is distributed in the hope that it will be useful,
23
* but WITHOUT ANY WARRANTY; without even the implied warranty of
24
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25
* GNU General Public License for more details.
27
* You should have received a copy of the GNU General Public License
28
* along with this program; if not, write to the Free Software
29
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
32
#ifndef SQUID_AUTHCONFIG_H
33
#define SQUID_AUTHCONFIG_H
35
class AuthUserRequest;
40
/* for http_hdr_type parameters-by-value */
41
#include "HttpHeader.h"
47
* I am the configuration for an auth scheme.
48
* Currently each scheme has only one instance of me,
49
* but this may change.
51
* This class is treated like a ref counted class.
52
* If the children ever stop being singletons, implement the
59
static AuthUserRequest *CreateAuthUser (const char *proxy_auth);
61
static AuthConfig *Find(const char *proxy_auth);
64
virtual ~AuthConfig() {}
67
* Used by squid to determine whether the auth module has successfully initialised itself with the current configuration.
69
\retval true Authentication Module loaded and running.
70
\retval false No Authentication Module loaded.
72
virtual bool active() const = 0;
75
* new decode API: virtual factory pattern
77
* Responsible for decoding the passed authentication header, creating or
78
* linking to a AuthUser object and for storing any needed details to complete
79
* authentication in AuthUserRequest::authenticate().
81
\param proxy_auth Login Pattern to parse.
82
\retval * Details needed to authenticate.
84
virtual AuthUserRequest *decode(char const *proxy_auth) = 0;
87
* squid is finished with this config, release any unneeded resources.
88
* If a singleton, delete will not occur. if not a singleton (future),
89
* delete will occur when no references are held.
91
\todo we need a 'done for reconfigure' and a 'done permanently' concept.
93
virtual void done() = 0;
96
* The configured function is used to see if the auth module has been given valid
97
* parameters and is able to handle authentication requests.
99
\retval true Authentication Module configured ready for use.
100
\retval false Not configured or Configuration Error.
101
* No other module functions except Shutdown/Dump/Parse/FreeConfig will be called by Squid.
103
virtual bool configured() const = 0;
106
* Responsible for writing to the StoreEntry the configuration parameters that a user
107
* would put in a config file to recreate the running configuration.
109
virtual void dump(StoreEntry *, const char *, AuthConfig *) = 0;
111
/** add headers as needed when challenging for auth */
112
virtual void fixHeader(AuthUserRequest *, HttpReply *, http_hdr_type, HttpRequest *) = 0;
113
/** prepare to handle requests */
114
virtual void init(AuthConfig *) = 0;
115
/** expose any/all statistics to a CacheManager */
116
virtual void registerWithCacheManager(void);
117
/** parse config options */
118
virtual void parse(AuthConfig *, int, char *) = 0;
119
/** the http string id */
120
virtual const char * type() const = 0;
123
#endif /* SQUID_AUTHCONFIG_H */
added
removed
src/auth/Config.h
