File: mod_auth.html

package info (click to toggle)
erlang-doc-html 1%3A11.b.2-1
links: PTS
area: main
in suites: etch, etch-m68k
size: 23,284 kB
ctags: 10,724
sloc: erlang: 505; ansic: 323; makefile: 62; perl: 61; sh: 45
file content (389 lines) | stat: -rw-r--r-- 15,565 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>mod_auth</TITLE>
  <SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
  <STYLE TYPE="text/css">
<!--
    .REFBODY     { margin-left: 13mm }
    .REFTYPES    { margin-left: 8mm }
-->
  </STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
      ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
  <IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>mod_auth</H1>
</CENTER>

<H3>MODULE</H3>
<DIV CLASS=REFBODY>
mod_auth

</DIV>

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
User authentication using text files, dets or mnesia database.

</DIV>

<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>

<P>This module provides for basic user authentication using
         textual files, dets databases as well as mnesia databases. 

</DIV>

<H3>EXPORTS</H3>

<P><A NAME="add_user/2"><STRONG><CODE>add_user(UserName, Options) -&#62; 
         true| {error, Reason}</CODE></STRONG></A><BR>
<A NAME="add_user/5"><STRONG><CODE>add_user(UserName, Password, UserData, Port, Dir)
-&#62; true | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="add_user/6"><STRONG><CODE>add_user(UserName, Password, UserData, Address, Port, Dir)
-&#62; true | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserName = string()</CODE></STRONG><BR>
<STRONG><CODE>Options = [Option]</CODE></STRONG><BR>
<STRONG><CODE>Option = {password,Password} | {userData,UserData} | {port,Port} |
{addr,Address} | {dir,Directory} | {authPassword,AuthPassword}</CODE></STRONG><BR>
<STRONG><CODE>Password = string()</CODE></STRONG><BR>
<STRONG><CODE>UserData = term()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Address = {A,B,C,D} | string() | undefined</CODE></STRONG><BR>
<STRONG><CODE>Dir = string()</CODE></STRONG><BR>
<STRONG><CODE>AuthPassword =string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>
<A NAME="user_api"><!-- Empty --></A><A NAME="add_user"><!-- Empty --></A>
<P><CODE>add_user/2, add_user/5</CODE> and <CODE>add_user/6</CODE> adds a user to the user 
         database. If the operation is succesful, this function returns 
         <CODE>true</CODE>. If an error occurs, <CODE>{error,Reason}</CODE> is returned. When <CODE>add_user/2</CODE> 
is called the Password, UserData Port and Dir options is mandatory.

</DIV>

<P><A NAME="delete_user/2"><STRONG><CODE>delete_user(UserName,Options) 
         -&#62; true | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="delete_user/3"><STRONG><CODE>delete_user(UserName, Port, Dir)
-&#62; true | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="delete_user/4"><STRONG><CODE>delete_user(UserName, Address, Port, Dir)
-&#62; true | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserName = string()</CODE></STRONG><BR>
<STRONG><CODE>Options = [Option]</CODE></STRONG><BR>
<STRONG><CODE>Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword}</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Address = {A,B,C,D} | string() | undefined</CODE></STRONG><BR>
<STRONG><CODE>Dir = string()</CODE></STRONG><BR>
<STRONG><CODE>AuthPassword = string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>
<A NAME="delete_user"><!-- Empty --></A>
<P><CODE>delete_user/2, delete_user/3</CODE> and <CODE>delete_user/4</CODE> deletes a user 
         from the user database. If the operation is succesful, this 
         function returns <CODE>true</CODE>. If an error occurs, 
         <CODE>{error,Reason}</CODE> is returned. When <CODE>delete_user/2</CODE> is
called the Port and Dir options are mandatory.

</DIV>

<P><A NAME="get_user/2"><STRONG><CODE>get_user(UserName,Options)
         -&#62; {ok, #httpd_user} |{error, Reason}</CODE></STRONG></A><BR>
<A NAME="get_user/3"><STRONG><CODE>get_user(UserName, Port, Dir)
-&#62; {ok, #httpd_user} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="get_user/4"><STRONG><CODE>get_user(UserName, Address, Port, Dir)
-&#62; {ok, #httpd_user} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserName = string()</CODE></STRONG><BR>
<STRONG><CODE>Options = [Option]</CODE></STRONG><BR>
<STRONG><CODE>Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword}</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Address = {A,B,C,D} | string() | undefined</CODE></STRONG><BR>
<STRONG><CODE>Dir = string()</CODE></STRONG><BR>
<STRONG><CODE>AuthPassword = string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>
<A NAME="get_user"><!-- Empty --></A>
<P><CODE>get_user/2, get_user/3</CODE> and <CODE>get_user/4</CODE> returns a 
         <CODE>httpd_user</CODE> record containing the userdata for a 
         specific user. If the user cannot be found, <CODE>{error, Reason}</CODE> 
         is returned. When <CODE>get_user/2</CODE> is called the Port and Dir 
         options are mandatory.

