Lighttpd setup a password protected directory (directories)

Lighttpd logo

If you require authentication on certain directories using the Lighttpd web server, you can use Lighttpd's mod_auth module. It allows you to protect any directory in web server with access restrictions (just like Apache's password protected directory) .

Lighttpd supports both basic and digest authentication methods. Now consider following sample setup:

  1. Domain name: theos.in
  2. Directory (DocRoot) to protect with a password: /home/lighttpd/theos.in/http/docs
  3. Username: vivek
  4. Lighttpd password file: /home/lighttpd/.lighttpdpassword (this file should be outside default http document root)

How do I use Basic authentication method?

Easy to implement and password stored in cleartext format using files. If you are going to use this method make sure you use SSL (Secure Socket Layer) connection/encryption.

Step #1: Open /etc/lighttpd/lighttpd.conf file

Make sure mod_auth is loaded:
server.modules += ( "mod_auth" )

Now add following three directives:
auth.debug = 2
auth.backend = "plain"
auth.backend.plain.userfile = "/home/lighttpd/.lighttpdpassword"

Where,

  • auth.debug = 2 : Specify debug level (0 turns off debug message, 1 for authentication ok message and 2 for detailed/verbose debugging message). This is useful for troubleshooting authentication problem. It logs message in access.log and error.log files
  • auth.backend = "plain" : You are using plain text backend (other options are ldap, htpasswd and others)
  • auth.backend.plain.userfile = "/home/lighttpd/.lighttpdpassword" : Filename of the username:password storage

Next, you need specify which directory you want to password protect. For example, consider directory /home/lighttpd/theos.in/http/docs directory. Find out your domains virtual hosting section (theos.in) and append following text:
auth.require = ( "/docs/" =>
(
"method" => "basic",
"realm" => "Password protected area",
"require" => "user=vivek"
)
)

Where,

  • auth.require = ( "/docs/" => : Directory name
  • "method" => "basic", : Authentication type
  • "realm" => "Password protected area", : Password realm/message
  • "require" => "user=vivek" : Only user vivek can use /docs/

At the end, your configuration should read as follows:
$HTTP["host"] == "theos.in" {
server.document-root = "/home/lighttpd/theos.in/http"
server.errorlog = "/var/log/lighttpd/theos.in/error.log"
accesslog.filename = "/var/log/lighttpd/theos.in/access.log"
auth.require = ( "/docs/" =>
(
"method" => "basic",
"realm" => "Password protected area",
"require" => "user=vivek"
)
)
}

Save and close the file.

Step # 2: Create a password file

Create a plain text username (vivek) and password file:
# vi /home/lighttpd/.lighttpdpassword

Append username:password:
vivek:mysecretepassword

Where,

  • vivek - is the name of a user. Please note that do not use a system user stored in /etc/passwd file. It is recommended that you use a different username that only exists for the purpose of authenticating password protected directories.
  • mysecretepassword - is the password for user vivek (must be in clear text format for plain text method)

Save and close the file. Make sure file /home/lighttpd/.lighttpdpassword is readable by lighttpd:
# chown lighttpd:lighttpd /home/lighttpd/.lighttpdpassword

Finally, restart lighttpd server:
# /etc/init.d/lighttpd restart

Step # 3: Test your configuration

Fire your browser and point a web browser to http://yourdomain.com/docs/ or http://localhost/docs/ or http://ip-address/docs. You should be prompted for a username and password.

Lighttpd password dialog

This way you can restrict access to certain areas of your website. Make sure you also use SSL encryption for authenticating users and secure digest authentication.

Want to read Linux tips and tricks, but don't have time to check our blog everyday? Subscribe to our daily email newsletter to make sure you don't miss a single tip/tricks. Subscribe to our weekly newsletter here!

{ 1 trackback }

Howto: Keep wordpress blog private from search engines » Computer, Technology and OS blog
08.01.06 at 10:33 pm

{ 38 comments… read them below or add one }

1 Bryan 09.06.06 at 5:53 am

Hello,

Great post .I am new to lightTPD and having trouble implementing the changes to the lighttpd.conf file.

Is there a way you could post the conf in its entirety?

Thanks,

Bryan

2 nixcraft 09.06.06 at 8:05 am

You want to see my sample conf file…

3 Bryan 09.06.06 at 4:46 pm

Yeah, that would be great. I am having a hard time inserting the tutorial items into my existing conf file.

4 nixcraft 09.06.06 at 5:57 pm

Sorry for trouble. It was CSS code that was causing the problem. It is fixed now. You can now copy and paste instructions. Or just grab my configuration file:

http://www.cyberciti.biz/tmp/lighttpd.conf.txt

5 Bryan 09.07.06 at 5:58 am

Thanks, I was able to get it working using your sample as a reference.

6 Fabian 10.05.06 at 11:01 pm

Do you have somehting like this for samba….??? I can’t get samba to ask for authentication crednetials after having worked on the config file and retsarted the daemon [and also tried restarted the server].

7 Fabian 10.10.06 at 4:47 pm

As you describe in this detailed post, using plain text password is not secure enough without SSL.

Question: What about using basic htpasswd or htdigest? Are these susceptible to replay attacks also?

Thanks,
Fabian.

8 nixcraft 10.10.06 at 7:26 pm

Fabian,

There only 2 methods:
a) Basic – username nad password in cleartext over the network
b) Digest – The Digest method only transfers a hashed value over the network hence more secure

