Document the 'carp' cache_peer option

[thirdparty/squid.git] / src / ACLIdent.cc

/*
 * $Id$
 *
 * DEBUG: section 28    Access Control
 * AUTHOR: Duane Wessels
 *
 * SQUID Web Proxy Cache          http://www.squid-cache.org/
 * ----------------------------------------------------------
 *
 *  Squid is the result of efforts by numerous individuals from
 *  the Internet community; see the CONTRIBUTORS file for full
 *  details.   Many organizations have provided support for Squid's
 *  development; see the SPONSORS file for full details.  Squid is
 *  Copyrighted (C) 2001 by the Regents of the University of
 *  California; see the COPYRIGHT file for full details.  Squid
 *  incorporates software developed and/or copyrighted by other
 *  sources; see the CREDITS file for full details.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *  
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *  
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
 *
 *
 * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
 */

#include "squid.h"
#include "ACLIdent.h"
#include "authenticate.h"
#include "ACLChecklist.h"
#include "ACLRegexData.h"
#include "ACLUserData.h"

MemPool *ACLIdent::Pool(NULL);
void *
ACLIdent::operator new (size_t byteCount)
{
    /* derived classes with different sizes must implement their own new */
    assert (byteCount == sizeof (ACLIdent));
    if (!Pool)
	Pool = memPoolCreate("ACLIdent", sizeof (ACLIdent));
    return memPoolAlloc(Pool);
}

void
ACLIdent::operator delete (void *address)
{
    memPoolFree (Pool, address);
}

void
ACLIdent::deleteSelf() const
{
    delete this;
}

ACLIdent::~ACLIdent()
{
    data->deleteSelf();
}

ACLIdent::ACLIdent(ACLData<char const *> *newData, char const *newType) : data (newData), type_ (newType) {}
ACLIdent::ACLIdent (ACLIdent const &old) : data (old.data->clone()), type_ (old.type_)
{
}
ACLIdent &
ACLIdent::operator= (ACLIdent const &rhs)
{
    data = rhs.data->clone();
    type_ = rhs.type_;
    return *this;
}

char const *
ACLIdent::typeString() const
{
    return type_;
}

void
ACLIdent::parse()
{
    debug(28, 3) ("aclParseUserList: current is null. Creating\n");
    data = new ACLUserData;
    data->parse();
}

int
ACLIdent::match(ACLChecklist *checklist)
{
    if (checklist->rfc931[0]) {
	return data->match(checklist->rfc931);
    } else {
	checklist->changeState(IdentLookup::Instance());
	return 0;
    }
}

wordlist *
ACLIdent::dump() const
{
    return data->dump();
}

bool
ACLIdent::valid () const
{
    return data != NULL;
}

ACL *
ACLIdent::clone() const
{
    return new ACLIdent(*this);
}

ACL::Prototype ACLIdent::UserRegistryProtoype(&ACLIdent::UserRegistryEntry_, "ident");
ACLIdent ACLIdent::UserRegistryEntry_(new ACLUserData, "ident");
ACL::Prototype ACLIdent::RegexRegistryProtoype(&ACLIdent::RegexRegistryEntry_, "ident_regex" );
ACLIdent ACLIdent::RegexRegistryEntry_(new ACLRegexData, "ident_regex");

IdentLookup IdentLookup::instance_;

IdentLookup *
IdentLookup::Instance()
{
    return &instance_;
}

void
IdentLookup::checkForAsync(ACLChecklist *checklist)const
{
    checklist->asyncInProgress(true);
    debug(28, 3) ("IdentLookup::checkForAsync: Doing ident lookup\n");
    if (checklist->conn() && cbdataReferenceValid(checklist->conn())) {
	identStart(&checklist->conn()->me, &checklist->conn()->peer,
		       LookupDone, checklist);
    } else {
	debug(28, 1) ("IdentLookup::checkForAsync: Can't start ident lookup. No client connection\n");
	checklist->currentAnswer(ACCESS_DENIED);
	checklist->markFinished();
    }
}

void
IdentLookup::LookupDone(const char *ident, void *data)
{
    ACLChecklist *checklist = (ACLChecklist *)data;
    assert (checklist->asyncState() == IdentLookup::Instance());

    if (ident) {
	xstrncpy(checklist->rfc931, ident, USER_IDENT_SZ);
    } else {
	xstrncpy(checklist->rfc931, dash_str, USER_IDENT_SZ);
    }
    /*
     * Cache the ident result in the connection, to avoid redoing ident lookup
     * over and over on persistent connections
     */
    if (cbdataReferenceValid(checklist->conn()) && !checklist->conn()->rfc931[0])
	xstrncpy(checklist->conn()->rfc931, checklist->rfc931, USER_IDENT_SZ);
    checklist->asyncInProgress(false);
    checklist->changeState (ACLChecklist::NullState::Instance());
    checklist->check();
}