Skip to content

Added instructions on how to generate PEM keypair, needed by JWT authentication #2812

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

Open
wants to merge 1 commit into
base: 4.6
Choose a base branch
from
Open

Added instructions on how to generate PEM keypair, needed by JWT authentication #2812

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions docs/infrastructure_and_maintenance/security/development_security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,3 +145,18 @@
entry_point: lexik_jwt_authentication.jwt_token_authenticator
stateless: true
```

In order for the application to be able to generate JWT tokens, a [PEM encoded keyset needs to be generated](https://symfony.com/bundles/LexikJWTAuthenticationBundle/current/index.html#generate-the-ssl-keys) using the command:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In order for the application to be able to generate JWT tokens, a [PEM encoded keyset needs to be generated](https://symfony.com/bundles/LexikJWTAuthenticationBundle/current/index.html#generate-the-ssl-keys) using the command:
Finish the setup by generating a [PEM encoded key pair](https://symfony.com/bundles/LexikJWTAuthenticationBundle/2.x/index.html#generate-the-ssl-keys) by using the command:
  1. I'd use key pair consistently, imho no need to introduce "keyset" kere
  2. Let's use the 2.x link for the 4.6 version (I will change it when upmerging)


```bash
php bin/console lexik:jwt:generate-keypair
```

The generated key pair will be stored in `config/jwt`

Check warning on line 155 in docs/infrastructure_and_maintenance/security/development_security.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/infrastructure_and_maintenance/security/development_security.md#L155 

[Ibexa.FutureTense] Use present tense instead of future.
Raw output 
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/infrastructure_and_maintenance/security/development_security.md", "range": {"start": {"line": 155, "column": 24}}}, "severity": "WARNING"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The generated key pair will be stored in `config/jwt`
The generated key pair will be stored in the `config/jwt`directory.


!!! note "[[= product_name_cloud =]]"

In order to be able to store generate and store the tokens on [[= product_name_cloud =]], you must define `config/jwt`
as a volume in `.platform.app.yaml`. If you have a 3-node-cluster setup, you must ensure the key pair is the same on all
3 servers. Either use a network share for this, or use local mount manually copy the same keu pair
to all servers
Comment on lines +159 to +162
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In order to be able to store generate and store the tokens on [[= product_name_cloud =]], you must define `config/jwt`
as a volume in `.platform.app.yaml`. If you have a 3-node-cluster setup, you must ensure the key pair is the same on all
3 servers. Either use a network share for this, or use local mount manually copy the same keu pair
to all servers
To generate and store the tokens on [[= product_name_cloud =]], define the `config/jwt` directory as a volume in the `.platform.app.yaml` file.
In 3-node cluster setups, ensure that the key pair is the same on all 3 servers.
You can use a network share, or use a local mount and manually copy the key pair between the servers.

Loading