ipacl.h

Go to the documentation of this file.

/*
 * ipacl.h
 *
 * IP Access Control Lists
 *
 * Portable Windows Library
 *
 * Copyright (c) 1998-2002 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): ______________________________________.
 */

#ifndef PTLIB_IPACL_H
#define PTLIB_IPACL_H


#include <ptlib/sockets.h>


class PIpAccessControlEntry : public PObject
{
  PCLASSINFO(PIpAccessControlEntry, PObject)

  public:
    PIpAccessControlEntry(
      PIPSocket::Address addr,
      PIPSocket::Address msk,
      PBoolean allow
    );
    PIpAccessControlEntry(
      const PString & description
    );

    PIpAccessControlEntry & operator=(
      const PString & pstr
    );
    PIpAccessControlEntry & operator=(
      const char * cstr
    );

    virtual Comparison Compare(
      const PObject & obj   
    ) const;

    virtual void PrintOn(
      ostream &strm   
    ) const;

    virtual void ReadFrom(
      istream &strm   
    );

    PString AsString() const;

    PBoolean IsValid();

    PBoolean Parse(
      const PString & description   
    );


    PBoolean Match(
      PIPSocket::Address & address    
    );

    const PString & GetDomain() const { return domain; }

    const PIPSocket::Address & GetAddress() const { return address; }

    const PIPSocket::Address & GetMask() const { return mask; }

    PBoolean IsAllowed() const { return allowed; }

    PBoolean IsHidden()  const { return hidden; }

  protected:
    PString            domain;
    PIPSocket::Address address;
    PIPSocket::Address mask;
    PBoolean               allowed;
    PBoolean               hidden;
};

PSORTED_LIST(PIpAccessControlList_base, PIpAccessControlEntry);


class PIpAccessControlList : public PIpAccessControlList_base
{

  PCLASSINFO(PIpAccessControlList, PIpAccessControlList_base)

  public:
    PIpAccessControlList(
      PBoolean defaultAllowance = true
    );

    PBoolean LoadHostsAccess(
      const char * daemonName = NULL    
    );

#ifdef P_CONFIG_FILE

    PBoolean Load(
      PConfig & cfg   
    );

    PBoolean Load(
      PConfig & cfg,            
      const PString & baseName  
    );

    void Save(
      PConfig & cfg   
    );

    void Save(
      PConfig & cfg,            
      const PString & baseName  
    );

#endif // P_CONFIG_FILE

    PBoolean Add(
      PIpAccessControlEntry * entry 
    );
    PBoolean Add(
      const PString & description   
    );
    PBoolean Add(
      PIPSocket::Address address,   
      PIPSocket::Address mask,      
      PBoolean allow                    
    );

    PBoolean Remove(
      const PString & description   
    );
    PBoolean Remove(
      PIPSocket::Address address,   
      PIPSocket::Address mask       
    );


    virtual PIpAccessControlEntry * CreateControlEntry(
      const PString & description
    );

    PIpAccessControlEntry * Find(
      PIPSocket::Address address    
    ) const;

    PBoolean IsAllowed(
      PTCPSocket & socket           
    ) const;
    PBoolean IsAllowed(
      PIPSocket::Address address    
    ) const;


    PBoolean GetDefaultAllowance() const { return defaultAllowance; }

    void SetDefaultAllowance(PBoolean defAllow) { defaultAllowance = defAllow; }

  private:
    PBoolean InternalLoadHostsAccess(const PString & daemon, const char * file, PBoolean allow);
    PBoolean InternalRemoveEntry(PIpAccessControlEntry & entry);

  protected:
    PBoolean defaultAllowance;
};


#endif  // PTLIB_IPACL_H


// End of File ///////////////////////////////////////////////////////////////