[[PageOutline(2-5,Contents,pullout)]]

= Force HTTP authentication from within Trac

== Description

This plugin allows you to protect certain paths with HTTP authentication. The AccountManagerPlugin is used to check passwords.

Primarily this is meant to be used with the XmlRpcPlugin, so it will work while using !AccountManager's form-based logins.

== Bugs/Feature Requests

Existing bugs and feature requests for HttpAuthPlugin are 
[report:9?COMPONENT=HttpAuthPlugin here].

If you have any issues, create a 
[/newticket?component=HttpAuthPlugin new ticket].

[[TicketQuery(component=HttpAuthPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:httpauthplugin here].

There is also a version on [pypi:TracHTTPAuth PyPi].

== Source

You can check out HttpAuthPlugin from [/svn/httpauthplugin here] using Subversion, or [source:httpauthplugin browse the source] with Trac.
The 0.10 version also works with Trac 0.11.2.1 release, at least with mod_python. 

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

To enable the plugin:
{{{#!ini
[components]
httpauth.* = enabled
}}}

== Configuration

The following are configuration examples for usage of this plugin, by making the indicated changes to your `trac.ini` file.
 
To add additional paths:
{{{#!ini
[httpauth]
paths = /xmlrpc, /login/xmlrpc
}}}

To add additional formats, such as RSS:
{{{#!ini
[httpauth]
formats = rss
}}}

== Troubleshooting

=== Authentication issues while using Trac with mod_wsgi

==== Symptom

HTTP authentication just does not want to work. The Authorization header is passed with the HTTP request, but it seems to be lost on the way.

If you set the `loglevel` to `INFO`, then you will get this entry in your `trac.log`:

{{{
Trac[filter] INFO: HTTPAuthFilter: No/bad authentication data given, returing 403
}}}

See ticket #1169.

==== Cause

If you're using `mod_wsgi`, authorization information is stripped before passing to the WSGI application.

==== Solution

Turn `WSGIPassAuthorization On` in your `Apache` configuration for it to work.

See also [http://code.google.com/p/modwsgi/wiki/ConfigurationDirectives ConfigurationDirectives].

== Recent Changes

[[ChangeLog(httpauthplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:coderanger] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:''' pacopablo