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

= !CoSign single sign-on integration for Trac

== Description

This plugin is inspired by TracCasPlugin and AccountLdapPlugin, adapted to use [http://weblogin.org/ CoSign single sign-on] as the authentication back-end. !CoSign is an open-source, secure, single sign-on web authentication system.

== Bugs/Feature Requests

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

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

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

== Download

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

== Source

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

== Installation

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

To enable the whole plugin, add the following to your `trac.ini` file:
{{{#!ini
[components]
traccosign.* = enabled
trac.web.auth.LoginModule = disabled
}}}

or enable parts of the plugin:
{{{#!ini
[components]
traccosign.login.* = enabled
traccosign.accountldap.* = enabled
trac.web.auth.LoginModule = disabled
}}}

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

== Configuration

Configurations of '''traccosign.login''' are defined in the `[cosign]` section of your `trac.ini` file.

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

Configurations of '''traccosign.accountldap''' are defined in the `[ldap]` section of your `trac.ini` file. Check AccountLdapPlugin for reference.

An example configuration:
{{{#!ini
[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]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''