jwt-transform
Version:
transform your real jwt token into fake jwt token.
116 lines (74 loc) • 5.62 kB
Markdown
# JWT Transform
[](https://scrutinizer-ci.com/g/restuwahyu13/jwt-transform/build-status/main) [](https://www.codefactor.io/repository/github/restuwahyu13/jwt-transform) [](https://codebeat.co/projects/github-com-restuwahyu13-jwt-transform-main) [](https://www.codacy.com/gh/restuwahyu13/jwt-transform/dashboard?utm_source=github.com&utm_medium=referral&utm_content=restuwahyu13/jwt-transform&utm_campaign=Badge_Grade)   [](https://github.com/restuwahyu13/jwt-transform/blob/main/CONTRIBUTING.md)
**jwt-transform** is a simple utility tool for your transforming a real *jwt token* into a fake *jwt token*, because if you store *jwt token* into a `cookie` or `local storage` very unsafe, your *jwt token* can be seen data using [jwt.io](https://jwt.io) website or chrome extension, if you use **jwt-transform** you real *jwt token* cannot seen using [jwt.io](https://jwt.io) website or chrome extension, because what you save is fake *jwt token*, you can get back real *jwt token* using decrypt method for parse fake *jwt token*.
## Table Of Content
- [JWT Transform](#jwt-transform)
- [Table Of Content](#table-of-content)
- [Installation](#installation)
- [API Reference](#api-reference)
- [Example Usage](#example-usage)
- [Testing](#testing)
- [Bugs](#bugs)
- [Contributing](#contributing)
- [License](#license)
## Installation
```bash
npm install jwt-transform -S or yarn add jwt-transform -S
```
## API Reference
- #### encrypt(secretKey: string, plainText: string, rotate: number): string
encrypt jwt token using caesar cipher cryptography from real jwt token into fake jwt token
- #### decrypt(secretKey: string, cipherText: string, rotate: number): string
decrypt jwt token using caesar cipher cryptography from fake jwt token into real jwt token
## Example Usage
Follow this **[express tutorial](https://github.com/restuwahyu13/express-rest-api-clean-architecture)** for example usage using express, make this as middleware for transform your fake jwt token to real token, because jwt .verify need real token, if you pass fake token jwt.verify identification your token is not valid and if you not using express, make this as middleware.
- ##### Example Usage Using CommonJs With JavaScript
```javascript
const { JwtTransform } = require('jwt-transform')
const secretKey = 'ptLDDOU5ejqqLjlk4CpSNxvwZVxQFRmF'
const accessToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
const resultEncrypt = JwtTransform.transform(secretKey, accessToken, secretKey.length)
console.log(resultEncrypt)
// fake jwt token
// kePnhMioUoPOAfO1ToOyOtX5iIO6OqvDBIP9.kePfjCOoUoOdSpS0TZE3UJqcOocohsLzFYO6OqvbgM4mXM9rOocogCL0OpudTZK2SpS5SJOelWvzRJJUA5kpwwRprq4IvYTdbcFBdWLXsL.YlrQdcXPYSkQQL2WZ4lcvSkPl36VUq6ePB_gjWyyc5i
const resultDecrypt = JwtTransform.untransform(secretKey, resultEncrypt, secretKey.length)
console.log(resultDecrypt)
// real jwt token
// eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
```
- ##### Example Usage Using ESM With JavaScript / TypeScript
```javascript
import { JwtTransform } from 'jwt-transform'
const secretKey = 'ptLDDOU5ejqqLjlk4CpSNxvwZVxQFRmF'
const accessToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
const resultEncrypt = JwtTransform.transform(secretKey, accessToken, secretKey.length)
console.log(resultEncrypt)
// fake jwt token
// kePnhMioUoPOAfO1ToOyOtX5iIO6OqvDBIP9.kePfjCOoUoOdSpS0TZE3UJqcOocohsLzFYO6OqvbgM4mXM9rOocogCL0OpudTZK2SpS5SJOelWvzRJJUA5kpwwRprq4IvYTdbcFBdWLXsL.YlrQdcXPYSkQQL2WZ4lcvSkPl36VUq6ePB_gjWyyc5i
const resultDecrypt = JwtTransform.untransform(secretKey, resultEncrypt, secretKey.length)
console.log(resultDecrypt)
// real jwt token
// eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
```
## Testing
- Testing Via Local
```sh
npm test or make test
```
- Testing Via Local And Build
```sh
make build
```
- Testing Via Docker
```sh
docker build -t jwt-transform or make dkb tag=jwt-transform
```
## Bugs
For information on bugs related to package libraries, please visit [here](https://github.com/restuwahyu13/jwt-transform/issues)
## Contributing
Want to make **jwt-transform** more perfect ? Let's contribute and follow the [contribution guide.](https://github.com/restuwahyu13/jwt-transform/blob/main/CONTRIBUTING.md)
## License
- [MIT License](https://github.com/restuwahyu13/jwt-transform/blob/main/LICENSE.md)
<p align="right" style="padding: 5px; border-radius: 100%; background-color: red; font-size: 2.5rem;">
<b><a href="#jwt-transform">BACK TO TOP</a></b>
</p>