Skip to content

Commit 296ebc3

Browse files
committed
Minor adjustments to fix links and build warnings
1 parent cea7bf4 commit 296ebc3

File tree

7 files changed

+8849
-9
lines changed

7 files changed

+8849
-9
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<a href="https://formidable.com/open-source/" target="_blank">
2-
<img alt="React Native App Auth — Formidable, We build the modern web" src="https://raw.githubusercontent.com/FormidableLabs/react-native-app-auth/main/react-native-app-auth-Hero.png" />
2+
<img alt="React Native App Auth — Formidable, We build the modern web" src="https://oss.nearform.com/api/banner?text=react+native+app+auth" />
33
</a>
44
<p align="center">
55
<strong>React native bridge for AppAuth - an SDK for communicating with OAuth2 providers</strong>
@@ -123,7 +123,7 @@ with optional overrides.
123123
- **registrationEndpoint** - (`string`) fully formed url to your OAuth/OpenID Connect registration endpoint. Only necessary for servers that require client registration.
124124
- **endSessionEndpoint** - (`string`) fully formed url to your OpenID Connect end session endpoint. If you want to be able to end a user's session and no `issuer` is specified, this field is mandatory.
125125
- **clientId** - (`string`) _REQUIRED_ your client id on the auth server
126-
- **clientSecret** - (`string`) client secret to pass to token exchange requests. :warning: Read more about [client secrets](#note-about-client-secrets)
126+
- **clientSecret** - (`string`) client secret to pass to token exchange requests. :warning: Read more about [client secrets](/docs/client-secrets)
127127
- **redirectUrl** - (`string`) _REQUIRED_ the url that links back to your app with the auth code
128128
- **scopes** - (`array<string>`) the scopes for your token, e.g. `['email', 'offline_access']`.
129129
- **additionalParameters** - (`object`) additional parameters that will be passed in the authorization request.
@@ -547,6 +547,6 @@ Please see our [contributing guide](./.github/CONTRIBUTING.md).
547547
548548
## Maintenance Status
549549
550-
**Active:** Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.
550+
**Active:** Nearform is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.
551551
552552
[maintenance-image]: https://img.shields.io/badge/maintenance-active-green.svg

docs/docs/client-secrets.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Client Secrets
6+
7+
Some authentication providers, including examples cited below, require you to provide a client secret. The authors of the AppAuth library
8+
9+
> [strongly recommend](https://github.com/openid/AppAuth-Android#utilizing-client-secrets-dangerous) you avoid using static client secrets in your native applications whenever possible. Client secrets derived via a dynamic client registration are safe to use, but static client secrets can be easily extracted from your apps and allow others to impersonate your app and steal user data. If client secrets must be used by the OAuth2 provider you are integrating with, we strongly recommend performing the code exchange step on your backend, where the client secret can be kept hidden.
10+
11+
Having said this, in some cases using client secrets is unavoidable. In these cases, a `clientSecret` parameter can be provided to `authorize`/`refresh` calls when performing a token request.

docs/docs/config-examples/dropbox.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Dropbox provides an OAuth 2.0 endpoint for logging in with a Dropbox user's cred
55
Please note:
66

77
- Dropbox does not provide a OIDC discovery endpoint, so `serviceConfiguration` is used instead.
8-
- Dropbox OAuth requires a [client secret](#note-about-client-secrets).
8+
- Dropbox OAuth requires a [client secret](/docs/client-secrets).
99
- Dropbox access tokens are short lived and will expire after a short period of time. To update your access token a separate call needs to be made to [/oauth2/token](https://www.dropbox.com/developers/documentation/http/documentation#oauth2-token) to obtain a new access token.
1010

1111
```js

docs/docs/config-examples/fitbit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Fitbit provides an OAuth 2.0 endpoint for logging in with a Fitbit user's creden
55
Please note:
66

77
- Fitbit does not provide a OIDC discovery endpoint, so `serviceConfiguration` is used instead.
8-
- Fitbit OAuth requires a [client secret](#note-about-client-secrets).
8+
- Fitbit OAuth requires a [client secret](/docs/client-secrets).
99

1010
```js
1111
const config = {

docs/docs/config-examples/uber.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Uber provides an OAuth 2.0 endpoint for logging in with a Uber user's credential
55
Please note:
66

77
- Uber does not provide a OIDC discovery endpoint, so `serviceConfiguration` is used instead.
8-
- Uber OAuth requires a [client secret](#note-about-client-secrets).
8+
- Uber OAuth requires a [client secret](/docs/client-secrets).
99

1010
```js
1111
const config = {

docs/docusaurus.config.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const config: Config = {
66
tagline: 'React native bridge for AppAuth - an SDK for communicating with OAuth2 providers.',
77
favicon: 'img/nearform-icon.svg',
88
url: 'https://commerce.nearform.com/',
9-
baseUrl: '/open-source/react-native-app-auth/',
9+
baseUrl: '/open-source/react-native-app-auth',
1010
onBrokenLinks: 'throw',
1111
onBrokenMarkdownLinks: 'warn',
1212
i18n: {
@@ -20,9 +20,7 @@ const config: Config = {
2020
{
2121
docs: {
2222
sidebarPath: './sidebars.ts',
23-
editUrl: 'https://github.com/FormidableLabs/react-native-app-auth/tree/main',
2423
},
25-
blog: false,
2624
theme: {
2725
customCss: './src/css/custom.css',
2826
},
@@ -35,6 +33,7 @@ const config: Config = {
3533
/** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
3634
{
3735
hashed: true,
36+
indexBlog: false,
3837
},
3938
],
4039
],

0 commit comments

Comments
 (0)