Skip to content

Commit

Permalink
changed pass-wall to passwall
Browse files Browse the repository at this point in the history
  • Loading branch information
yakuter committed Jul 5, 2020
1 parent 181ee24 commit 6fe4f8b
Show file tree
Hide file tree
Showing 44 changed files with 112 additions and 138 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING-TR.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ PassWall'e yardım etmek mi istiyorsun? Mükemmel, aramıza hoşgeldin. Bu dokü
------------

- "Nasıl yapılır?" soruları için [StackOverflow](https://stackoverflow.com/questions/tagged/passwall).
- Hata (Bug) bildirimi, özellik (feature) önerisi veya proje kaynak kodu için [GitHub](https://github.com/pass-wall/passwall-server/issues).
- Hata (Bug) bildirimi, özellik (feature) önerisi veya proje kaynak kodu için [GitHub](https://github.com/passwall/passwall-server/issues).
- Konu tartışmaları için [Slack](https://passwall.slack.com).
- E-posta ile iletişim için [[email protected]](mailto:[email protected]).

Katkıda bulunacak bir şeyi nasıl bulabilirim ?
------------
1. Öncelikle katkıda bulunulacak her konunun bir issue'su olması gerektiğini unutmayın. Bunun için [issue](https://github.com/pass-wall/passwall-server/issues) sayfasına bakabilirsiniz.
1. Öncelikle katkıda bulunulacak her konunun bir issue'su olması gerektiğini unutmayın. Bunun için [issue](https://github.com/passwall/passwall-server/issues) sayfasına bakabilirsiniz.

1. Issue sayfasında öncelikle [help wanted](https://github.com/pass-wall/passwall-server/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issue'larına bakın.
1. Issue sayfasında öncelikle [help wanted](https://github.com/passwall/passwall-server/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issue'larına bakın.

1. Sonrasında koddaki [// TODO:](https://github.com/pass-wall/passwall-server/search?q=TODO&unscoped_q=TODO) kısımlarını düzeltmeyi deneyebilirsiniz.
1. Sonrasında koddaki [// TODO:](https://github.com/passwall/passwall-server/search?q=TODO&unscoped_q=TODO) kısımlarını düzeltmeyi deneyebilirsiniz.

1. Eğer yeni bir özellik (feature) olarak iyi bir fikriniz varsa veya bir hata (bug) bulursanız bu konuda bir konu (issue) açmaktan çekinmeyin ve eğer konu üzerinde çalışmak istiyorsanız mutlaka belirtin.

Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ Get in touch
------------

- Ask usage questions ("How do I?") on [StackOverflow](https://stackoverflow.com/questions/tagged/passwall).
- Report bugs or suggest features on [GitHub issues](https://github.com/pass-wall/passwall-server/issues).
- Report bugs or suggest features on [GitHub issues](https://github.com/passwall/passwall-server/issues).
- Discuss topics on [Slack](https://passwall.slack.com).
- Email us at [[email protected]](mailto:[email protected]).

How to find something to contribute?
------------

1. First look for [help wanted](https://github.com/pass-wall/passwall-server/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues.
1. First look for [help wanted](https://github.com/passwall/passwall-server/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues.

1. Then you can try to fix [// TODO:](https://github.com/pass-wall/passwall-server/search?q=TODO&unscoped_q=TODO)'s in the code.
1. Then you can try to fix [// TODO:](https://github.com/passwall/passwall-server/search?q=TODO&unscoped_q=TODO)'s in the code.

1. If you have a good idea as a `feature` or find a `bug`, feel free to open an issue about it and tell us that you want to work on this subject.

Expand Down Expand Up @@ -90,7 +90,7 @@ on how to send one :)
# Navigate to the newly cloned directory
cd <repo-name>
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/pass-wall/<repo-name>
git remote add upstream https://github.com/passwall/<repo-name>
```

2. If you cloned a while ago, get the latest changes from upstream:
Expand Down
66 changes: 20 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

**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/pass-wall/passwall-server)](https://github.com/pass-wall/passwall-server/blob/master/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/pass-wall/passwall-server)](https://github.com/pass-wall/passwall-server/issues)
[![Build Status](https://travis-ci.org/pass-wall/passwall-server.svg?branch=master)](https://travis-ci.org/pass-wall/passwall-server)
[![Coverage Status](https://coveralls.io/repos/github/pass-wall/passwall-server/badge.svg?branch=master)](https://coveralls.io/github/pass-wall/passwall-server?branch=master)
[![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)

Expand All @@ -14,41 +14,24 @@ 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 can be used by these clients or you can write your own client by using [API Documentation](https://documenter.getpostman.com/view/3658426/SzYbyHXj)
[PassWall Web](https://github.com/pass-wall/passwall-web)
[PassWall Desktop](https://github.com/pass-wall/passwall-desktop)
[PassWall Mobile](https://github.com/pass-wall/passwall-mobile)
**PassWall Server** can be used with [**PassWall Desktop**](https://github.com/passwall/passwall-desktop)

The screenshot of Passwall Desktop working with Passwall Server is as follows
![PassWall Desktop Screenshot](https://www.yakuter.com/wp-content/yuklemeler/PassWall-Desktop-Screenshot.png "PassWall Desktop")
<p align="center">
<img src="https://www.yakuter.com/wp-content/yuklemeler/passwall-screenshot.png" alt="" width="800" height="450" />
</p>

## API Documentation
API documentation available at:
[Click to see at Public Postman](https://documenter.getpostman.com/view/3658426/SzYbyHXj)

## DEMO
**Address:** https://passwall-server.herokuapp.com
**Username:** passwall
**Password:** password

## Database supoort
PassWall works with **PostgreSQL** databases. Settings required for connection to database are in **./store/config.yml**.

## What's possible with PassWall Server?
Currently, this project is focused on storing URL, username and password which is basically called **Login** at PassWall.

An admin can;
- View and search logins
- Create login with automatically generated strong password
- Update login
- Delete login
- Import logins from other password managers
- Export logins as CSV format

## Authentication and Security
This server uses **JWT Token** to secure endpoints. So user must generate token with **/auth/signin** first. Then with generated token, all endpoints in API documentation can be reachable.

User information for signin is in **config.yml** file.
API documentation available at [Postman Public Directory](https://documenter.getpostman.com/view/3658426/SzYbyHXj)

## Database support
PassWall works with **PostgreSQL** databases.

## Configuration
When PassWall Server starts, it automatically generates **config.yml** in the folders below:
**MacOS:** $HOME/Library/Application Support/passwall-server
**Windows:** $APPDATA/passwall-server
**Linux:** $HOME/.config/passwall-server


## 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.
Expand Down Expand Up @@ -90,11 +73,9 @@ These environment variables are accepted:
Install Go to your computer. Pull the server repo. Execute the command in server folder.

```
go run ./cmd/passwall-server/main.go
go run ./cmd/passwall-server
```

The server uses config file end environment variables. If you want to set variables manually, just change **config-sample.yml** to **config.yml** in **store** folder.

## Docker

```
Expand All @@ -107,13 +88,6 @@ cp ./store/config-sample.yml ./store/config.yml
docker run --name passwall-server --rm -v $(pwd)/store:/app/store -p 3625:3625 passwall/passwall-server
```

## Import
There are different kinds of password managers. Almost all of them can export login information as CSV file. Here is an example CSV file (let's say example.csv).
![example csv](https://www.yakuter.com/wp-content/yuklemeler/example-csv.png "Example CSV File")

You need to fill the import form as below picture.
![passwall-server import](https://www.yakuter.com/wp-content/yuklemeler/gpass-import-csv.png "Import Form and Request Example")

## Hello Contributors

1. Don't send too much commit at once. It will be easier for us to do a code review.
Expand Down
2 changes: 1 addition & 1 deletion app.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "Passwall API",
"description": "Open Source Password Manager API",
"repository": "https://github.com/pass-wall/passwall-server",
"repository": "https://github.com/passwall/passwall-server",
"logo": "https://avatars1.githubusercontent.com/u/63540685",
"keywords": ["go", "golang", "api","password manager","password","manager"]
}
Expand Down
8 changes: 4 additions & 4 deletions cmd/passwall-server/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ import (
"time"

_ "github.com/heroku/x/hmetrics/onload"
"github.com/pass-wall/passwall-server/internal/app"
"github.com/pass-wall/passwall-server/internal/config"
"github.com/pass-wall/passwall-server/internal/router"
"github.com/pass-wall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/internal/app"
"github.com/passwall/passwall-server/internal/config"
"github.com/passwall/passwall-server/internal/router"
"github.com/passwall/passwall-server/internal/storage"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/pass-wall/passwall-server
module github.com/passwall/passwall-server

go 1.14

Expand Down
6 changes: 3 additions & 3 deletions internal/api/auth.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ import (

"github.com/dgrijalva/jwt-go"
"github.com/go-playground/validator/v10"
"github.com/pass-wall/passwall-server/internal/app"
"github.com/pass-wall/passwall-server/internal/storage"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/internal/app"
"github.com/passwall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/model"
)

var (
Expand Down
6 changes: 3 additions & 3 deletions internal/api/bank_account.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import (
"net/http"
"strconv"

"github.com/pass-wall/passwall-server/internal/app"
"github.com/pass-wall/passwall-server/internal/storage"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/internal/app"
"github.com/passwall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/model"

"github.com/gorilla/mux"
)
Expand Down
6 changes: 3 additions & 3 deletions internal/api/credit_card.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import (
"net/http"
"strconv"

"github.com/pass-wall/passwall-server/internal/app"
"github.com/pass-wall/passwall-server/internal/storage"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/internal/app"
"github.com/passwall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/model"

"github.com/gorilla/mux"
)
Expand Down
6 changes: 3 additions & 3 deletions internal/api/email.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import (
"net/http"
"strconv"

"github.com/pass-wall/passwall-server/internal/app"
"github.com/pass-wall/passwall-server/internal/storage"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/internal/app"
"github.com/passwall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/model"

"github.com/gorilla/mux"
)
Expand Down
2 changes: 1 addition & 1 deletion internal/api/health.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package api
import (
"net/http"

"github.com/pass-wall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/internal/storage"
)

var (
Expand Down
4 changes: 2 additions & 2 deletions internal/api/health_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import (
"net/http/httptest"
"testing"

"github.com/pass-wall/passwall-server/internal/config"
"github.com/pass-wall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/internal/config"
"github.com/passwall/passwall-server/internal/storage"
)

func TestHealthCheck(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion internal/api/helper.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
"strconv"
"strings"

"github.com/pass-wall/passwall-server/internal/app"
"github.com/passwall/passwall-server/internal/app"
)

// SetArgs ...
Expand Down
6 changes: 3 additions & 3 deletions internal/api/login.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ import (
"net/http"
"strconv"

"github.com/pass-wall/passwall-server/internal/app"
"github.com/pass-wall/passwall-server/internal/storage"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/internal/app"
"github.com/passwall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/model"

"github.com/gorilla/mux"
)
Expand Down
4 changes: 2 additions & 2 deletions internal/api/login_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ import (
"github.com/go-test/deep"
"github.com/gorilla/mux"
"github.com/jinzhu/gorm"
"github.com/pass-wall/passwall-server/internal/storage"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/model"
"github.com/stretchr/testify/assert"
)

Expand Down
6 changes: 3 additions & 3 deletions internal/api/note.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import (
"net/http"
"strconv"

"github.com/pass-wall/passwall-server/internal/app"
"github.com/pass-wall/passwall-server/internal/storage"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/internal/app"
"github.com/passwall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/model"

"github.com/gorilla/mux"
)
Expand Down
6 changes: 3 additions & 3 deletions internal/api/passwords.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import (
"encoding/json"
"net/http"

"github.com/pass-wall/passwall-server/internal/app"
"github.com/pass-wall/passwall-server/internal/storage"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/internal/app"
"github.com/passwall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/model"
"github.com/spf13/viper"
)

Expand Down
6 changes: 3 additions & 3 deletions internal/api/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ import (
"net/http"
"strconv"

"github.com/pass-wall/passwall-server/internal/app"
"github.com/pass-wall/passwall-server/internal/storage"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/internal/app"
"github.com/passwall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/model"

"github.com/gorilla/mux"
)
Expand Down
6 changes: 3 additions & 3 deletions internal/api/system.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ import (
"path/filepath"

"github.com/gorilla/mux"
"github.com/pass-wall/passwall-server/internal/app"
"github.com/pass-wall/passwall-server/internal/storage"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/internal/app"
"github.com/passwall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/model"
"github.com/spf13/viper"
"gopkg.in/yaml.v2"
)
Expand Down
6 changes: 3 additions & 3 deletions internal/api/user.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ import (
"strconv"

"github.com/go-playground/validator/v10"
"github.com/pass-wall/passwall-server/internal/app"
"github.com/pass-wall/passwall-server/internal/storage"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/internal/app"
"github.com/passwall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/model"

"github.com/gorilla/mux"
)
Expand Down
2 changes: 1 addition & 1 deletion internal/app/auth.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
"time"

"github.com/dgrijalva/jwt-go"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/model"

uuid "github.com/satori/go.uuid"
"github.com/spf13/viper"
Expand Down
4 changes: 2 additions & 2 deletions internal/app/bank_account.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package app
import (
"encoding/base64"

"github.com/pass-wall/passwall-server/internal/storage"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/model"
"github.com/spf13/viper"
)

Expand Down
4 changes: 2 additions & 2 deletions internal/app/credit_card.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package app
import (
"encoding/base64"

"github.com/pass-wall/passwall-server/internal/storage"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/model"
"github.com/spf13/viper"
)

Expand Down
4 changes: 2 additions & 2 deletions internal/app/email.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package app
import (
"encoding/base64"

"github.com/pass-wall/passwall-server/internal/storage"
"github.com/pass-wall/passwall-server/model"
"github.com/passwall/passwall-server/internal/storage"
"github.com/passwall/passwall-server/model"
"github.com/spf13/viper"
)

Expand Down
Loading

0 comments on commit 6fe4f8b

Please sign in to comment.