3
* $Id: AuthConfig.h,v 1.4 2007/05/09 07:45:58 wessels Exp $
6
* SQUID Web Proxy Cache http://www.squid-cache.org/
7
* ----------------------------------------------------------
9
* Squid is the result of efforts by numerous individuals from
10
* the Internet community; see the CONTRIBUTORS file for full
11
* details. Many organizations have provided support for Squid's
12
* development; see the SPONSORS file for full details. Squid is
13
* Copyrighted (C) 2001 by the Regents of the University of
14
* California; see the COPYRIGHT file for full details. Squid
15
* incorporates software developed and/or copyrighted by other
16
* sources; see the CREDITS file for full details.
18
* This program is free software; you can redistribute it and/or modify
19
* it under the terms of the GNU General Public License as published by
20
* the Free Software Foundation; either version 2 of the License, or
21
* (at your option) any later version.
23
* This program is distributed in the hope that it will be useful,
24
* but WITHOUT ANY WARRANTY; without even the implied warranty of
25
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26
* GNU General Public License for more details.
28
* You should have received a copy of the GNU General Public License
29
* along with this program; if not, write to the Free Software
30
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
34
#ifndef SQUID_AUTHCONFIG_H
35
#define SQUID_AUTHCONFIG_H
38
* I am the configuration for an auth scheme.
39
* Currently each scheme has only one instance of me,
40
* but this may change.
43
/* This class is treated like a ref counted class.
44
* If the children ever stop being singletons, implement the
48
class AuthUserRequest;
53
static AuthUserRequest *CreateAuthUser (const char *proxy_auth);
55
static AuthConfig *Find(const char *proxy_auth);
58
virtual ~AuthConfig(){}
60
/* Is this configuration active? (helpers running etc etc */
61
virtual bool active() const = 0;
62
/* new decode API: virtual factory pattern */
63
virtual AuthUserRequest *decode(char const *proxy_auth) = 0;
64
/* squid is finished with this config, release any unneeded resources.
65
* If a singleton, delete will not occur. if not a singleton (future),
66
* delete will occur when no references are held.
67
* TODO: we need a 'done for reconfigure' and a 'done permanently' concept.
69
virtual void done() = 0;
70
/* is this config complete enough to run */
71
virtual bool configured() const = 0;
72
/* output the parameters */
73
virtual void dump(StoreEntry *, const char *, AuthConfig *) = 0;
74
/* add headers as needed when challenging for auth */
75
virtual void fixHeader(AuthUserRequest *, HttpReply *, http_hdr_type, HttpRequest *) = 0;
76
/* prepare to handle requests */
77
virtual void init(AuthConfig *) = 0;
78
/* expose any/all statistics to a CacheManager */
79
virtual void registerWithCacheManager(CacheManager & manager);
80
/* parse config options */
81
virtual void parse(AuthConfig *, int, char *) = 0;
82
/* the http string id */
83
virtual const char * type() const = 0;
86
#endif /* SQUID_AUTHCONFIG_H */