okuru

README

Okuru

送る(Okuru, "to send") is a snappass "fork/reimplementation" in Golang with the echo web framework adding API (for password only at the moment) and File upload.
You can use it to temporary store password and file.

Security

Passwords are encrypted using Fernet symmetric encryption, from the cryptography library. A random unique key is generated for each password, and is never stored; it is rather sent as part of the password link. This means that even if someone has access to the Redis store, the passwords are still safe.

Requirements

• Redis with notify-keyspace-events KEA set on redis.conf.
• Golang (Not sure about the minimal version, I've used 1.12)

Installation/How to use it

• Clone the repository
• go get in the directory

To test :

• Copy the .env.dist file to .env file or edit it with your configuration. Source it (set -a && source .env && set +a for example on linux).
• Build and run

To fix problem with lz4 https://github.com/mholt/archiver/issues/195

go get github.com/pierrec/lz4 && cd $GOPATH/src/github.com/pierrec/lz4 && git fetch && git checkout v3.0.1

Configuration

You can configure the following via environment variables.

NO_SSL: if you are not using SSL/HTTPS. This will affect the URL that are generated.

REDIS_HOST: this should be set by Redis, but you can override it if you want. Defaults to "localhost"

REDIS_PORT: is the port redis is serving on, defaults to 6379

REDIS_DB: is the database that you want to use on this redis server. Defaults to db 0

REDIS_PREFIX: (optional, defaults to "okuru_") prefix used on redis keys to prevent collisions with other potential clients

REDIS_URL: (optional) will be used instead of REDIS_HOST, REDIS_PORT, and SNAPPASS_REDIS_DB to configure the Redis client object. For example: redis://username:password@localhost:6379/0

OKURU_APP_PORT: (optional) the port on which the app will run

OKURU_TOKEN_SEPARATOR: The token that will separate the keys in the URL. You might not need to change this. It defaults to "~"

OKURU_DISCLAIMER: If you want/need to display a disclaimer at the bottom of the page, add this. This can be html but need to be inline in this file. If you want only text, use \n to add breakline

OKURU_COPYRIGHT: If you want/need to display a copyright at the bottom of the page, add this. This can be html but need to be inline in this file.

OKURU_LOGO: If you want to use a logo, put it in public/images/ and provide the relative path of the logo to this point. The height is arbitrary set to 45px height

OKURU_APP_NAME: The name of the application.

OKURU_FILE_FOLDER: The folder that will be used to store the uploaded files. It can be a relative or an absolute path. It defaults to data/

Code quality

Just a little note, I'm not really familiar with Go yet (I'm learning on the job for fun) so this code may contains many Golang "good way to do" or anti-pattern errors. I will try to improve it as soon as I learn more about it.

Credits

• Pinterest's snappass for the original software and idea
• Labstack's Echo framework for the web framework
• flosch/pongo2 for the template renderer

Contributors

• jeanphilippe-mh

LICENCE

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.