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): ______________________________________.
 *
 * $Log: ipacl.h,v $
 * Revision 1.11  2005/11/30 12:47:37  csoutheren
 * Removed tabs, reformatted some code, and changed tags for Doxygen
 *
 * Revision 1.10  2005/01/26 05:37:42  csoutheren
 * Added ability to remove config file support
 *
 * Revision 1.9  2002/11/06 22:47:24  robertj
 * Fixed header comment (copyright etc)
 *
 * Revision 1.8  2002/07/17 02:54:24  robertj
 * Added access functions for member variables.
 *
 * Revision 1.7  2002/06/19 05:43:17  robertj
 * Added missing return for getting default allowance flag
 *
 * Revision 1.6  2002/06/19 04:02:58  robertj
 * Added default allowance boolean if ACL empty.
 * Added ability to override the creation of ACL entry objects with descendents
 *   so an application can add information/functionality to each entry.
 *
 * Revision 1.5  2002/02/13 02:07:14  robertj
 * Added const to IsAllowed() function
 *
 * Revision 1.4  1999/03/09 08:01:46  robertj
 * Changed comments for doc++ support (more to come).
 *
 * Revision 1.3  1999/02/25 05:05:15  robertj
 * Added missing test for hidden entries not to be written to config file
 *
 * Revision 1.2  1999/02/08 08:05:39  robertj
 * Changed semantics of IP access control list for empty list.
 *
 * Revision 1.1  1999/01/31 00:59:26  robertj
 * Added IP Access Control List class to PTLib Components
 *
 */

#ifndef _IPACL_H
#define _IPACL_H


#include <ptlib/sockets.h>


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

  public:
    PIpAccessControlEntry(
      PIPSocket::Address addr,
      PIPSocket::Address msk,
      BOOL 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;

    BOOL IsValid();

    BOOL Parse(
      const PString & description   
    );


    BOOL Match(
      PIPSocket::Address & address    
    );

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

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

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

    BOOL IsAllowed() const { return allowed; }

    BOOL IsHidden()  const { return hidden; }

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

PSORTED_LIST(PIpAccessControlList_base, PIpAccessControlEntry);


class PIpAccessControlList : public PIpAccessControlList_base
{

  PCLASSINFO(PIpAccessControlList, PIpAccessControlList_base)

  public:
    PIpAccessControlList(
      BOOL defaultAllowance = TRUE
    );

    BOOL LoadHostsAccess(
      const char * daemonName = NULL    
    );

#ifdef P_CONFIG_FILE

    BOOL Load(
      PConfig & cfg   
    );

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

    void Save(
      PConfig & cfg   
    );

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

#endif // P_CONFIG_FILE

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

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


    virtual PIpAccessControlEntry * CreateControlEntry(
      const PString & description
    );

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

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


    BOOL GetDefaultAllowance() const { return defaultAllowance; }

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

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

  protected:
    BOOL defaultAllowance;
};


#endif  // _IPACL_H


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

---