Browse files

Described functionality of AuthOpenIDSingleIdP, AuthOpenIDAXRequire, …

…AuthOpenIDAXUsername, AuthOpenIDSecureCookie
  • Loading branch information...
SteelPangolin committed Apr 21, 2012
1 parent 9abe720 commit f414d320cd6f40c83d4dcadfc0394dc21c03d63f
Showing with 51 additions and 2 deletions.
  1. +51 −2 README.markdown
@@ -29,8 +29,8 @@ privieges on (see the docs for the AuthOpenIDDBLocation directive on the homepag
# Usage
In either a Directory, Location, or File directive in httpd.conf, place the following directive:
AuthType OpenID
requre valid-user
AuthType OpenID
Require valid-user
There are also additional, optional directives. See the homepage for a list and docs.
@@ -39,3 +39,52 @@ authentication.
See [the project page]( for more information.
# New features in this fork
I wanted to make mod_auth_openid more useful to sites using
[Google Apps OpenID](
## AuthOpenIDSingleIdP
In general, OpenID users can directly enter the identity they want to claim, or they can enter the identity
of their provider, and then the provider can show some UI for choosing an identity to claim. If your site
only allows a single provider, as will be the case if you're using Google's OpenID for authenticating users to
internal sites, use the `AuthOpenIDSingleIdP <provider URL>` directive to preset it and mod_auth_openid will skip
the login form entirely. Your users won't need to remember Google's OpenID provider identity, and they'll have
less clicking to do.
AuthOpenIDSingleIdP # use Google's OpenID
## AuthOpenIDAXRequire
When you claim an OpenID through Google's IdP, the returned OpenID looks like
``, which doesn't tell you
which Google Apps domain they logged in from. If you want to find out who a user is for authorization purposes,
you need to use the [Attribute Exchange (AX) extension to OpenID](
to ask the IdP for something you can check against. In the case of Google Apps, you can get their Apps username and
domain by requesting their email address. The `AuthOpenIDAXRequire <alias> <URI> <regex>` lets you require
[some attributes identified by URIs](
to be returned with an OpenID response, and then validate the returned attribute against a regex. If the attribute
isn't returned with the response, or if it doesn't match the regex, validation fails. You can have more than one
`AuthOpenIDAXRequire` directive; all must pass for successful authentication.
AuthOpenIDAXRequire email @example\.com$ # users from Apps domain only
## AuthOpenIDAXUsername
As noted above, OpenIDs are not required to be pretty or even readable. You can use `AuthOpenIDAXUsername <alias>`
to set Apache's `REMOTE_USER` variable to the AX attribute with that alias. This is what shows up in log files,
and it's also accessible to whatever application you're wrapping with OpenID authentication.
AuthOpenIDAXUsername email # username is email address
## AuthOpenIDSecureCookie
`AuthOpenIDSecureCookie <On|Off>` controls whether the `Secure` attribute is set on your session cookies. If you're not using
HTTPS for protecting authentication information in transit (ideally for *everything*), you're doing it wrong, so I was tempted
to make this feature always on. However, sometimes I'm too lazy to set up SSL/TLS on local-only development boxes.
AuthOpenIDSecureCookie On # always for production sites!
## HttpOnly attribute set on session cookies
[There is no reason that your session cookie should be accessible from JavaScript.](
`HttpOnly` is now always set on your session cookies.

0 comments on commit f414d32

Please sign in to comment.