https://github.com/devofvictory/passx-api

The JSON Rest API for the PassX password manager written with SpringBoot
https://github.com/devofvictory/passx-api

backend-api json-api kotlin passx rest-api

Last synced: 14 days ago
JSON representation

The JSON Rest API for the PassX password manager written with SpringBoot

• Host: GitHub
• URL: https://github.com/devofvictory/passx-api
• Owner: DevOFVictory
• Created: 2022-03-15T21:26:34.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-08-27T16:09:16.000Z (over 1 year ago)
• Last Synced: 2024-11-14T07:09:15.560Z (2 months ago)
• Topics: backend-api, json-api, kotlin, passx, rest-api
• Language: Java
• Homepage:
• Size: 5.54 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        






  

    

  


PassX - API v3.5


  


    A safe place for your passwords from everywhere

    


    Go to the Webinterface »

    


    


    View Website

    ·

    Report Bug

  



# PassX API 3

The JSON REST API for the PassX password manager by [CuodeX.net](https://cuodex.net)

### Features

- Server side encryption

- Two-factor authentication via TOTP

- Remember current IP address for further logins

- Generate TOTP QR Codes

- Check for most common passwords in common databases

- Check current status and more information on the api

- Built-in bruteforce protection via IP block

- Detailed log for administrators to check uncommon behaviour

- Security & privacy granted by FOSS and non-profit project

- Detailed exceptions and documentation

- Easy to use and understand

- Easy to integrate into your own projects

- Custom settings for each user (can be used for custom frontend appearance)

### Compile by source

1. Clone the project `git clone https://github.com/DevOFVictory/PassX-API.git`

2. Check out requirements below

3. Build project with maven ``mvn package``

4. Start api `java -jar target.jar`

### Requirements

- Setup working Java 17 JDK environment

- Setup MySQL database server on Port 3006 and db-name `passx` (or change it in `src/main/ressources/application.properties`)

### Links

- Webclient: https://github.com/CuodeX/PassX-Webclient

- Mobile client: https://github.com/DevOFVictory/PassX-Mobile

- Hosted service: https://passx.cuodex.net

- More project information: https://cuodex.net/passx

### Documentation

https://documenter.getpostman.com/view/18057854/UVyxQZPu