Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matteobaccan/harbourjwt
JWT Implementation for Harbour
https://github.com/matteobaccan/harbourjwt
hacktoberfest harbour harbour-language jwt
Last synced: about 2 months ago
JSON representation
JWT Implementation for Harbour
- Host: GitHub
- URL: https://github.com/matteobaccan/harbourjwt
- Owner: matteobaccan
- License: gpl-3.0
- Created: 2022-03-08T12:38:15.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-25T16:08:45.000Z (9 months ago)
- Last Synced: 2024-05-07T18:17:47.619Z (8 months ago)
- Topics: hacktoberfest, harbour, harbour-language, jwt
- Language: xBase
- Homepage:
- Size: 93.8 KB
- Stars: 4
- Watchers: 4
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# HarbourJwt
[](https://www.codacy.com/gh/matteobaccan/HarbourJwt/dashboard?utm_source=github.com&utm_medium=referral&utm_content=matteobaccan/HarbourJwt&utm_campaign=Badge_Grade)
JWT Implementation for Harbour
A simple library to work with JSON Web Token and JSON Web Signature for Harbour language.
You can find more information about JWT on the [official website](https://jwt.io).
Harbour JWT supports the following algorithms:
- HS256
- HS384
- HS512
## Installation
Package is available on [GitHub](https://github.com/matteobaccan/HarbourJwt/blob/main/lib/jwt.hrb),
```shell
wget https://raw.githubusercontent.com/matteobaccan/HarbourJwt/main/lib/jwt.hrb
```
## Documentation
JWT is a class library that can allow you to generate and validate JWT tokens
### Token generation
To create a token you must
1. Load jwt.hrb library
```xBase
LOCAL handle := hb_hrbLoad( "jwt.hrb" )
```
2. Create an empty JWT object
```xBase
LOCAL oJWT
LOCAL cToken
// Object
oJWT := &("JWT():new()")
```
3. Configure a valid header, setting Type = JWT and an available Algorithm.
At the moment the Algorithms available are: HS256, HS384, and HS512
```xBase
// Header
oJWT:setAlgorithm("HS256")
oJWT:setType("JWT")
```
4. Load a payload. The properties permitted in a payload are:
```xBase
METHOD SetIssuer( cIssuer )
METHOD SetSubject( cSubject )
METHOD SetAudience( cAudience )
METHOD SetExpration( nExpiration )
METHOD SetNotBefore( nNotBefore )
METHOD SetIssuedAt( nIssuedAt )
METHOD SetJWTId( cJWTId )
```
A simple payload can be formed by: Subject, Name, and IssueAt
```xBase
// Payload
oJWT:setSubject("1234567890")
oJWT:setPayloadData("name", "John Doe")
oJWT:setIssuedAt(1516239022)
```
5. Finally you must indicate a secret
```xBase
// Secret
oJWT:setSecret("your-256-bit-secret")
```
6. Now you can get a token
```xBase
// Get Token
cToken = oJWT:Encode()
```
```Text
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
```
### Token verification
Token verifications are also simple
1. Load jwt.hrb library
```xBase
LOCAL handle := hb_hrbLoad( "jwt.hrb" )
```
2. Create an empty JWT object
```xBase
LOCAL oJWT
// Object
oJWT := &("JWT():new()")
```
3. Verify the token
```xBase
oJWT:SetSecret("MySecret")
oJWT:Verify("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ik1hdHRlbyBCYWNjYW4iLCJpYXQiOjE1MTYyMzkwMjJ9.YR8QF52kgj0owYlP9TkEy_lNhC-Qdq38tqNNNqpvpK0")
```
Verify return a .T. if the token is valid. Otherwise with
```xBase
oJWT:GetError()
```
you can get the decode error
## Contribution
Feel free to update this code with a new PR