Fix a typo. Support service names in `--port' option.

[become] / src / class.h

/* -*-c-*-
 *
 * $Id: class.h,v 1.2 1997/08/04 10:24:21 mdw Exp $
 *
 * Handling classes of things nicely
 *
 * (c) 1997 EBI
 */

/*----- Licensing notice --------------------------------------------------*
 *
 * This file is part of `become'
 *
 * `Become' 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.
 *
 * `Become' 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 `become'; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

/*----- Revision history --------------------------------------------------*
 *
 * $Log: class.h,v $
 * Revision 1.2  1997/08/04 10:24:21  mdw
 * Sources placed under CVS control.
 *
 * Revision 1.1  1997/07/21  13:47:52  mdw
 * Initial revision
 *
 */

#ifndef CLASS_H
#define CLASS_H

#ifdef __cplusplus
  extern "C" {
#endif

/*----- Required headers --------------------------------------------------*/

#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>

#ifndef SYM_H
#  include "sym.h"
#endif

/*----- Data structures ---------------------------------------------------*/

/* --- Class types --- */

enum {
  clType_user = 1,			/* Class of users */
  clType_command = 2,			/* Class of command strings */
  clType_host = 4,			/* Class of host names */
  clType_all = 7,			/* All of the above (maintain me) */
  clType__limit				/* First undefined class type */
};

/* --- Class block --- */

typedef struct classdef {
  unsigned type;			/* Type of this class */
  unsigned ref;				/* Reference count */
  sym_table *t;				/* Symbol table for this class */
} classdef;

/*----- Global variables --------------------------------------------------*/

extern classdef *class_all;		/* The match-everything class */

/*----- Functions provided ------------------------------------------------*/

/* --- @class_create@ --- *
 *
 * Arguments:	@unsigned type@ = type of the class to create
 *		@sym_table *t@ = pointer to symbol table which stores info
 *
 * Returns:	Pointer to a @classdef@ which maintains the class's info.
 *
 * Use:		Creates a new class definition.  The new definition has one
 *		reference attached to it (which is the one you get returned).
 */

extern classdef *class_create(unsigned /*type*/, sym_table */*t*/);

/* --- @class_inc@ --- *
 *
 * Arguments:	@classdef *c@ = pointer to a class block
 *
 * Returns:	---
 *
 * Use:		Adds a reference to the class definition.
 */

extern void class_inc(classdef */*c*/);

/* --- @class_dec@ --- *
 *
 * Arguments:	@classdef *c@ = pointer to a class block
 *
 * Returns:	---
 *
 * Use:		Removes a reference to a class block.
 */

extern void class_dec(classdef */*c*/);

/* --- @class_userMatch@ --- *
 *
 * Arguments:	@classdef *c@ = pointer to a class block
 *		@int u@ = uid number to check against
 *
 * Returns:	Zero if no match, nonzero if it matched.
 *
 * Use:		Looks to see if a user is in a group.
 */

extern int class_userMatch(classdef */*c*/, int /*u*/);

/* --- @class_commandMatch@ --- *
 *
 * Arguments:	@classdef *c@ = pointer to a class block
 *		@const char *p@ = pointer to command string to match
 *
 * Returns:	Zero for no match, nonzero if it matched.
 *
 * Use:		Tries to match a string against the wildcard patterns in the
 *		given class.  Note that this involves examining all the
 *		items, so it's not too quick.  Then again, you don't have
 *		big command classes, do you...?
 */

extern int class_commandMatch(classdef */*c*/, const char */*p*/);

/* --- @class_hostMatch@ --- *
 *
 * Arguments:	@classdef *c@ = pointer to class block
 *		@struct in_addr addr@ = IP address to match
 *
 * Returns:	Zero for no match, nonzero if it matched.
 *
 * Use:		Tries to match an IP address against the patterns and masks
 *		in the given class.
 */

extern int class_hostMatch(classdef */*c*/, struct in_addr /*addr*/);

/* --- @class_dump@ --- *
 *
 * Arguments:	@classdef *c@ = pointer to a class block
 *
 * Returns:	---
 *
 * Use:		Dumps the contents of a class to a stream.
 */

extern void class_dump(classdef */*c*/);

/*----- That's all, folks -------------------------------------------------*/

#ifdef __cplusplus
  }
#endif

#endif