11# OpenID Connect Relying Party _ (oidc-rp)_
22
3- [ ![ standard-readme compliant] ( https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square )] ( https://github.com/RichardLitt/standard-readme )
3+ [ ![ ] ( https://img.shields.io/badge/project-Solid-7C4DFF.svg?style=flat-square )] ( https://github.com/solid/solid )
4+ [ ![ Build Status] ( https://travis-ci.org/solid/oidc-rp.svg?branch=master&style=flat-square )] ( https://travis-ci.org/solid/oidc-rp )
5+ [ ![ npm version] ( https://badge.fury.io/js/%40solid%2Foidc-rp.svg )] ( https://badge.fury.io/js/%40solid%2Foidc-rp )
46
57> OpenID Connect Relying Party for Node.js and the browser.
68
1214- [ ] Key rotation using JWK ` kid ` value
1315- [ ] Session management
1416- [ ] front- and back-channel logout
15- - [ ] Request parameters as JWT
17+ - [X ] Request parameters as JWT
1618- [ ] Claims request parameter
1719- [ ] Claims language tags
18- - [ ] ACDC and Proof of Possession
1920- [ ] OAuth 2.0 Bearer Token requests
2021
2122## Table of Contents
2728 * [ Node.js] ( #nodejs )
2829 * [ Browser] ( #browser )
2930* [ Develop] ( #develop )
30- * [ API] ( #api )
3131* [ Maintainers] ( #maintainers )
3232* [ Contribute] ( #contribute )
3333* [ MIT License] ( #mit-license )
@@ -72,6 +72,20 @@ $ npm install
7272
7373### Build
7474
75+ ** Important:**
76+ If you're using this library as a dependency and you plan to use Webpack, don't
77+ forget to add the following lines to your ` webpack.config.js ` ` externals: `
78+ section:
79+
80+ ``` js
81+ externals: {
82+ ' node-fetch' : ' fetch' ,
83+ ' @sinonjs/text-encoding' : ' TextEncoder' ,
84+ ' whatwg-url' : ' window' ,
85+ ' isomorphic-webcrypto' : ' crypto'
86+ }
87+ ```
88+
7589To build a Webpack-generated bundle:
7690
7791``` bash
@@ -81,69 +95,24 @@ npm run dist
8195### Test
8296
8397``` bash
84- $ npm test // Node.js
85- $ npm run karma // Karma (browser)
98+ npm test
8699```
87100
88- ## API
89-
90- ...
91-
92101## Maintainers
93102
94- ...
103+ * Dmitri Zagidulin
95104
96105## Contribute
97106
98- ### Issues
99-
100- * please file [ issues] ( https://github.com/solid/oidc-rp/issues ) :)
101- * for bug reports, include relevant details such as platform, version, relevant data, and stack traces
102- * be sure to check for existing issues before opening new ones
103- * read the documentation before asking questions
104- * it's strongly recommended to open an issue before hacking and submitting a PR
105- * we reserve the right to close an issue for excessive bikeshedding
106-
107- ### Pull requests
108-
109- #### Policy
110-
111- * we're not presently accepting * unsolicited* pull requests
112- * create an issue to discuss proposed features before submitting a pull request
113- * create an issue to propose changes of code style or introduce new tooling
114- * ensure your work is harmonious with the overall direction of the project
115- * ensure your work does not duplicate existing effort
116- * keep the scope compact; avoid PRs with more than one feature or fix
117- * code review with maintainers is required before any merging of pull requests
118- * new code must respect the style guide and overall architecture of the project
119- * be prepared to defend your work
120-
121107#### Style guide
122108
123109* ES6
124110* Standard JavaScript
125111* jsdocs
126112
127- #### Code reviews
128-
129- * required before merging PRs
130- * reviewers SHOULD run the code under review
131-
132- ### Collaborating
133-
134- #### Weekly project meeting
135-
136- * Thursdays from 1:00 PM to 2:00 Eastern US time at [ TBD]
137- * Join remotely with Google Hangouts
138-
139- #### Pair programming
140-
141- * Required for new contributors
142- * Work directly with one or more members of the core development team
143-
144113### Code of conduct
145114
146- * @trust /oidc-rp follows the [ Contributor Covenant] ( http://contributor-covenant.org/version/1/3/0/ ) Code of Conduct.
115+ * @solid /oidc-rp follows the [ Contributor Covenant] ( http://contributor-covenant.org/version/1/3/0/ ) Code of Conduct.
147116
148117### Contributors
149118
@@ -152,4 +121,7 @@ $ npm run karma // Karma (browser)
152121
153122## MIT License
154123
124+ [ The MIT License] ( LICENSE.md )
125+
155126Copyright (c) 2016 Anvil Research, Inc.
127+ Copyright (c) 2017-2019 The Solid Project
0 commit comments