</DIV>

<P><A NAME="list_users/1"><STRONG><CODE>list_users(Options)
         -&#62; {ok, Users} | {error, Reason}
&#60;name&#62;list_users(Port, Dir)
-&#62; {ok, Users} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="list_users/3"><STRONG><CODE>list_users(Address, Port, Dir)
-&#62; {ok, Users} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Options = [Option]</CODE></STRONG><BR>
<STRONG><CODE>Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword}</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Address = {A,B,C,D} | string() | undefined</CODE></STRONG><BR>
<STRONG><CODE>Dir = string()</CODE></STRONG><BR>
<STRONG><CODE>Users = list()</CODE></STRONG><BR>
<STRONG><CODE>AuthPassword = string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = atom()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>
<A NAME="list_users"><!-- Empty --></A>
<P><CODE>list_users/1, list_users/2</CODE> and <CODE>list_users/3</CODE> returns a list 
         of users in the user database for a specific <CODE>Port/Dir</CODE>.
When <CODE>list_users/1</CODE> is called the Port and Dir 
         options are mandatory.

</DIV>

<P><A NAME="add_group_member/3"><STRONG><CODE>add_group_member(GroupName, UserName, Options)
-&#62; true | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="add_group_member/4"><STRONG><CODE>add_group_member(GroupName, UserName, Port, Dir)
-&#62; true | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="add_group_member/5"><STRONG><CODE>add_group_member(GroupName, UserName, Address, Port, Dir)
-&#62; true | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>GroupName = string()</CODE></STRONG><BR>
<STRONG><CODE>UserName = string()</CODE></STRONG><BR>
<STRONG><CODE>Options = [Option]</CODE></STRONG><BR>
<STRONG><CODE>Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword}</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Address = {A,B,C,D} | string() | undefined</CODE></STRONG><BR>
<STRONG><CODE>Dir = string()</CODE></STRONG><BR>
<STRONG><CODE>AuthPassword = string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>
<A NAME="add_group_member"><!-- Empty --></A>
<P><CODE>add_group_member/3, add_group_member/4</CODE> and <CODE>add_group_member/5</CODE> 
         adds a user to a group. If the group does not exist, it 
         is created and the user is added to the group. Upon successful 
         operation, this function returns <CODE>true</CODE>. When <CODE>add_group_members/3</CODE> 
is called the Port and Dir options are mandatory.

</DIV>

<P><A NAME="delete_group_member/3"><STRONG><CODE>delete_group_member(GroupName, UserName, Options)
-&#62; true | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="delete_group_member/4"><STRONG><CODE>delete_group_member(GroupName, UserName, Port, Dir)
-&#62; true | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="delete_group_member/5"><STRONG><CODE>delete_group_member(GroupName, UserName, Address, Port, Dir)
-&#62; true | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>GroupName = string()</CODE></STRONG><BR>
<STRONG><CODE>UserName = string()</CODE></STRONG><BR>
<STRONG><CODE>Options = [Option]</CODE></STRONG><BR>
<STRONG><CODE>Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword}</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Address = {A,B,C,D} | string() | undefined</CODE></STRONG><BR>
<STRONG><CODE>Dir = string()</CODE></STRONG><BR>
<STRONG><CODE>AuthPassword = string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>
<A NAME="delete_group_member"><!-- Empty --></A>
<P><CODE>delete_group_member/3, delete_group_member/4</CODE> and <CODE> delete_group_member/5</CODE> deletes a user from a group. 
If the group or the user does not exist, 
         this function returns an error, otherwise it returns <CODE>true</CODE>.
When <CODE>delete_group_member/3</CODE> is called the Port and Dir options
are mandatory.

</DIV>

