Auth Namespace Reference

HTTP Authentication.

Classes
class	Config
class	CredentialCacheRr
class	CredentialsCache
	Cache of Auth::User credentials, keyed by Auth::User::userKey. More...
class	QueueNode
class	Scheme
class	SchemeConfig
class	SchemesConfig
class	StateData
class	User
class	UserRequest

Typedefs
typedef std::vector< Auth::SchemeConfig * >	ConfigVector

Enumerations
enum	CredentialState {   Unchecked , Ok , Pending , Handshake ,   Failed }
enum	Type {   AUTH_UNKNOWN , AUTH_BASIC , AUTH_NTLM , AUTH_DIGEST ,   AUTH_NEGOTIATE , AUTH_BROKEN }
enum	Direction { CRED_CHALLENGE = 1 , CRED_VALID = 0 , CRED_LOOKUP = -1 , CRED_ERROR = -2 }

Functions
	CBDATA_CLASS_INIT (CredentialsCache)
void	Init (void)
	Initialize Auth subsystem.

Variables
Auth::Config	TheConfig
const char *	CredentialState_str []
const char *	Type_str []

Typedef Documentation

ConfigVector

typedef std::vector<Auth::SchemeConfig *> Auth::ConfigVector

Definition at line 24 of file forward.h.

Enumeration Type Documentation

CredentialState

enum Auth::CredentialState

Enumerator
Unchecked
Ok
Pending
Handshake
Failed

Definition at line 15 of file CredentialState.h.

Direction

enum Auth::Direction

Enumerator
CRED_CHALLENGE	Client needs to be challenged. secure token.
CRED_VALID	Credentials are valid and a up to date. The OK/Failed state is accurate.
CRED_LOOKUP	Credentials need to be validated with the backend helper.
CRED_ERROR	ERROR in the auth module. Cannot determine the state of this request.

Definition at line 64 of file UserRequest.h.

Type

enum Auth::Type

Enumerator
AUTH_UNKNOWN
AUTH_BASIC
AUTH_NTLM
AUTH_DIGEST
AUTH_NEGOTIATE
AUTH_BROKEN

Definition at line 17 of file Type.h.

Function Documentation

CBDATA_CLASS_INIT()

Auth::CBDATA_CLASS_INIT

(

CredentialsCache

)

Init()

void Auth::Init

(

void

)

Initialize the authentication modules (if any) This is required once, before any configuration actions are taken.

Definition at line 31 of file AuthReg.cc.

References debugs.

Referenced by free_authparam(), and SquidMain().

Variable Documentation

CredentialState_str

const char* Auth::CredentialState_str[]

extern

Referenced by Auth::User::CredentialsCacheStats().

TheConfig

Auth::Config Auth::TheConfig

extern

Definition at line 15 of file Config.cc.

Referenced by Auth::User::addIp(), addUnique(), authenticateActiveSchemeCount(), authenticateReset(), authenticateRotate(), Auth::CredentialsCache::cleanup(), configDoConfigure(), Auth::User::CredentialsCacheStats(), dump_AuthSchemes(), fake_auth_setup(), Auth::SchemeConfig::Find(), free_AuthSchemes(), getConfig(), mainInitialize(), mainReconfigureFinish(), mainRotate(), parse_AuthSchemes(), Auth::CredentialsCache::scheduleCleanup(), schemesConfig(), and setup_scheme().

Type_str

const char* Auth::Type_str[]

extern

Referenced by Auth::User::CredentialsCacheStats().