<HTML>
<HEAD>
<TITLE>Utilities for the Authorization</TITLE>
<!-- Changed by: Henrik Frystyk Nielsen, 5-Sep-1995 -->
</HEAD>
<BODY>
<H1>Common Parts of Authorization Module to Both Server And
Browser</H1>
<PRE>
/*
** (c) COPYRIGHT MIT 1995.
** Please first read the full copyright statement in the file COPYRIGH.
*/
</PRE>
This module is the interface to the common parts of Access
Authorization (AA) package for both server and browser. Important to
know about memory allocation:<P>
Routines in this module use dynamic allocation, but free automatically
all the memory reserved by them. Therefore the caller never has to
(and never should) free() any object returned by these functions.<P>
Therefore also all the strings returned by this package are only valid
until the next call to the same function is made. This approach is
selected, because of the nature of access authorization: no string
returned by the package needs to be valid longer than until the next
call. This also makes it easy to plug the AA package in: you don't
have to ponder whether to free() something here or is it done
somewhere else (because it is always done somewhere else).<P>
The strings that the package needs to store are copied so the original
strings given as parameters to AA functions may be freed or modified
with no side effects.<P>
Also note: The AA package does not free() anything else than what it
has itself allocated. <P>
This module is implemented by <A HREF="HTAAUtil.c">HTAAUtil.c</A>, and
it is a part of the <A
HREF="http://www.w3.org/pub/WWW/Library/">
W3C Reference Library</A>.
<PRE>
#ifndef HTAAUTIL_H
#define HTAAUTIL_H
#include "HTList.h"
#include "HTReq.h"
</PRE>
<H2>Default filenames</H2>
<PRE>
#ifndef PASSWD_FILE
#define PASSWD_FILE "/home2/luotonen/passwd"
#endif
#ifndef GROUP_FILE
#define GROUP_FILE "/home2/luotonen/group"
#endif
#define ACL_FILE_NAME ".www_acl"
/*
** Numeric constants
*/
#define MAX_USERNAME_LEN 16 /* @@ Longest allowed username */
#define MAX_PASSWORD_LEN 4*13 /* @@ Longest allowed password */
/* (encrypted, so really only 4*8)*/
#define MAX_METHODNAME_LEN 12 /* @@ Longest allowed method name */
#define MAX_FIELDNAME_LEN 16 /* @@ Longest field name in */
/* protection setup file */
#define MAX_PATHNAME_LEN 80 /* @@ Longest passwd/group file */
/* patname to allow */
</PRE>
We need to define the following structures as they are used in the
HTRequest structure. The AA module is declared in <A
HREF="HTAAUtil.html">HTAAUtil</A> and <A HREF="HTAABrow.html">
HTAABrow</A>. The enumeration <CODE>HTAAScheme </CODE>represents the
possible authentication schemes used by the WWW Access Authorization.
<PRE>
typedef enum {
HTAA_UNKNOWN,
HTAA_NONE,
HTAA_BASIC,
HTAA_PUBKEY,
HTAA_KERBEROS_V4,
HTAA_KERBEROS_V5,
HTAA_MAX_SCHEMES /* THIS MUST ALWAYS BE LAST! */
} HTAAScheme;
/*
** Access Authorization failure reasons
*/
typedef enum {
HTAA_OK, /* 200 OK */
HTAA_OK_GATEWAY, /* 200 OK, acting as a gateway */
HTAA_OK_REDIRECT, /* 302 OK, redirected */
HTAA_NO_AUTH, /* 401 Unauthorized, not authenticated */
HTAA_NOT_MEMBER, /* 401 Unauthorized, not authorized */
HTAA_IP_MASK, /* 403 Forbidden by IP mask */
HTAA_IP_MASK_PROXY, /* 403 Forbidden by IP mask on proxy */
HTAA_BY_RULE, /* 403 Forbidden by rule */
HTAA_NO_ACL, /* 403 Forbidden, ACL non-existent */
HTAA_NO_ENTRY, /* 403 Forbidden, no ACL entry */
HTAA_SETUP_ERROR, /* 403 Forbidden, server setup error */
HTAA_DOTDOT, /* 403 Forbidden, URL with /../ illegal */
HTAA_HTBIN, /* 403 Forbidden, /htbin not enabled */
HTAA_INVALID_REDIRECT,
/* 403 Forbidden, bad redirection setup */
HTAA_INVALID_USER, /* 403 Forbidden, bad user directory */
HTAA_NOT_ALLOWED, /* 403 Forbidden, dangerous method must */
/* be explicitly allowed */
HTAA_NOT_FOUND, /* 404 Not found, or read protected */
HTAA_MULTI_FAILED /* 404 No suitable presentation found */
} HTAAFailReason;
</PRE>
<H2>Authentication Schemes</H2>
<PRE>
/* PUBLIC HTAAScheme_enum()
** TRANSLATE SCHEME NAME TO A SCHEME ENUMERATION
** ON ENTRY:
** name is a string representing the scheme name.
**
** ON EXIT:
** returns the enumerated constant for that scheme.
*/
extern HTAAScheme HTAAScheme_enum PARAMS((CONST char* name));
/* PUBLIC HTAAScheme_name()
** GET THE NAME OF A GIVEN SCHEME
** ON ENTRY:
** scheme is one of the scheme enum values:
** HTAA_NONE, HTAA_BASIC, HTAA_PUBKEY, ...
**
** ON EXIT:
** returns the name of the scheme, i.e.
** "none", "basic", "pubkey", ...
*/
extern char *HTAAScheme_name PARAMS((HTAAScheme scheme));
/* extern HTAA_templateMatch()
** STRING COMPARISON FUNCTION FOR FILE NAMES
** WITH ONE WILDCARD * IN THE TEMPLATE
** NOTE:
** This is essentially the same code as in HTRules.c, but it
** cannot be used because it is embedded in between other code.
** (In fact, HTRules.c should use this routine, but then this
** routine would have to be more sophisticated... why is life
** sometimes so hard...)
**
** ON ENTRY:
** tmplate is a template string to match the file name
** agaist, may contain a single wildcard
** character * which matches zero or more
** arbitrary characters.
** filename is the filename (or pathname) to be matched
** agaist the template.
**
** ON EXIT:
** returns YES, if filename matches the template.
** NO, otherwise.
*/
extern BOOL HTAA_templateMatch PARAMS((CONST char * tmplate,
CONST char * filename));
/* PUBLIC HTAA_templateCaseMatch()
** STRING COMPARISON FUNCTION FOR FILE NAMES
** WITH ONE WILDCARD * IN THE TEMPLATE (Case Insensitive)
** NOTE:
** This is essentially the same code as in HTAA_templateMatch, but
** it compares case insensitive (for VMS). Reason for this routine
** is that HTAA_templateMatch gets called from several places, also
** there where a case sensitive match is needed, so one cannot just
** change the HTAA_templateMatch routine for VMS.
**
** ON ENTRY:
** template is a template string to match the file name
** agaist, may contain a single wildcard
** character * which matches zero or more
** arbitrary characters.
** filename is the filename (or pathname) to be matched
** agaist the template.
**
** ON EXIT:
** returns YES, if filename matches the template.
** NO, otherwise.
*/
extern BOOL HTAA_templateCaseMatch PARAMS((CONST char * tmplate,
CONST char * filename));
/* PUBLIC HTAA_makeProtectionTemplate()
** CREATE A PROTECTION TEMPLATE FOR THE FILES
** IN THE SAME DIRECTORY AS THE GIVEN FILE
** (Used by server if there is no fancier way for
** it to tell the client, and by browser if server
** didn't send WWW-ProtectionTemplate: field)
** ON ENTRY:
** docname is the document pathname (from URL).
**
** ON EXIT:
** returns a template matching docname, and other files
** files in that directory.
**
** E.g. /foo/bar/x.html => /foo/bar/ *
** ^
** Space only to prevent it from
** being a comment marker here,
** there really isn't any space.
*/
extern char *HTAA_makeProtectionTemplate PARAMS((CONST char * docname));
</PRE>
<H2>MIME Argument List Parser</H2>
<PRE>
/* PUBLIC HTAA_parseArgList()
** PARSE AN ARGUMENT LIST GIVEN IN A HEADER FIELD
** ON ENTRY:
** str is a comma-separated list:
**
** item, item, item
** where
** item ::= value
** | name=value
** | name="value"
**
** Leading and trailing whitespace is ignored
** everywhere except inside quotes, so the following
** examples are equal:
**
** name=value,foo=bar
** name="value",foo="bar"
** name = value , foo = bar
** name = "value" , foo = "bar"
**
** ON EXIT:
** returns a list of name-value pairs (actually HTAssocList*).
** For items with no name, just value, the name is
** the number of order number of that item. E.g.
** "1" for the first, etc.
*/
extern HTList *HTAA_parseArgList PARAMS((char * str));
</PRE>
<PRE>
#endif /* NOT HTAAUTIL_H */
</PRE>End of file HTAAUtil.h.</BODY>
</HTML>
Webmaster
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to HTAAUtil.html CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Public] / libwww / Library / src