<P><A NAME="list_group_members/2"><STRONG><CODE>list_group_members(GroupName, Options)
-&#62; {ok, Users} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="list_group_members/3"><STRONG><CODE>list_group_members(GroupName, Port, Dir)
-&#62; {ok, Users} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="list_group_members/4"><STRONG><CODE>list_group_members(GroupName, Address, Port, Dir)
-&#62; {ok, Users} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>GroupName = string()</CODE></STRONG><BR>
<STRONG><CODE>Options = [Option]</CODE></STRONG><BR>
<STRONG><CODE>Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword}</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Address = {A,B,C,D} | string() | undefined</CODE></STRONG><BR>
<STRONG><CODE>Dir = string()</CODE></STRONG><BR>
<STRONG><CODE>Users = list()</CODE></STRONG><BR>
<STRONG><CODE>AuthPassword = string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>
<A NAME="list_group_members"><!-- Empty --></A>
<P><CODE>list_group_members/2, list_group_members/3</CODE> and <CODE>list_group_members/4</CODE> 
         lists the members of a specified group. If the group does not 
         exist or there is an error, <CODE>{error, Reason}</CODE> is returned.
When <CODE>list_group_members/2</CODE> is called the Port and Dir options
are mandatory.

</DIV>

<P><A NAME="list_groups/1"><STRONG><CODE>list_groups(Options)
-&#62; {ok, Groups} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="list_groups/2"><STRONG><CODE>list_groups(Port, Dir)
-&#62; {ok, Groups} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="list_groups/3"><STRONG><CODE>list_groups(Address, Port, Dir)
-&#62; {ok, Groups} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Options = [Option]</CODE></STRONG><BR>
<STRONG><CODE>Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword}</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Address = {A,B,C,D} | string() | undefined</CODE></STRONG><BR>
<STRONG><CODE>Dir = string()</CODE></STRONG><BR>
<STRONG><CODE>Groups = list()</CODE></STRONG><BR>
<STRONG><CODE>AuthPassword = string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>
<A NAME="list_groups"><!-- Empty --></A>
<P><CODE>list_groups/1, list_groups/2</CODE> and <CODE>list_groups/3</CODE> lists all 
         the groups available. If there is an error, <CODE>{error, Reason}</CODE> 
         is returned. When <CODE>list_groups/1</CODE> is called the Port and Dir options
are mandatory.

</DIV>

<P><A NAME="delete_group/2"><STRONG><CODE>delete_group(GroupName, Options)
         -&#62; true | {error,Reason}
&#60;name&#62;delete_group(GroupName, Port, Dir)
-&#62; true | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="delete_group/4"><STRONG><CODE>delete_group(GroupName, Address, Port, Dir)
-&#62; true | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Options = [Option]</CODE></STRONG><BR>
<STRONG><CODE>Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword}</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Address = {A,B,C,D} | string() | undefined</CODE></STRONG><BR>
<STRONG><CODE>Dir = string()</CODE></STRONG><BR>
<STRONG><CODE>GroupName = string()</CODE></STRONG><BR>
<STRONG><CODE>AuthPassword = string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>
<A NAME="delete_group"><!-- Empty --></A>
<P><CODE>delete_group/2, delete_group/3</CODE> and <CODE>delete_group/4</CODE> deletes the 
         group specified and returns <CODE>true</CODE>. If there is an error, 
         <CODE>{error, Reason}</CODE> is returned. When <CODE>delete_group/2</CODE> is called the 
Port and Dir options are mandatory.

</DIV>

<P><A NAME="update_password/5"><STRONG><CODE>update_password(Port, Dir, OldPassword, NewPassword, NewPassword)
-&#62; ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="update_password/6"><STRONG><CODE>update_password(Address,Port, Dir, OldPassword, NewPassword, NewPassword)
-&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Address = {A,B,C,D} | string() | undefined</CODE></STRONG><BR>
<STRONG><CODE>Dir = string()</CODE></STRONG><BR>
<STRONG><CODE>GroupName = string()</CODE></STRONG><BR>
<STRONG><CODE>OldPassword = string()</CODE></STRONG><BR>
<STRONG><CODE>NewPassword = string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>
<A NAME="update_password"><!-- Empty --></A>
<P><CODE>update_password/5</CODE> and <CODE>update_password/6</CODE> Updates the AuthAccessPassword
for the specified directory. If NewPassword is equal to &#34;NoPassword&#34; no password is requires to
change authorisation data. If NewPassword is equal to &#34;DummyPassword&#34; no changes can be done 
without changing the password first.

</DIV>
<A NAME="see_also"><!-- Empty --></A>
<H3>SEE ALSO</H3>
<DIV CLASS=REFBODY>

<P><A HREF="httpd.html">httpd(3)</A>,
<A HREF="mod_alias.html">mod_alias(3)</A>,

</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Mattias Nilsson
 - support@erlang.ericsson.se<BR>
Original implementation: Joakim Greben
 - support@erlang.ericsson.se<BR>

</DIV>
<CENTER>
<HR>
<SMALL>inets 4.7.6<BR>
Copyright &copy; 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>