digest onlysupport plaintext or htdigest backend to store username/password information.

Question: What about using basic htpasswd or htdigest? Are these susceptible to replay attacks also?

To be frank, your password is more secure as compare to plain text, there are two things you need to consider:
Not all browser supports digest method (only IE 5.0+, Mozilla/FF 1.0.1. Netscape 7+, Opera4+ etc supports digest)
Second if an attacker knows http protocol very well he can still find out your password (a rare case)

In short which ever method you use, get SSL support. You can also use your own SSL certificate if you cannot afford to purchase original one.

9 Hans 05.30.07 at 1:15 pm

Great article, just what I was looking for. I have everything, except for the Chown command. I get the error message stating that there is no such group (or user) as lighttpd. Hope you can help!

10 vivek 05.30.07 at 3:21 pm

Open your lighttpd config file and find out username and apply the same to .password file

11 Mike 07.04.07 at 2:49 pm

If you only want to secure a file (not the entire directory), just add the full path information, e.g.:

auth.require = ( “/docs/secretpage.html” =>
(
“method” => “basic”,
“realm” => “Password protected area”,
“require” => “user=vivek”
)

12 Patrick 07.08.07 at 7:59 pm

Just tried to implement this, however I get stuck at the chown and the restart.(running lighttpd on my dns323)

So I skipped those and went to:
./lighttpd -D -f lighttpd.conf

Then I get the message:
can’t handle ‘$HTTP[url] =~ …’ as you compiled without pcre support.
two questions, what is pcre support, and what do Ihave to put in stead of the [url]

thanks
Patrick

13 vivek 07.08.07 at 9:41 pm

PCRE support requires for perl style regex config option such as $HTTP[url] =~ ‘^/patj/to’ etc

Please add support package pcre-devel or pcre-lib and recompile lighttpd.

14 kunal 07.30.07 at 2:43 am

hi,

this configuration is not working i m not getting any username or password filed is i try to open the doc folders and its files in the browsers.

It shows me error 404- File Not Found

can you explain me why this error is coming

Thanks in advance

15 kunal 07.30.07 at 3:46 am

hi,

Aforsaid configuration is working now its my fault.
but now the problem is i have restriced a folder name d as docs in auth.require module and it has a file name as index.htm in it now when ever i run the website in my browser as https://mysite.com/docs/then it will ask me for username and password and after entering the username and password it shows error 404- File Not Found but i have index.htm in the doc folder.

what is the reason for this error.hope you will reply soon

Thanks in advance

16 kunal 07.30.07 at 6:37 am

hi,

sorry guys its me again.
no problem in ur article its fully my fault and i figured out where i was doing wrong.

sorry again ur tutorial helps me a lot starting from installing and configuring to protecting directories
i m really thankful to you

thanks a lot

17 influenza 12.28.07 at 5:38 pm

Hi,

I’ve a question regarding all this. I don’t kno if it’s possible at all. My nas uses lighttpd for it’s administrative tasks. I use the build in lighttpd as well to serve some pages etc. Now I want to set a password on a folder. The admin function uses a password already and I want the same, I just want to add my folder that needs password protection. I have been trying to alter the conf file, but with no luck. Maybe you can shed some light on it? conf file pasted below:

server.document-root = “/usr/www/lib/”
server.pid-file = “/var/run/lighttpd.pid”
server.errorlog = “/var/log/lighttpd/error.log”
dir-listing.activate = “enable”

server.port = 5000

server.username = “www-data”
server.groupname = “www-data”

server.modules = (
“mod_auth”,
“mod_access”,
“mod_alias”,
“mod_cgi”,
“mod_fastcgi”,
“mod_accesslog”
)

server.errorfile-prefix = “/usr/www/lib/error-”

mimetype.assign = (
“.html” => “text/html”,
“.txt” => “text/plain”,
“.jpg” => “image/jpeg”,
“.png” => “image/png”,
“.gif” => “image/gif”,
“.css” => “text/css”
)

accesslog.filename = “/var/log/lighttpd/access.log”

static-file.exclude-extensions = ( “.fcgi”, “.php”, “.rb”, “~”, “.inc”, “.cgi” )
index-file.names = ( “nasMaster.pl” )

# bruce – I don’t think we need this now…
#cgi.assign = ( “.cgi” => “/usr/bin/perl” )

alias.url = ( “/auth” => “/usr/www/lib” )

auth.backend = “htdigest”
auth.backend.htdigest.userfile = “/var/private/lighttpd.htdigest.user”
auth.require = ( “/auth” =>
(
“method” => “digest”,
“realm” => “nas admin”,
“require” => “valid-user”
# bruce – removed user=
# “require” => “user=admin”

)

)

fastcgi.debug = 0

# Bruce – Removed host & port and replaced with a socket
# “host” => “127.0.0.1″,
# “port” => 1026,
fastcgi.server = ( “.pl” =>
(( “socket” => “/tmp/lighttpd.fcgi.socket”,
“bin-path” => “/usr/www/lib/nasMaster.pl”,
“check-local” => “disable”,
“min-procs” => 1,
“max-procs” => 1,
“idle-timeout” => 30,
“bin-environment” => (
# Environment variables for nasMaster.pl
“PERL5LIB” => “/usr/www/lib”,
“NAS_NBIN” => “/usr/www/nbin”,
),
)),
“nasMaster.pl” => (( “socket” => “/tmp/lighttpd.fcgi.socket”,
“check-local” => “disable”,
))
)

18 Vincent 01.21.08 at 5:46 pm

Hi,

I use the htdigest authentication, by adding a line to /var/private/lighttpd.htdigest.user .
Somehow, this added line is disappearing, so it seems the file is overwritten every now and then.

Anyone knows when and how?

19 vivek 01.21.08 at 6:37 pm

Vincent,

Make file readonly using chattr or chmod.

20 paul 02.07.08 at 8:03 am

How do I setup multiple user IDs? This example show only for one “user=vivek”

21 vivek 02.07.08 at 10:07 am

Paul,

Just append a new user / password

HTH

22 nitin 02.14.08 at 1:07 am

Hi…I have the same problem as influenza. I am trying to add a authentication to my nas (mybook). Has anyone figured this out.

23 pille 02.21.08 at 12:49 pm

you can add multiple users by sparating them with a tilde.
eg.
“require” => “user=user1|user=user2″

24 ak.from.wf 03.07.08 at 9:36 pm

Is there a way to suppress directory listings?

25 vivek 03.08.08 at 5:34 am

directory listings can be enabled or disabled using

server.dir-listing = "enable"

Turn on listing for /docs/ only:

$HTTP["url"] =~ "^/docs($|/)" {   server.dir-listing = "enable"   }
26 all2ez 07.17.08 at 7:48 pm

Thx, this is exactly what I needed to protect my “private” pages on my iPod Touch lighttpd server!

27 mesut 07.24.08 at 1:16 pm

Hi,

Is there a way to protect different directories with different password files.

28 hoff 08.07.08 at 3:21 pm

Hi,

Is it possible to use lighttpd to authenticate http requests to a specific url instead of a directory? for example, I have a site http://www.example.com that is public facing, but I also have a webservice at service.example.com. Any request to service.example.com gets redirected to an application listening on some other port, not to a directory. I want lighttpd to authenticate any request to service.example.com. How can this be done?

29 FreeBSD4Me 08.18.08 at 6:11 pm

mesut had a good question. Does anyone know how to password protect different directories with different user/password?

Example:
domain.com/stuff restricted to guest
domain.com/mystuff restricted to userx

Thanks

30 FreeBSD4Me 08.18.08 at 6:30 pm

Here is the answer to the question of authenticating multiple directories with different user/passwd

http://trac.lighttpd.net/trac/wiki/HowToAuthenticationFromMultipleFiles

31 DanielS 09.17.08 at 5:32 am

Just a quick note as far as step one, a simple command would be lighty-enable-mod auth
Otherwise Great Post! Thanks!

32 mad 12.20.08 at 8:28 pm

Hi,

how can I password protect main folder (server.document-root=/usr/local/www)

Thanks.

33 dikshie 01.24.09 at 3:07 pm

hi,
i just migrate apache to lighttpd. i found i can not find easy and straightforward way
to enable auth for every users since all my users has .htpassword in public_html
any straightforward way to enable auth for every /home/$user/public_html/ ?

thanks!

34 yannick coulombe 03.03.09 at 3:51 pm

Thanks,

without having to do some more google searches !!

35 Marcus 03.24.09 at 3:28 pm

Along the lines of what Paul posted, I’m trying to password protect a directory for multiple users. You posted that you should simply append a new user to the end of the /etc/lighttpd/lighttpd.conf file, but I’m confused about the formatting. Should it look like:


auth.require = ( "/media/" =>
(
"method" => "basic",
"realm" => "Media",
"require" => "user=user1"
"require" => "user=user2"
)

Or should it look like:

auth.require = ( "/media/" =>
(
"method" => "basic",
"realm" => "Media",
"require" => "user=user1|user=user2"
)

?

Also, what should the password file look like in order to do this? Thanks!

36 Clive 06.11.09 at 7:51 pm

Hi,

I’m just wondering if password protection is the answer to my problem. I want to only allow files to be downloaded via pages on my website and nowhere else, I can stop hotlinking from other sites with the following:

$HTTP["referer"] !~ “^($|http://www\.mydomain\.com)” {
url.access-deny = ( “.mp3″, “.zip” )
}

But that doesnt prevent people from typing the url of a file directly into the browser, they can still download it that way. Is there any other way to prevent this? I’d prefer to just have a 403 forbidden to appear if a file is accessed directly or from another site, but I cant find a solution anywhere so I may consider using a password protected directory.

37 Vivek Gite 06.11.09 at 7:53 pm
38 Clive 06.11.09 at 10:59 pm

yeah thats the second time that has been suggested to me, I should really have said I’ve already looked at mod_secure_download. The php app has to be written to make use of it so it’s not an option. I was hoping for a solution by the webserver only, something to put in the lighttpd.conf file to achieve this but its looking like it isnt possible :(

Leave a Comment

You can use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

Tagged as: , , , , , , , , ,

Previous post: Fun Things To Do With Your Honeypot

Next post: Xen not ready for prime-time, says Red Hat