= `CoSign` single sign-on integration for Trac =

== Description ==

This plugin is inspired from TracCasPlugin and AccountLdapPlugin.  
Adapt to use `CoSign single sign-on`__ as the authentication back-end.

__ http://weblogin.org/


== Bugs/Feature Requests == 

Existing bugs and feature requests for TracCoSignPlugin are 
[query:component=TracCoSignPlugin&group=status&order=priority here (include Closed)].

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=TracCoSignPlugin&owner=jiangxin new ticket].

== Download ==

Download the zipped source from [download:traccosignplugin here].

== Source ==

You can check out TracCoSignPlugin from [http://trac-hacks.org/svn/traccosignplugin here] using Subversion, or [source:traccosignplugin browse the source] with Trac.


== Usage ==
=== Enable the plugin ===
To enable the whole plugin:
{{{
[components]
traccosign.* = enabled
trac.web.auth.LoginModule = disabled
}}}

or enable parts of `TracCoSign` plugin:
{{{
[components]
traccosign.login.* = enabled
traccosign.accountldap.* = enabled
trac.web.auth.LoginModule = disabled
}}}


'''note''': Even if installing locally, you must disable the default `LoginModule`.

=== traccosign.login configuration ===
Configurations of traccosign.login are defined in the [cosign] section.

Options in the ``[cosign]`` section:
 * '''cosign_service''':
    Defaults to ``trac``.
 * '''cosign_login_uri''':
    **Requried**. Example ``https://weblogin.your.domain/cgi-bin/login``.
 * '''cosign_logout_uri''':
    **Requried**. Example ``https://weblogin.your.domain/cgi-bin/logout``.

=== traccosign.accountldap configuration ===
Configurations of traccosign.accountldap are defined in the [ldap] section.

Check AccountLdapPlugin for reference.

=== Example ===
An example configuration:
{{{
[components]
traccosign.* = enabled
trac.web.auth.LoginModule = disabled

[cosign]
cosign_service = trac
cosign_login_uri = https://weblogin.localdomain//cgi-bin/login
cosign_logout_uri = https://weblogin.localdomain//cgi-bin/logout

[ldap]
ldap_uri = ldap://localhost:389
bind_user = cn=ldapadmin,dc=foo,dc=bar
bind_passwd = secret
basedn = dc=foo,dc=bar
user_rdn =
attempts = 1
user_filter = uid
}}}

== Recent Changes ==

[[ChangeLog(traccosignplugin, 3)]]

== Author/Contributors ==

'''Author:''' [wiki:jiangxin] [[BR]]
'''Contributors:'''