Bandie
/
ding
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Merge pull request #1 from Sir-Boops/master 

Update readme.md readability
This commit is contained in:
Bandie 2018-02-01 03:14:34 +01:00 committed by GitHub
parent 0f73da0295 47483e641a
commit b02757dae0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,19 +1,19 @@
# ding
## What is ding?
ding is a client-server thing written in python. Its aim is to execute a set of commands remotely which can be set in the server's config file.
ding is a client-server thing written in python. Its aim is to execute a set of commands remotely, which commands can be set in the server's config file.
## How does it work?
The server awaits commands sent by the client. A command must be defined in the server's config file, else the server won't do anything.
The server will wait for a command to be sent by a client. If the command is present within the servers config file it will then execute the command, else nothing will happen.
## What about ding's security?
The authentication is done by an SSL Client Certificate signed by an (own generated) Certificate Authority. The scripts for generating a CA and signing a Server/Client Certificate are also in here to make it (relatively) easy. [ You need only to press enter in the most cases, type in some certificate information and entering a previously defined CA password. ]
The authentication is done via a SSL Client Certificate signed by an (self generated) Certificate Authority. The scripts for generating a CA and signing the Server/Client Certificates are also included to make it (relatively) easy. [ This involves typing in a few certificate details and entering a previously defined CA password. ]
## Pic or didn't happen
![Screenshot of ding](/img/dingScreenshot.png)
[Can't read a thing?](https://raw.githubusercontent.com/Bandie/ding/master/img/dingScreenshot.png)
## Installation
In all steps please read carefully what the certification generate scripts want from you. The certificate information needn't to be true at all and can be random. They only need to be different from each other.
At every step please read carefully what the generate certificates scripts want from you. The information on the certificates doesn't need to be true and can be totally random. They only need to be different from one another.
1. Run `./1_generateCA.sh` to generate a CA.
2. Run `./2_generateServCert.sh` to generate a signed Server Certificate.
@ -24,8 +24,8 @@ In all steps please read carefully what the certification generate scripts want
7. Try out the client using `./ding_client <command>`.
## Optional: Cleartext password with timeout
If you want to be sure that the ability of the remote connection won't be abused by bad people using your computer, you may want to add a password (saved in cleartext).
The password will be wrapped within the TLS connection though.
If you want to be sure that this power won't be abused by bad people using your computer, you may want to add a password (saved in cleartext).
The password will be sent inside the TLS connection.
To do so:
@ -34,4 +34,4 @@ To do so:
3. Set a password, like `password=abc def`.
4. Set a password timeout: `pwtimeout=10` for 10 seconds.
If you have a password with special characters like spaces or something else, you might want to embrace the password in quotation marks, like `./ding_client "abc def"`.
If you have a password with special characters as in spaces and the like, you may want to use quotation marks around your password. `./ding_client "abc def"`.