Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/passwall/passwall-server

Passwall Server is the core backend infrastructure for Passwall platform
https://github.com/passwall/passwall-server

api crypto go golang hacktoberfest password password-manager

Last synced: 5 days ago
JSON representation

Passwall Server is the core backend infrastructure for Passwall platform

Host: GitHub
URL: https://github.com/passwall/passwall-server
Owner: passwall
License: agpl-3.0
Created: 2020-04-04T20:41:50.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2023-12-19T00:23:57.000Z (about 1 year ago)
Last Synced: 2024-12-30T00:06:20.822Z (13 days ago)
Topics: api, crypto, go, golang, hacktoberfest, password, password-manager
Language: Go
Homepage: https://passwall.io
Size: 1.64 MB
Stars: 760
Watchers: 26
Forks: 105
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING-TR.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

open-production-web-projects - Passwall - PassWall Server is the core backend for open source password manager PassWall platform. Using this server, you can safely store your passwords and access them from anywhere. (Go / AWS Amplify)
awesome-golang-repositories - passwall-server

README

# PassWall Server

**PassWall Server** is the core backend for open source password manager PassWall platform. Using this server, you can safely store your passwords and access them from anywhere.

[![License](https://img.shields.io/github/license/passwall/passwall-server)](https://github.com/passwall/passwall-server/blob/master/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/passwall/passwall-server)](https://github.com/passwall/passwall-server/issues)
[![Build Status](https://travis-ci.org/passwall/passwall-server.svg?branch=master)](https://travis-ci.org/passwall/passwall-server)
[![Coverage Status](https://coveralls.io/repos/github/passwall/passwall-server/badge.svg?branch=master)](https://coveralls.io/github/passwall/passwall-server?branch=master)
[![Docker Pull Status](https://img.shields.io/docker/pulls/passwall/passwall-server)](https://hub.docker.com/u/passwall/)
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## Support
I promise all the coffee you have ordered will be spent on this project
[![Become a Patron](https://www.yakuter.com/wp-content/yuklemeler/yakuter-patreon.png)](https://www.patreon.com/bePatron?u=33541638)

## Clients
**PassWall Server** can be used with [**PassWall Desktop**](https://github.com/passwall/passwall-desktop)

## On Premise Installation
1. Pull passwall-server image from Docker Hub.

```
docker pull passwall/passwall-server
```

2. Download the docker-compose.yml file and start the server with the following commands.

```
mkdir $HOME/passwall-server
```
```
cd $HOME/passwall-server
```
```
wget https://raw.githubusercontent.com/passwall/passwall-server/main/docker-compose.yml
```
```
docker-compose up -d
```

3. Create a new user with passwall-cli.
```
docker exec -it passwall-server /app/passwall-cli
```

4. Download and install any passwall client you want from [paswall.io](https://signup.passwall.io).
5. Open your client and write http://localhost:3625 into the server url field. Login with your newly created user information.
## API Documentation
API documentation available at [Postman Public Directory](https://documenter.getpostman.com/view/3658426/SzYbyHXj)
## Security
1. PassWall uses The Advanced Encryption Standard (AES) encryption algorithm with Galois/Counter Mode (GCM) symmetric-key cryptographic mode. Passwords encrypted with AES can only be decrypted with the passphrase defined in the **config.yml** file.

2. Endpoints are protected with security middlewares against attacks like XSS.

3. Against SQL injection, PassWall uses Gorm package to handle database queries which clears all queries.

4. There is rate limiter for signin attempts against brute force attacks.

## Environment Variables
These environment variables are accepted:

**Server Variables:**
- PORT
- PW_SERVER_USERNAME
- PW_SERVER_PASSWORD
- PW_SERVER_PASSPHRASE
- PW_SERVER_SECRET
- PW_SERVER_TIMEOUT
- PW_SERVER_GENERATED_PASSWORD_LENGTH
- PW_SERVER_ACCESS_TOKEN_EXPIRE_DURATION
- PW_SERVER_REFRESH_TOKEN_EXPIRE_DURATION

**Database Variables**
- PW_DB_NAME
- PW_DB_USERNAME
- PW_DB_PASSWORD
- PW_DB_HOST
- PW_DB_PORT
- PW_DB_LOG_MODE

## Hello Contributors

1. Don't send too much commit at once. It will be easier for us to do a code review.

1. Be sure to take a look at the dev branch. The version I am working on is there.

1. First try to fix `// TODO:`s in the code.

1. Then you can contribute to the development by following the mile stones.

1. Don't mess with the user interface. The design guide has not been released yet.