migration to boltDB + README update + ssh keys fix

gusmin · Dec 11, 2019 · a3b857a · a3b857a
1 parent c5c122d
commit a3b857a
Show file tree

Hide file tree

Showing 69 changed files with 6,348 additions and 508 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,9 @@
+# Releases
+securegate-gate-*
+translations.tgz
+
+# Configuration
+config.json
+
+# Database
+*.db
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,15 @@
+language: go
+
+go:
+  - 1.13.x
+
+sudo: required
+
+install:
+  - go get -u github.com/magefile/mage
+  - go get -u golang.org/x/lint/golint
+
+script:
+  - cp config.json.template config.json
+  - mage -v install
+  - mage -v check
diff --git a/README.md b/README.md
@@ -1,184 +1,175 @@
-# Secure Gate - Gate
+# Secure Gate - Gate <img src="https://media.discordapp.net/attachments/433311912281767978/626863798610821130/logo_400dpi.png?width=764&height=884" width=60>
 
+[![Built with Mage](https://magefile.org/badge.svg)](https://magefile.org)
 [![Build Status](https://travis-ci.com/gusmin/gate.svg?token=6WEq9jpFesV2iXzoQsy4&branch=master)](https://travis-ci.com/gusmin/gate)
 
-The gate is an essential part of the project "Secure Gate".
+**Gate** is an essential part of the **Secure Gate** project.
 
-It's the interface used between the user and the other agents.
+For more informations about other parts check out these repositories:
 
-This project is developped with [Golang](https://golang.org/)
-(go minimum version is 1.12)
+- [Backend](https://github.com/atrahy/backend)
+- [Frontend](https://github.com/atrahy/frontend)
+- [Agent](https://github.com/atrahy/agent)
 
-## Install from release
+**Gate** is the interface used between users and [agents](https://github.com/atrahy/agent).
 
-### Get sources
+*This project is developped with Go
+(1.12+)*
 
-- From release tarbar  
-  [Releases](https://github.com/gusmin/gate/releases)
-- From repository
+## :cd: Installation
 
-  ```shell
-  $ export GOPATH="${HOME}/go"
-  $ export PATH="${PATH}:${GOPATH}/bin"
-  $ go get -u github.com/magefile/mage
-  $ mage -v release:linux
-  $ cd release/securegate-gate-{version}
-  ````
+### From a release
 
-### Configuration
+1. **Get a release of the project**. There are various way to achieve this.
 
-Copy the `config.json.template` to `config.json`
-File `config.json`:
+    - Get it from a [releases tarball](https://github.com/gusmin/gate/releases)
+    - Package it directly from the repository:
 
-- `backend_uri` -> `String`: uri of the graphql endpoint of the backend
-- `ssh_user` -> `String`: user that will be used for the ssh connections
+        ```Shell
+        $ go get -u github.com/magefile/mage
+        $ mage release:linux
+        ```
 
-### Install
+2. **Set up the configuration.**
+
+    `cp` the `config.json.template` as `config.json` and edit it according to your needs.
 
-Run `./install` script
+    |           Setting          |                      Description                     |  Value |
+    |:--------------------------:|:----------------------------------------------------:|:------:|
+    |         **backend_uri**        |          URI of your running backend server          | string |
+    |          **ssh_user**          |                 SSH user used for al                 | string |
+    | **agent_authentication_token** | Bearer token used for authentication on agent's side | string |
+    |          **language**          |              Language of the application             | string |
+    |        **db_path**       |             Path of your database            | string |
 
-The script:
+3. **Install the Gate**
 
-- create the `secure` user
-- install the binary to `/usr/bin`
-- set the default shell of `secure` to `/usr/bin/securegate-gate`
+    Go to the previously created release directory and **run the installation script**.
 
-## Installation local
+    ```Shell
+    $ cd release/securegate-gate-{version}
+    $ ./install
+    ```
 
-At first set your environment:
+    This installation script will do **EVERYTHING** for you and set up the **Gate** :rainbow:
 
-```bash
-export GOPATH="${HOME}/go"
-export PATH="${PATH}:${GOPATH}/bin"
-```
+    - It creates a new user: `secure`
+    - Installs the binary `securegate-gate` in `/usr/bin/`
+    - Installs your custom configuration
+    - Makes a special directory to store your logs in `/var/log/securegate/gate/`
+    - Installs the available translations in case you need to change the langage later on.
 
-Then install mage:
+        *Available languages are English, French and Korean*
+    - Set the default shell of the user `secure` to `/usr/bin/securegate-gate`
 
-```shell
-$ go get -u github.com/magefile/mage
-```
+### :crystal_ball: All with Mage
 
-Install the gate by running this command in your terminal:
+1. If you don't have [Mage](https://magefile.org) already installed (shame on you) **install it**
 
-```$shell
-$ mage -v install
-```
+    ```Shell
+    $ go get -u github.com/magefile/mage
+    ```
 
-If you want to run unit tests as well as some linters(golint, go vet) you can run this additional command:
+2. Install the **Gate** by **running this command** in your terminal
 
-```shell
-$ mage -v check
-```
+    ```
+    $ mage install
+    ```
 
-## Usage
+## :milky_way: Welcome in the Gate
 
-The gate will first ask you some credentials. These are the ones you used for signing in to Secure Gate:
+:tada: **Congrats you finished to install the Gate ! Now let's get in !**
 
-```shell
-$ gate
-Email: xxxx
-Password:
-Authentication successful
-securegate$
-```
+In the first place you'll have to **sign up** with on your **Secure Gate** account.
+
+*The credentials are the ones you used during your sign in on the [Frontend](https://github.com/atrahy/frontend)*.
 
-### Available ommands
+### :computer: Commands
 
 ```console
-help                ##Help about any command
+help                ## Help about any command
 me                  ## Display informations about the current user
-add                 ## Add something
-list                ## List all available machines
+list                ## List all accessible nodes
 connect             ## Open SSH connection to a machine
 logout              ## Terminate the session
 exit                ## Close the shell
 ```
 
-#### - help
+#### :books: Help
 
-Provides informations about the available commands.
-Type wether `help [command]` or `[command] --help` for full details.
+##### Provides informations about the available commands
 
-```shell
+*Althought every commands have their own help option.*
+
+*e.g. `[command] --help`*
+
+```
 securegate$ help
 Secure Gate makes the connection between computers more secure than ever
 
 Usage:
   [command]
 
 Available Commands:
-  add       Add object
-  connect   Open SSH connection to a machine
+  connect     Open SSH connection to a machine
+  machine     List all accessible nodes
   ...
   ...
 
 Use "[command] --help" for more information about this command
 ```
 
-#### - me
+#### :ok_woman: Me
 
-Display all informations about the current user:
+##### Display informations related to the current user
 
-- Email
-- Firstname
-- Lastname
-- Job
-- ...
-
-```shell
+```
 securegate$ me
-Email: test@random.com
-Firstname: Jean
-Lastname: Martin
-Job: dev
++--------+-----------+----------+------------+
+| EMAIL  | FIRSTNAME | LASTNAME |     JOB    |
++--------+-----------+----------+------------+
+| Secure | Gate      | Is       | Wonderfull |
++--------+-----------+----------+------------+
+You.
 ```
 
-#### - add [command]
-
-Add something(would be better if you try to add something that we can add)
-
-Available things:
-
-- `machine [name] [ip] [port]`
-
-  ```shell
-  securegate$ add machine foobar 127.0.0.1 3000
-  Machine foobar successfully added
-  securegate$ list
-  [foobar] => 127.0.0.1:300
-  ```
+#### :electric_plug: Connect
 
-#### - connect [machine]
+##### Open a SSH connection toward the machine given as argument
 
-Create a ssh connection to the given machine(must obviously be an available machine for the user)
-
-```shell
-securegate$ connect foobar
-dummy@foobar-pc:~$
+```Shell
+securegate$ connect nowhere
+dummy@nowhere-pc:~$
 ```
 
-#### - list
+#### :scroll: List
 
-List all the machines available for the current user
+##### List all the accessible machines by the current user
 
-```shell
+```
 securegate$ list
-[foo] => 127.0.0.1:3000
-[bar] => 127.0.0.2:3000
++------------------+----------+-------------------------------------------------------+-------+
+|        ID        |   NAME   |                          IP                           | PORT  |
++------------------+----------+-------------------------------------------------------+-------+
+| 09gtWjWi9SOVSGb1 | NASA     | localhost                                             |  3002 |
+| VexuCBYu0JOHzy84 | AREA-51  | localhost                                             | 62774 |
+| kKQSHWF2cl1pjZdp | nowhere  | localhost                                             |  3002 |
++------------------+----------+-------------------------------------------------------+-------+
+Available nodes.
 ```
 
-#### - logout
+#### :walking: Logout
 
-Terminate the active session.
+##### Terminate the active session
 
-```shell
+```
 securegate$ logout
 Email:
 ```
 
-#### - exit
+#### :running: Exit
 
-Close the shell with the given exit status(0 by default)
+##### Close the shell with the given exit status (0 by default)
 
 ```shell
 securegate$ exit 42

diff --git a/config.json.template b/config.json.template
@@ -2,4 +2,6 @@
   "backend_uri": "",
   "ssh_user": "",
   "agent_authentication_token": "",
+  "language": "",
+  "db_path": ""
 }
diff --git a/docker-compose.yaml b/docker-compose.yaml
diff --git a/go.mod b/go.mod
@@ -1,18 +1,17 @@
 module github.com/gusmin/gate
 
-go 1.12
+go 1.13
 
 require (
 	github.com/BurntSushi/toml v0.3.1
+	github.com/boltdb/bolt v1.3.1
 	github.com/chzyer/logex v1.1.10 // indirect
 	github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e
 	github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1 // indirect
-	github.com/go-stack/stack v1.8.0 // indirect
 	github.com/gofrs/flock v0.7.1
-	github.com/golang/snappy v0.0.1 // indirect
 	github.com/gusmin/graphql v0.2.3
 	github.com/kr/pretty v0.1.0 // indirect
-	github.com/magefile/mage v1.8.0
+	github.com/magefile/mage v1.9.0
 	github.com/magiconair/properties v1.8.1 // indirect
 	github.com/matryer/is v1.2.0 // indirect
 	github.com/nicksnyder/go-i18n/v2 v2.0.3
@@ -26,14 +25,9 @@ require (
 	github.com/spf13/viper v1.3.2
 	github.com/stretchr/testify v1.4.0
 	github.com/tidwall/gjson v1.3.5
-	github.com/xdg/scram v0.0.0-20180814205039-7eeb5667e42c // indirect
-	github.com/xdg/stringprep v1.0.0 // indirect
-	go.mongodb.org/mongo-driver v1.1.3
 	golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4
-	golang.org/x/net v0.0.0-20190813141303-74dc4d7220e7
 	golang.org/x/sys v0.0.0-20191120155948-bd437916bb0e // indirect
 	golang.org/x/text v0.3.2
 	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
-	gopkg.in/mgo.v2 v2.0.0-20190816093944-a6b53ec6cb22
 	gopkg.in/natefinch/lumberjack.v2 v2.0.0
 )