-
Notifications
You must be signed in to change notification settings - Fork 0
π [Docs]: README pages now use the standard module landing-page format #32
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
Open
Marius Storhaug (MariusStorhaug)
wants to merge
3
commits into
main
Choose a base branch
from
docs/standardize-readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,46 @@ | ||
| # Jwt | ||
|
|
||
| `Jwt` is a PowerShell module for creating and verifying JSON Web Tokens. This repository maintains the current `Jwt` module command surface under PSModule maintenance so existing users can continue to install and use the package from PowerShell Gallery. | ||
| Jwt is a PowerShell module for creating, decoding, and verifying JSON Web Tokens (JWTs). It supports HS256 | ||
| shared-secret tokens, RS256 certificate-signed tokens, and the `none` algorithm. | ||
|
Comment on lines
+3
to
+4
|
||
|
|
||
| > [!WARNING] | ||
| > The `none` algorithm produces an unsigned token whose integrity cannot be verified. Avoid it for | ||
| > authentication or authorization; use HS256 or RS256 for any token that must be trusted. | ||
|
|
||
| ## Installation | ||
|
|
||
| Install the module from the PowerShell Gallery: | ||
|
|
||
| ```powershell | ||
| Install-PSResource -Name Jwt | ||
| Import-Module -Name Jwt | ||
| ``` | ||
|
|
||
| ## Commands | ||
|
|
||
| The maintained module exports the same JWT commands and alias used by the current package: | ||
|
|
||
| ```powershell | ||
| ConvertFrom-Base64UrlString | ||
| ConvertTo-Base64UrlString | ||
| Get-JwtHeader | ||
| Get-JwtPayload | ||
| New-Jwt | ||
| Test-Jwt | ||
| Verify-JwtSignature | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Create and validate an HMAC-signed JWT: | ||
| ### Example: Create and validate an HMAC-signed token | ||
|
|
||
| ```powershell | ||
| $header = '{"alg":"HS256","typ":"JWT"}' | ||
| $payload = '{"sub":"1234567890","name":"John Doe","admin":true,"iat":1516239022}' | ||
| $secret = 'a-string-secret-at-least-256-bits-long' | ||
|
|
||
| $jwt = New-Jwt -Header $header -PayloadJson $payload -Secret $secret | ||
| Test-Jwt -jwt $jwt -Secret $secret | ||
| $jwt = New-Jwt -Header '{"alg":"HS256","typ":"JWT"}' -PayloadJson $payload -Secret $secret | ||
| $jwt | Test-Jwt -Secret $secret | ||
| ``` | ||
|
|
||
| Read the header and payload from an existing token: | ||
| ### Example: Decode the payload of an existing token | ||
|
|
||
| ```powershell | ||
| Get-JwtHeader -jwt $jwt | ||
| Get-JwtPayload -jwt $jwt | ||
| $jwt | Get-JwtPayload | ||
|
|
||
| ``` | ||
|
|
||
| For more information about each command, use PowerShell help: | ||
| ## Documentation | ||
|
|
||
| Documentation is published at [psmodule.io/Jwt](https://psmodule.io/Jwt/). | ||
|
|
||
| Use PowerShell help and command discovery for module details: | ||
|
|
||
| ```powershell | ||
| Get-Command -Module Jwt | ||
| Get-Help New-Jwt -Full | ||
| Get-Help -Name New-Jwt -Examples | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| Coder or not, you can contribute to the project! We welcome all contributions. | ||
|
|
||
| ### For Users | ||
|
|
||
| If you don't code, you still sit on valuable information that can make this project even better. If you experience that the | ||
| product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests. | ||
| Please see the issues tab on this project and submit a new issue that matches your needs. | ||
|
|
||
| ### For Developers | ||
|
|
||
| If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information. | ||
| You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement. | ||
|
|
||
| ## Acknowledgements | ||
|
|
||
| Here is a list of people and projects that helped this project in some way. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.