Authentication is any process by which you verify that someone is who they claim they are. Authorization is any process by which someone is allowed to be where they want to go, or to have information that they want to have.
For general access control, see the Access Control How-To.
If you have information on your web site that is sensitive or intended for only a small group of people, the techniques in this article will help you make sure that the people that see those pages are the people that you wanted to see them.
This article covers the "standard" way of protecting parts of your web site that most of you are going to use.
If your data really needs to be secure, consider using
The directives discussed in this article will need to go
either in your main server configuration file (typically in a
.htaccess
files).
If you plan to use .htaccess
files, you will
need to have a server configuration that permits putting
authentication directives in these files. This is done with the
Since we're talking here about authentication, you will need
an
Or, if you are just going to put the directives directly in your main server configuration file, you will of course need to have write permission to that file.
And you'll need to know a little bit about the directory structure of your server, in order to know where some files are kept. This should not be terribly difficult, and I'll try to make this clear when we come to that point.
You will also need to make sure that the modules
Here's the basics of password protecting a directory on your server.
First, you need to create a password file. Exactly how you do this will vary depending on what authentication provider you have chosen. More on that later. To start with, we'll use a text password file.
This file should be
placed somewhere not accessible from the web. This is so that
folks cannot download the password file. For example, if your
documents are served out of /usr/local/apache/htdocs
, you
might want to put the password file(s) in
/usr/local/apache/passwd
.
To create the file, use the bin
directory
of wherever you installed Apache. If you have installed Apache from
a third-party package, it may be in your execution path.
To create the file, type:
If /usr/local/apache2/bin/htpasswd
Next, you'll need to configure the server to request a
password and tell the server which users are allowed access.
You can do this either by editing the httpd.conf
file or using an .htaccess
file. For example, if
you wish to protect the directory
/usr/local/apache/htdocs/secret
, you can use the
following directives, either placed in the file
/usr/local/apache/htdocs/secret/.htaccess
, or
placed in httpd.conf
inside a <Directory
"/usr/local/apache/htdocs/secret"> section.
Let's examine each of those directives individually. The Basic
, and this is the method
implemented by AuthType Digest
. This method is implemented by
The
So, for example, once a client has authenticated in the
"Restricted Files"
area, it will automatically
retry the same password for any area on the same server that is
marked with the "Restricted Files"
Realm.
Therefore, you can prevent a user from being prompted more than
once for a password by letting multiple restricted areas share
the same realm. Of course, for security reasons, the client
will always need to ask again for the password whenever the
hostname of the server changes.
The file
is the default value
for this directive. You'll need to use this directive if you are
choosing a different source for authentication, such as
The
Finally, the
The directives above only let one person (specifically
someone with a username of rbowen
) into the
directory. In most cases, you'll want to let more than one
person in. This is where the
If you want to let more than one person in, you'll need to create a group file that associates group names with a list of users in that group. The format of this file is pretty simple, and you can create it with your favorite editor. The contents of the file will look like this:
That's just a list of the members of the group in a long line separated by spaces.
To add a user to your already existing password file, type:
You'll get the same response as before, but it will be
appended to the existing file, rather than creating a new file.
(It's the -c
that makes it create a new password
file).
Now, you need to modify your .htaccess
file to
look like the following:
Now, anyone that is listed in the group GroupName
,
and has an entry in the password
file, will be let in, if
they type the correct password.
There's another way to let multiple users in that is less specific. Rather than creating a group file, you can just use the following directive:
Using that rather than the Require user rbowen
line will allow anyone in that is listed in the password file,
and who correctly enters their password. You can even emulate
the group behavior here, by just keeping a separate password
file for each group. The advantage of this approach is that
Apache only has to check one file, rather than two. The
disadvantage is that you have to maintain a bunch of password
files, and remember to reference the right one in the
Because of the way that Basic authentication is specified, your username and password must be verified every time you request a document from the server. This is even if you're reloading the same page, and for every image on the page (if they come from a protected directory). As you can imagine, this slows things down a little. The amount that it slows things down is proportional to the size of the password file, because it has to open up that file, and go down the list of users until it gets to your name. And it has to do this every time a page is loaded.
A consequence of this is that there's a practical limit to how many users you can put in one password file. This limit will vary depending on the performance of your particular server machine, but you can expect to see slowdowns once you get above a few hundred entries, and may wish to consider a different authentication method at that time.
Because storing passwords in plain text files has the above problems, you may wish to store your passwords somewhere else, such as in a database.
, instead
you can choose dbm
or dbd
as your storage
format.
To select a dbm file rather than a text file, for example:
Other options are available. Consult the
With the introduction of the new provider based authentication and authorization architecture, you are no longer locked into a single authentication or authorization method. In fact any number of the providers can be mixed and matched to provide you with exactly the scheme that meets your needs. In the following example, both the file and LDAP based authentication providers are being used.
In this example the file provider will attempt to authenticate the user first. If it is unable to authenticate the user, the LDAP provider will be called. This allows the scope of authentication to be broadened if your organization implements more than one type of authentication store. Other authentication and authorization scenarios may include mixing one type of authentication with a different type of authorization. For example, authenticating against a password file yet authorizing against an LDAP directory.
Just as multiple authentication providers can be implemented, multiple authorization methods can also be used. In this example both file group authorization as well as LDAP group authorization is being used.
To take authorization a little further, authorization container
directives such as
The way that authorization can be applied is now much more flexible than just a single check against a single data store. Ordering, logic and choosing how authorization will be done is now possible.
Controlling how and in what order authorization will be applied
has been a bit of a mystery in the past. In Apache 2.2 a provider-based
authentication mechanism was introduced to decouple the actual
authentication process from authorization and supporting functionality.
One of the side benefits was that authentication providers could be
configured and called in a specific order which didn't depend on the
load order of the auth module itself. This same provider based mechanism
has been brought forward into authorization as well. What this means is
that the
With the introduction of authorization container directives
such as
By default all
Authentication by username and password is only part of the story. Frequently you want to let people in based on something other than who they are. Something such as where they are coming from.
The authorization providers all
,
env
, host
and ip
let you
allow or deny access based on other host based criteria such as
host name or ip address of the machine requesting a
document.
The usage of these providers is specified through the
where address is an IP address (or a partial IP address) or:
where domain_name is a fully qualified domain name (or a partial domain name); you may provide multiple addresses or domain names, if desired.
For example, if you have someone spamming your message board, and you want to keep them out, you could do the following:
Visitors coming from that address will not be able to see the content covered by this directive. If, instead, you have a machine name, rather than an IP address, you can use that.
And, if you'd like to block access from an entire domain, you can specify just part of an address or domain name:
Using not
,
will only allow access, if all of negated conditions are true. In other words,
access will be blocked, if any of the negated conditions fails.
One of the side effects of adopting a provider based mechanism for
authentication is that the previous access control directives
The directives provided by
There may be times when authentication puts an unacceptable load
on a provider or on your network. This is most likely to affect users
of
This may offer a substantial performance boost to some users.
You should also read the documentation for
The various ciphers supported by Apache for authentication data are explained in Password Encryptions.
And you may want to look at the Access Control howto, which discusses a number of related topics.