rust/hyperswitch
1
0
Fork 0
mirror of https://github.com/juspay/hyperswitch.git synced 2025-10-29 09:07:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

refactor(openapi): move openapi to a separate folder (#4859)

Browse Source
This commit is contained in:
Narayan Bhat
2024-06-07 11:44:01 +05:30
committed by GitHub
parent 97e4f1af90
commit 05105321ca
110 changed files with 1217 additions and 4628 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
api-reference/locker-api-reference/cards/add-data-in-locker.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: rust_locker_open_api_spec post /data/add
---

3
api-reference/locker-api-reference/cards/delete-data-from-locker.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: rust_locker_open_api_spec post /data/delete
---

3
api-reference/locker-api-reference/cards/get-or-insert-the-card-fingerprint.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /data/fingerprint
---

3
api-reference/locker-api-reference/cards/retrieve-data-from-locker.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: rust_locker_open_api_spec post /data/retrieve
---

3
api-reference/locker-api-reference/key-custodian/provide-key-1.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: rust_locker_open_api_spec post /custodian/key1
---

3
api-reference/locker-api-reference/key-custodian/provide-key-2.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: rust_locker_open_api_spec post /custodian/key2
---

3
api-reference/locker-api-reference/key-custodian/unlock-the-locker.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: rust_locker_open_api_spec post /custodian/decrypt
---

3
api-reference/locker-api-reference/locker-health/get-health.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: rust_locker_open_api_spec get /health
---

27
api-reference/locker-api-reference/overview.mdx Normal file
View File

@ -0,0 +1,27 @@
The Hyperswitch Card Vault is a highly performant and a secure vault to save sensitive data such as payment card details, bank account details etc.
It is designed in an polymorphic manner to handle and store any type of sensitive information making it highly scalable with extensive coverage of payment methods and processors.
Hyperswitch Card Vault is built with a GDPR compliant personal identifiable information (PII) storage and secure encryption algorithms to be fully compliant with PCI DSS requirements.
Here's a quick guide to [Get Started](https://github.com/juspay/hyperswitch-card-vault/blob/main/docs/guides/setup.md) with setting up Hyperswitch Card Vault.
## How does Hyperswitch Card Vault work?
- Your application will communicate with Hyperswitch Card Vault via a middleware.
- All requests and responses to and from the middleware are signed and encrypted with the JWS and JWE algorithms.
- The locker supports CRD APIs on the /data and /cards endpoints -
- Cards are stored against the combination of merchant and customer identifiers.
- Internal hashing checks are in place to avoid data duplication.
![general-block-diagram](https://raw.githubusercontent.com/juspay/hyperswitch-card-vault/45dc1e5ca168f811b9230ede9e644ccb6f03a28c/docs/imgs/general-block-diagram.png)
## Key Hierarchy
- Master Key - AES generated key to that is encrypted/decrypted by the custodian keys to run the locker and associated configurations.
- Custodian Keys - AES generated key that is used to encrypt and decrypt the master key. It broken into two keys (key 1 and key 2) and available with two custodians to enhance security.
![lock-key-hierarchy](https://raw.githubusercontent.com/juspay/hyperswitch-card-vault/45dc1e5ca168f811b9230ede9e644ccb6f03a28c/docs/imgs/locker-key-hierarchy.png)
## Setup Guide
Follow this guide to setup - [Get Started](https://github.com/juspay/hyperswitch-card-vault/blob/main/docs/guides/setup.md)