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.

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

Fix simple typos and expand on a JWT example. #277

Merged
merged 2 commits into from
Sep 13, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion app/plugins/bot-detection.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ nav:
- label: Default rules
---

Protects your API from the most commong bots, with the possibility of whitelisting and blacklisting custom clients.
Protects your API from most common bots and has the capability of whitelisting and blacklisting custom clients.

----

Expand Down
4 changes: 2 additions & 2 deletions app/plugins/jwt.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,15 +118,15 @@ First, the header must be:
}
```

Secondly, the claims **must** contain the secret's `key` in the configured claim (from `config.key_claim_name`). That claim is `iss` (issuer field field) by default. Set its value to our previously created credential's `key`. The claims may contain other values.
Secondly, the claims **must** contain the secret's `key` in the configured claim (from `config.key_claim_name`). That claim is `iss` (issuer field) by default. Set its value to our previously created credential's `key`. The claims may contain other values.

```json
{
"iss": "a36c3049b36249a3c9f8891cb127243c"
}
```

Since the `secret` associated with this `key` is `e71829c351aa4242c2719cbfbe671c09`, the final JWT is:
Using the JWT debugger at https://jwt.io with the header (HS256), claims (iss, etc), and `secret` associated with this `key` (e71829c351aa4242c2719cbfbe671c09), you'll end up with a JWT token of:

```
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJhMzZjMzA0OWIzNjI0OWEzYzlmODg5MWNiMTI3MjQzYyIsImV4cCI6MTQ0MjQzMDA1NCwibmJmIjoxNDQyNDI2NDU0LCJpYXQiOjE0NDI0MjY0NTR9.AhumfY35GFLuEEjrOXiaADo7Ae6gt_8VLwX7qffhQN4
Expand Down
2 changes: 1 addition & 1 deletion app/plugins/key-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ form parameter | default | description
`key`<br>*optional* | | You can optionally set your own unique `key` to authenticate the client. If missing, the plugin will generate one.

<div class="alert alert-warning">
<strong>Note:</strong> It is recommended to let Kong auto-generate the key. Only specify it yourself if you are migrating an existing system to Kong, and must re-use your keys to make the migration to Kong transparent to your consumers.
<strong>Note:</strong> It is recommended to let Kong auto-generate the key. Only specify it yourself if you are migrating an existing system to Kong. You must re-use your keys to make the migration to Kong transparent to your Consumers.
</div>

### Using the API Key
Expand Down