| f5691f9c |
1 | |
| 2 | /* |
| 3 | * $Id: AuthConfig.h,v 1.1 2004/08/30 03:28:56 robertc Exp $ |
| 4 | * |
| 5 | * |
| 6 | * SQUID Web Proxy Cache http://www.squid-cache.org/ |
| 7 | * ---------------------------------------------------------- |
| 8 | * |
| 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. |
| 17 | * |
| 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. |
| 22 | * |
| 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. |
| 27 | * |
| 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. |
| 31 | * |
| 32 | */ |
| 33 | |
| 34 | #ifndef SQUID_AUTHCONFIG_H |
| 35 | #define SQUID_AUTHCONFIG_H |
| 36 | |
| 37 | /* |
| 38 | * I am the configuration for an auth scheme. |
| 39 | * Currently each scheme has only one instance of me, |
| 40 | * but this may change. |
| 41 | */ |
| 42 | |
| 43 | /* This class is treated like a ref counted class. |
| 44 | * If the children ever stop being singletons, implement the |
| 45 | * ref counting... |
| 46 | */ |
| 47 | |
| 48 | class AuthConfig |
| 49 | { |
| 50 | |
| 51 | public: |
| 52 | static AuthUserRequest *CreateAuthUser (const char *proxy_auth); |
| 53 | |
| 54 | static AuthConfig *Find(const char *proxy_auth); |
| 55 | AuthConfig() {} |
| 56 | |
| 57 | virtual ~AuthConfig(){} |
| 58 | |
| 59 | /* Is this configuration active? (helpers running etc etc */ |
| 60 | virtual bool active() const = 0; |
| 61 | /* new decode API: virtual factory pattern */ |
| 62 | virtual AuthUserRequest *decode(char const *proxy_auth) = 0; |
| 63 | /* squid is finished with this config, release any unneeded resources. |
| 64 | * If a singleton, delete will not occur. if not a singleton (future), |
| 65 | * delete will occur when no references are held. |
| 66 | * TODO: we need a 'done for reconfigure' and a 'done permanently' concept. |
| 67 | */ |
| 68 | virtual void done() = 0; |
| 69 | /* is this config complete enough to run */ |
| 70 | virtual bool configured() const = 0; |
| 71 | /* output the parameters */ |
| 72 | virtual void dump(StoreEntry *, const char *, AuthConfig *) = 0; |
| 73 | /* add headers as needed when challenging for auth */ |
| 74 | virtual void fixHeader(auth_user_request_t *, HttpReply *, http_hdr_type, HttpRequest *) = 0; |
| 75 | /* prepare to handle requests */ |
| 76 | virtual void init(AuthConfig *) = 0; |
| 77 | /* parse config options */ |
| 78 | virtual void parse(AuthConfig *, int, char *) = 0; |
| 79 | /* the http string id */ |
| 80 | virtual const char * type() const = 0; |
| 81 | }; |
| 82 | |
| 83 | #endif /* SQUID_AUTHCONFIG_H */ |
projects / thirdparty / squid.git / blame