Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/vroncevic/ossl

Encrypting/Decrypting files
https://github.com/vroncevic/ossl

aes-256 bash decrypt decrypt-files encrypt encrypt-files linux macos openssl shell unix

Last synced: 22 days ago
JSON representation

Encrypting/Decrypting files

Awesome Lists containing this project

README

        

# Encrypting/Decrypting files

**ossl** is shell tool for operating openssl.

Developed in **[bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell))** code: **100%**.

[![ossl_shell_checker](https://github.com/vroncevic/ossl/actions/workflows/ossl_shell_checker.yml/badge.svg)](https://github.com/vroncevic/ossl/actions/workflows/ossl_shell_checker.yml)

The README is used to introduce the tool and provide instructions on
how to install the tool, any machine dependencies it may have and any
other information that should be provided before the tool is installed.

[![GitHub issues open](https://img.shields.io/github/issues/vroncevic/ossl.svg)](https://github.com/vroncevic/ossl/issues) [![GitHub contributors](https://img.shields.io/github/contributors/vroncevic/ossl.svg)](https://github.com/vroncevic/ossl/graphs/contributors)

**Table of Contents**

- [Installation](#installation)
- [Usage](#usage)
- [Dependencies](#dependencies)
- [Shell tool structure](#shell-tool-structure)
- [Docs](#docs)
- [Copyright and licence](#copyright-and-licence)

### Installation

![Debian Linux OS](https://raw.githubusercontent.com/vroncevic/ossl/dev/docs/debtux.png)

Navigate to release **[page](https://github.com/vroncevic/ossl/releases)** download and extract release archive.

To install **ossl** type the following

```bash
tar xvzf ossl-x.y.tar.gz
cd ossl-x.y
cp -R ~/sh_tool/bin/ /root/scripts/ossl/ver.x.y/
cp -R ~/sh_tool/conf/ /root/scripts/ossl/ver.x.y/
cp -R ~/sh_tool/log/ /root/scripts/ossl/ver.x.y/
```

Self generated setup script and execution

```bash
./ossl_setup.sh

[setup] installing App/Tool/Script ossl
Sat 27 Nov 2021 08:07:11 PM CET
[setup] clean up App/Tool/Script structure
[setup] copy App/Tool/Script structure
[setup] remove github editor configuration files
[setup] set App/Tool/Script permission
[setup] create symbolic link of App/Tool/Script
[setup] done

/root/scripts/ossl/ver.1.0/
├── bin/
│   ├── center.sh
│   ├── decrypt.sh
│   ├── display_logo.sh
│   ├── encrypt.sh
│   └── ossl.sh
├── conf/
│   ├── ossl.cfg
│   ├── ossl.logo
│   └── ossl_util.cfg
└── log/
└── ossl.log

3 directories, 9 files
lrwxrwxrwx 1 root root 38 Nov 27 20:07 /root/bin/ossl -> /root/scripts/ossl/ver.1.0/bin/ossl.sh
```

Or You can use docker to create image/container.

### Usage

```bash
# Create symlink for shell tool
ln -s /root/scripts/ossl/ver.x.y/bin/ossl.sh /root/bin/ossl

# Setting PATH
export PATH=${PATH}:/root/bin/

# Encrypt file
ossl enc /opt/origin.txt

ossl ver.1.0
Sat 27 Nov 2021 08:17:16 PM CET

[check_root] Check permission for current session? [ok]
[check_root] Done


██
░██
██████ ██████ ██████ ░██
██░░░░██ ██░░░░ ██░░░░ ░██
░██ ░██░░█████ ░░█████ ░██
░██ ░██ ░░░░░██ ░░░░░██ ░██
░░██████ ██████ ██████ ███
░░░░░░ ░░░░░░ ░░░░░░ ░░░


Info github.io/ossl ver.1.0
Issue github.io/issue
Author vroncevic.github.io

[ossl] Loading basic and util configuration!
100% [================================================]

[load_conf] Loading App/Tool/Script configuration!
[check_cfg] Checking configuration file [/root/scripts/ossl/ver.1.0/conf/ossl.cfg] [ok]
[check_cfg] Done

[load_conf] Done

[load_util_conf] Load module configuration!
[check_cfg] Checking configuration file [/root/scripts/ossl/ver.1.0/conf/ossl_util.cfg] [ok]
[check_cfg] Done

[load_util_conf] Done

[check_op] Checking operation [enc]? [ok]
[check_op] Done

[check_tool] Checking tool [/usr/bin/openssl]? [ok]
[check_tool] Done

[ossl] Checking file [/opt/origin.txt]? [ok]
Type password: [ossl] Encrypt file [/opt/origin.txt]
[ossl] Encrypted file: -salt -in /opt/origin.txt > -out /opt/origin.txt.aes
[ossl] Done

[logging] Checking directory [/root/scripts/ossl/ver.1.0/log/]? [ok]
[logging] Write info log!
[logging] Done

[ossl] Done
```

### Dependencies

**ossl** requires next modules and libraries
* sh_util [https://github.com/vroncevic/sh_util](https://github.com/vroncevic/sh_util)

### Shell tool structure

**ossl** is based on MOP.

Shell tool structure

```bash
sh_tool/
├── bin/
│   ├── center.sh
│   ├── decrypt.sh
│   ├── display_logo.sh
│   ├── encrypt.sh
│   └── ossl.sh
├── conf/
│   ├── ossl.cfg
│   ├── ossl.logo
│   └── ossl_util.cfg
└── log/
└── ossl.log
```

### Docs

[![Documentation Status](https://readthedocs.org/projects/ossl/badge/?version=latest)](https://ossl.readthedocs.io/projects/ossl/en/latest/?badge=latest)

More documentation and info at
* [https://ossl.readthedocs.io/en/latest/](https://ossl.readthedocs.io/en/latest/)
* [https://www.gnu.org/software/bash/manual/](https://www.gnu.org/software/bash/manual/)

### Copyright and licence

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Copyright (C) 2016 - 2024 by [vroncevic.github.io/ossl](https://vroncevic.github.io/ossl)

**ossl** is free software; you can redistribute it and/or modify
it under the same terms as Bash itself, either Bash version 4.2.47 or,
at your option, any later version of Bash 4 you may have available.

Lets help and support FSF.

[![Free Software Foundation](https://raw.githubusercontent.com/vroncevic/ossl/dev/docs/fsf-logo_1.png)](https://my.fsf.org/)

[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://my.fsf.org/donate/)