htaccess(1M)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | FILES | SEE ALSO | NOTES

NAME

/usr/bin/htaccess - Allows manipulation of Sun^TM WebServer^TM access control lists (ACLs) configuration.

SYNOPSIS

htaccess add [ -a] [-g group_name| -I Internet_host| -u username] -h hostname -i instance [-m method] [-r realm_name] [ -s scheme_name] -U URI_name [- y| -n] [-z admin[-p]]
htaccess check [ -a] [-g group_name| -I Internet_host| -u user_name] -h hostname -i instance [-m method] -U URI_name [-z admin[-p]]
htaccess delete [ -a] [-g group_name| -I Internet_host| -u user_name] -h hostname -i instance [-m method] -U URI_name [ -y| -n] [-z admin[-p]]
htaccess help
htaccess list -h hostname -i instance -U URI_name [-z admin[-p]]
htaccess version

DESCRIPTION

htaccess adds or deletes access control lists (ACLs) for resources on a web site. An ACL applies to any token that can be a Uniform Resource Identifier (URI) on that site, whether that URI is a directory, file, servlet, CGI, or alias to another resource.

ACLs can restrict access by the host name or IP address of a client, or by an authenticated user or group name. Users are authenticated against a named realm (see htrealm(1m)), which defines whether passwords are stored in a Sun WebServer specific file (HTPASSWD), the operating system (UNIXSYS), in the Solaris ISP Server^TM environment, an LDAP directory of ISP subscribers (ISP), or in the Sun^TM Internet Administrator ^TMfor Solaris ISP Server (ISPADMIN).

The list subcommand can be used to list the current ACLs on a URI.

The check subcommand can be used to check whether a user name and password can access a URI.

OPTIONS

Subcommands

The following subcommands are supported:

add

Adds a new ACL or permission to an existing ACL.

check

Checks if the specified access is allowed.

delete

Deletes an ACL or permission to an existing ACL.

help

Displays help on usage.

list

Lists all ACLs and their permissions for a given URL or specified host.

version

Displays the version of htaccess.

Options

The following options are supported:

-a

Specifies that the user or group is the administrator. Valid with the add and delete subcommands.

-g group_name

Specifies the group in the realms to which the permissions apply. A group is a group of users defined in the realm. Use the wild card \* to indicate that the permission applies to any group_name. Valid with the add, delete, and check subcommands.

-h hostname

Specifies the name of the virtual host containing the ACL. Valid with all subcommands.

-I Internet_host

Specifies the IP or domain to which the permissions apply. Internet_host can be a fully qualified or partial domain name. If the domain name is partial, the permission applies to all hosts whose fully qualified names end with the domain. It can also be a fully qualified or partial IP address. If the IP address is partial, the permission applies to all hosts whose IP address begins with the Internet_host. Use the wild card \* to indicate that the permission applies to any Internet_host. Valid with the add, delete, and check subcommands.

-i instance

Specifies the name of the httpd instance. Valid with all subcommands.

-m method

Specifies the HTTP method name to which the permissions apply. The method directive is a list of ALL, DELETE, GET, POST, and PUT. Select ALL to permit all HTTP methods. Separate multiple methods with a space. The default is ALL. Valid with the add, delete, and check subcommands.

-n

Denies access permission to the named user, group, or host. Valid with the add and delete subcommands.

-p

Turns off prompting of password such that passwords are taken in from stdin and scripts may pipe (|) passwords. Valid with all subcommands.

-r realm_name

Specifies the realm name. Valid with the add subcommand.

-s scheme_name

Specifies authentication scheme. Valid with the add subcommand.

BASIC

The server expects user name and password information in base64 encoded text.

MD5

The server expects user name and a message digest of the password. The server must get the password in base64 encoded text locally, create a message digest, and compare it to the digest sent by the client. Valid only with htpasswd.

NONE

The server does not expect any authentication.

-U URI_name

Specifies URI name protected by the ACL. Valid with all subcommands.

-u username

Specifies the user name to which the permission applies. A user is any user with a user name for which Sun WebServer retrieves the password from the realm name specified in the ACL. Use the wild card \* to indicate that the permission applies to any user. Valid with the add, check, and delete subcommands.

-v

Specifies the verbose mode. Valid with all subcommands.

-y

Allows the named user, group, or host to access the URI. Valid with the add and delete subcommands.

-z admin_name

Specifies the name of the administrator. Valid with the add, check, and delete subcommands.

EXAMPLES

---

Example 1




To protect the URL http://www.A.com/project/ on the server instance "sws_server" using an HTPASSWD realm "Project" with user "user1":

# htrealm add -i sws_server -h www.A.com -r Project \\ 
-s HTPASSWD -d realms/Project
# htrealm add -i sws_server -h www.A.com -r Project -u user1
Setting password for the user user1.
Password:
Confirm Password:
# htaccess add -i sws_server -h www.A.com -U "/project" \\  
 -r Project -s BASIC -m GET -u '*' -y

---

---

Example 2




To delegate access control management to the user web master in the realm WebUsers:

# htaccess add -i sws_server -h www.A.com -U / -r WebUsers -s MD5 -a \\ 
 -u webmaster

---

---

Example 3




To use htaccess as a user other than root:

%  htaccess add -i sws_server -h www.A.com -U / -I .domain.A.com -m PUT -z  admin
Enter password for admin:

---

---

Example 4




To use htaccess as a user other than root and read the administration password from a file /tmp/tp/admin.pwd:

% htaccess list -i sws_server -h www.A.com -U / -z admin -p < /tmp/tp/admin.pwd 

---

EXIT STATUS

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWhttp
Interface Stability	Evolving

FILES

The following files are used by this utility:

site_path/conf/access.conf

Configures a web site's access control lists.

/etc/http/access.conf

Configures the server administration access control lists.

site_path/conf/realms.conf

Defines the realms used to define users for web site access control lists.

/etc/http/realms.conf

Defines the realms used to define users for server administration.

SEE ALSO

access.conf(4), htIntro(1m), htrealm(1m), realms.conf(4)

NOTES

If the command is run by the root user, then the user name and password of an administrator are not required.

Users other than root must use the -z option and pass the user name and password of a valid administrator to the command.

MD5 authentication can only be used with HTPASSWD realms.

Sun WebServer 2.1  Last Revised 22 February 1999

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | FILES | SEE ALSO | NOTES