Skip to content

Commit

Permalink
Merge pull request #27 from hiyosi/update_readme
Browse files Browse the repository at this point in the history
update README.
  • Loading branch information
jjbohn committed Jan 26, 2015
2 parents 77cf08d + 299b483 commit 136d37c
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
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

0 comments on commit 136d37c

Please sign in to comment.