Lighttpd setup a password protected directory (directories)

by on July 31, 2006 · 54 comments· LAST UPDATED May 26, 2008

in , ,

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.

TwitterFacebookGoogle+PDF versionFound an error/typo on this page? Help us!

{ 54 comments… read them below or add one }

1 Bryan September 6, 2006 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

Reply

2 nixCraft September 6, 2006 at 8:05 am

You want to see my sample conf file…

Reply

3 Bryan September 6, 2006 at 4:46 pm

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

Reply

4 nixCraft September 6, 2006 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

Reply

5 Bryan September 7, 2006 at 5:58 am

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

Reply

6 Fabian October 5, 2006 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].

Reply

7 Fabian October 10, 2006 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.

Reply

8 nixCraft October 10, 2006 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.

Reply

9 Hans May 30, 2007 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!

Reply

10 nixCraft May 30, 2007 at 3:21 pm

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

Reply

11 Mike July 4, 2007 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”
)

Reply

12 Patrick July 8, 2007 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

Reply

13 nixCraft July 8, 2007 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.

Reply

14 kunal July 30, 2007 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

Reply

15 kunal July 30, 2007 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

Reply

16 kunal July 30, 2007 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

Reply

17 influenza December 28, 2007 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”,
))
)

Reply

18 Vincent January 21, 2008 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?

Reply

19 nixCraft January 21, 2008 at 6:37 pm

Vincent,

Make file readonly using chattr or chmod.

Reply

20 paul February 7, 2008 at 8:03 am

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

Reply

21 nixCraft February 7, 2008 at 10:07 am

Paul,

Just append a new user / password

HTH

Reply

22 nitin February 14, 2008 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.

Reply

23 pille February 21, 2008 at 12:49 pm

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

Reply

24 ak.from.wf March 7, 2008 at 9:36 pm

Is there a way to suppress directory listings?

Reply

25 nixCraft March 8, 2008 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"   }

Reply

26 all2ez July 17, 2008 at 7:48 pm

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

Reply

27 mesut July 24, 2008 at 1:16 pm

Hi,

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

Reply

28 hoff August 7, 2008 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?

Reply

29 FreeBSD4Me August 18, 2008 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

Reply

30 FreeBSD4Me August 18, 2008 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

Reply

31 DanielS September 17, 2008 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!

Reply

32 mad December 20, 2008 at 8:28 pm

Hi,

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

Thanks.

Reply

33 dikshie January 24, 2009 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!

Reply

34 yannick coulombe March 3, 2009 at 3:51 pm

Thanks,

without having to do some more google searches !!

Reply

35 Marcus March 24, 2009 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!

Reply

36 Clive June 11, 2009 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.

Reply

37 nixCraft June 11, 2009 at 7:53 pm
38 Clive June 11, 2009 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 :(

Reply

39 Pep September 5, 2009 at 9:15 am

Hi,
I followed this how-to. I get it to state, when it says no errors. But authentification still doesn`t work. I would like to describe it more in detail but all I can say is: no errors; web works as before setting authentification; but webpage doesn`t require any username and password. I`ve restarted OpenWRT, which maked no difference.
Thank you for help.

Reply

40 Charlie January 6, 2010 at 1:05 am

Hi,
My web server is DNS-323 with fun_plug 0,5 and lighttpd
I have changed the lighttpd.conf to include the following:

server.modules              = (
                                "mod_access",
                                "mod_auth",
                                "mod_fastcgi",
                                "mod_accesslog" )
server.document-root        = "/mnt/HD_a2/www/pages/"
$HTTP["url"] =~ "^/Yuemeng/" {
auth.debug = 2
auth.backend = "plain"
auth.backend.plain.userfile = "/mnt/HD_a2/www/pwd/.pwd_Yuemeng"
auth.require = ( "/Yuemeng/" =>
 	(
	"method" => "basic",
	"realm" => "Password protected area",
	"require" => "user=TEST"
	)
   )
},

Only one line in the file /mnt/HD_a2/www/pwd/.pwd_Yuemeng
TEST:xxyyzz

The “Yuemeng” is sub directory of “/mnt/HD_a2/www/pages/”

after restart lighttpd, I do got popup window asking for username and password,
but entering the usename and passwod will not let me to got in the Yuemeng directory. after trying three times, It give me “401 – Unauthorized”

I could not figure out what is wrong.

I do not know my server has SSL support or not, Do I need SSL to make it wroks?

Thanks.

Reply

41 nixCraft January 6, 2010 at 7:59 am

Check error log and the following debug options and restart lighttpd:
auth.debug = 2
Take a look at your error.log for detailed info.

Reply

42 Charlie January 6, 2010 at 5:38 pm

Thanks, Vivek.
I looked the error.log file. The message are password mismatch. I figured out that the problem is with password file “.pwd_Yuemeng”. One user without line feed at the end of line will make it work. However, for two users “user=TEST|user=TEST2″, The password file have two lines, the first line with line feed, the second line without line feed. The first user cannot login, but second folder can login. Do you have any idea to deal with the line feed issue? Can some other symbol to put at the end of line to make it works?

Reply

43 Lopes March 1, 2010 at 10:33 pm

Thanks Vivek!

Just a question how can I protect two folders? Using same user and password?

Reply

44 lopes March 1, 2010 at 10:44 pm

Hi!

How I can use the same password and user for two folder? How I can setup this?

Many thanks

Reply

45 Tapas Mallick March 29, 2010 at 9:53 am

I believe there should have a post on “Access restriction based on IP/Subnet Address” (like: order allow, deny; allow from 192.168.1.0/24; deny from all; directives normally used in apache)

Reply

46 mahal24 April 15, 2010 at 6:02 am

Can somebody please tell me if Lighttpd supports “GROUP” authentication and if it does how do you configure it? Thanks in advance!

Reply

47 Chalai April 30, 2010 at 1:10 am

Hi!
How to restrict access to a folder/subfolder only?
Using Apache I can restrict user access to a folder/subfolder only by setting a value for open_basedir and include_path, how do I do that with Lighttpd?

Reply

48 kurt krueckeberg April 5, 2011 at 2:20 pm

Great article. The most helpful one I’ve found.

Reply

49 przemek June 16, 2011 at 7:22 am

what is domain name? i got index.php as my website in ww folder and how i do domain name?

Reply

50 michiel December 8, 2011 at 12:40 pm

Hi,

I got plain authorization working, but it seems there is a very long timeout before you have to enter login&password again. Is there a way to set it to about 30 minutes or so?

Reply

51 shahzaib June 23, 2012 at 10:50 am

does lighttpd supports subdirectories for secure streaming?

Reply

52 Nypias August 18, 2012 at 9:59 pm

Thanks a lot for this explanation ;D

Reply

53 barul January 13, 2014 at 11:59 am

Thanks a lot for this post! It still works today without any settings change.

Reply

54 kulland March 30, 2014 at 12:49 am

How would i set it to ask to the user/pass every time from the same computer or session?

Reply

Leave a Comment

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

Previous post:

Next post: