Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Python3 http.server supporting basic HTTP Auth (username/password)
# Extended python -m http.serve with --username and --password parameters for
# basic auth, based on https://gist.github.com/fxsjy/5465353
from functools import partial
from http.server import SimpleHTTPRequestHandler, test
import base64
import os
class AuthHTTPRequestHandler(SimpleHTTPRequestHandler):
""" Main class to present webpages and authentication. """
def __init__(self, *args, **kwargs):
username = kwargs.pop("username")
password = kwargs.pop("password")
self._auth = base64.b64encode(f"{username}:{password}".encode()).decode()
super().__init__(*args, **kwargs)
def do_HEAD(self):
self.send_response(200)
self.send_header("Content-type", "text/html")
self.end_headers()
def do_AUTHHEAD(self):
self.send_response(401)
self.send_header("WWW-Authenticate", 'Basic realm="Test"')
self.send_header("Content-type", "text/html")
self.end_headers()
def do_GET(self):
""" Present frontpage with user authentication. """
if self.headers.get("Authorization") == None:
self.do_AUTHHEAD()
self.wfile.write(b"no auth header received")
elif self.headers.get("Authorization") == "Basic " + self._auth:
SimpleHTTPRequestHandler.do_GET(self)
else:
self.do_AUTHHEAD()
self.wfile.write(self.headers.get("Authorization").encode())
self.wfile.write(b"not authenticated")
if __name__ == "__main__":
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--cgi", action="store_true", help="Run as CGI Server")
parser.add_argument(
"--bind",
"-b",
metavar="ADDRESS",
default="127.0.0.1",
help="Specify alternate bind address " "[default: all interfaces]",
)
parser.add_argument(
"--directory",
"-d",
default=os.getcwd(),
help="Specify alternative directory " "[default:current directory]",
)
parser.add_argument(
"port",
action="store",
default=8000,
type=int,
nargs="?",
help="Specify alternate port [default: 8000]",
)
parser.add_argument("--username", "-u", metavar="USERNAME")
parser.add_argument("--password", "-p", metavar="PASSWORD")
args = parser.parse_args()
handler_class = partial(
AuthHTTPRequestHandler,
username=args.username,
password=args.password,
directory=args.directory,
)
test(HandlerClass=handler_class, port=args.port, bind=args.bind)
@nguyencanhlich
Copy link

nguyencanhlich commented Nov 21, 2019

I don't know how to log in. Please help me. Thanks you pro!

@Madave94
Copy link

Madave94 commented Jan 22, 2020

I had to change line 17 from super().__init__(*args, **kwargs) to super().__init__(*args) otherwise i received an error that the parent class got some invalid arguments. Can you confirm that or tell me why i got that error?

@lionelyoung
Copy link

lionelyoung commented Feb 9, 2020

I don't know how to log in. Please help me. Thanks you pro!

  1. Run python -m http_server_auth -u USERNAME -p PASSWORD -d .
  2. Open your browser, and go to http://localhost:8000

@lionelyoung
Copy link

lionelyoung commented Feb 9, 2020

I had to change line 17 from super().__init__(*args, **kwargs) to super().__init__(*args) otherwise i received an error that the parent class got some invalid arguments. Can you confirm that or tell me why i got that error?

Yes, same here. Works if you remove it, I went ahead and did that and put it into this gist: https://gist.github.com/lionelyoung/8cad668d4d30fa392842fa08d50d2bc6

@yoyoslim
Copy link

yoyoslim commented Apr 8, 2020

The -d or --directory argument does not seem to work. I have tried both and upon logging in, I am always in my current working directory. I cannot seem to find the issue. Has anyone else had this issue. I am using python version 3.8.

@jenciso
Copy link

jenciso commented Apr 14, 2020

I had to change line 17 from super().__init__(*args, **kwargs) to super().__init__(*args) otherwise i received an error that the parent class got some invalid arguments. Can you confirm that or tell me why i got that error?

Yes, same here. Works if you remove it, I went ahead and did that and put it into this gist: https://gist.github.com/lionelyoung/8cad668d4d30fa392842fa08d50d2bc6

Thanks

@Christoph460
Copy link

Christoph460 commented Aug 7, 2020

@kcraft09 Setting the directory via the command line was also not working for me. I fixed it with the change of the first lines to
`

def init(self, *args, **kwargs):
username = kwargs.pop("username")
password = kwargs.pop("password")
directory = kwargs.pop("directory")

 self._auth = base64.b64encode(f"{username}:{password}".encode()).decode()
 super().__init__(*args, directory=directory)

`

@Last-Arkhangel
Copy link

Last-Arkhangel commented Aug 17, 2020

Good day, everyone. Please tell me how to screw ssl (https) here. Thank.

@ebrahimiali
Copy link

ebrahimiali commented Dec 8, 2020

Is it possible to support POST in this server too?

@thevickypedia
Copy link

thevickypedia commented Jul 4, 2021

Is there a way I can have this script do a timeout or close the connection?
I basically need a re-auth after a set timeout or a logout button which can terminate the session.

@mauler
Copy link
Author

mauler commented Jul 7, 2021

@thevickypedia
Copy link

thevickypedia commented Jul 8, 2021

I think u can set something on the do_GET method. First add this to init self.timeouts = {} and on do_GET always record the first time someone (use remote address) send the Authentication header on the request (a valid one). So if it is expired, try to enforce the auth using do_AUTHHEAD Em seg., 5 de jul. de 2021 às 00:17, Vignesh Rao @.> escreveu:

@.
* commented on this gist. ------------------------------ Is there a way I can have this script do a timeout or close the connection? I basically need a re-auth after a set timeout or a logout button which can terminate the session. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://gist.github.com/593caee043f5fe4623732b4db5145a82#gistcomment-3802275, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABZLZQVQUU3QYCKECEF4LTTWDFWBANCNFSM4JP3SNPA .

Thanks for the response, I think I figured my way out.
I'm setting the Authorization header to None at the first visit and also at given intervals so the remaining code keeps flowing.

self.headers.replace_header('Authorization', None)

@nikodemusk
Copy link

nikodemusk commented Jul 5, 2022

Really useful, thank you. I use it instead of password protect a directory with Nginx for a service.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment