Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update README. #27

Merged
merged 3 commits into from
Jan 26, 2015
Merged

update README. #27

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
387ca3f
update README.
Nov 23, 2014
115de46
Merge remote-tracking branch 'upstream/master' into update_readme
Dec 4, 2014
299b483
Merge remote-tracking branch 'upstream/master' into update_readme
Jan 4, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,17 @@ Configuration details:
is valid. There are plans to bring in implicit flow and hybrid flow at some
point, but it hasn't come up yet for me. Those flows aren't best practive for
server side web apps anyway and are designed more for native/mobile apps.
* If you want to pass `state` paramete by yourself. You can set Proc Object.
e.g. `state: Proc.new{ SecureRandom.hex(32) }`
* `nonce` is optional. If don't want to pass "nonce" parameter to provider, You should specify
`false` to `send_nonce` option. (default true)
* Support for other client authentication methods. If don't specified
`:client_auth_method` option, automatically set `:basic`.
* Use "OpenID Connect Discovery", You should specify `true` to `discovery` option. (default false)
* In "OpenID Connect Discovery", generally provider should have Webfinger endpoint.
If provider does not have Webfinger endpoint, You can specify "Issuer" to option.
e.g. `issuer: "myprovider.com"`
It means to get configuration from "https://myprovider.com/.well-known/openid-configuration".

For the full low down on OpenID Connect, please check out
[the spec](http://openid.net/specs/openid-connect-core-1_0.html).
Expand Down