What follows are instructions on how to make modifications to the source code without making git refuse to download updates as well as how to incorporate updates from the master branch into your modified local branch. Use Contributing_code_initial_setup.md documentation instead
Frequently (and perhaps infrequently) asked question (F.A.Q.) Q: What is this project A: This project aims to expose encryption operations (currently via GnuPG’s PGP encryption applications) to logging daemons and/or user processes. Being designed as a cyber defense tool for
External links to documentation used within this project Note the bellow links are not directly related to the project and serve as the author of this project crediting the following authors for having solved or documented techniques prior to the
___ title: Setting up Jekyll gh-pages ___ ## Install dependancies ``` sudo apt-get install ruby-full git nodejs libgemplugin-ruby ``` > Download a local copy of this project under a non-sudo account ``` ## Add non-sudo user and login to it
Contributing to documentation This file assumes that you’ve already followed directions found within the Contributing_code_initial_setup.md file. This file contains information specific to how these docs are formatted and how new documents should be formatted prior to using pull-request or request-pull
Resolving merge conflicts Install vimdiff or other diff tools ## Debian based distributions sudo apt-get install vim Setting up vimdiff as git mergetool git config --add merge.tool vimdiff git config --add merge.conflictstyle diff3 git config --add mergetool.promp false Using vimdiff
Work flow steps that will repeat (code maintenance) Note the following instructions assume that your have already completed the steps outlined in Contributing_code_initial_setup.md and are operating within the Parinoid_Pipes/ directory. Copy script for line wrapping commit messages This script can
Initial git setup skip any steps that have been completed for other code contributions and set as a global setting within your user’s ~/.gitconfig file. Note you may also try ../Script_Helpers/Contributing_initial_setup.sh script for setting up GnuPG & Git settings. Setup
See Contributing_code_initial_setup.md documentation for instructions on how to add your code contribution information to this file.
Title page Support the original authors financially via the following methods Currency Type Wallet public address USD (PayPal) paypal.me/S0AndS0 BTC (bitcoin) 1NjG8kAiTBcyGnuTLKP4N6MNmCoWWh8fmj LTC (litecoin) LKucbsSHxQxDekJquwpdSpnsdbnqEVbTe2 DOGE (dogecoin) DS9PXxjQr12s1nAUUSQyR7YQK6HM1GbdkC DRK (darkcoin) XradYSbZ2oZT9Qi1JwmFVx3UCzeqfX5Fvy VTC (vertcoin) VvRePCWBatR5nohf2xXXwLLmvUfWG2mFE4 RDD (reddcoin) Ro4CyYZWEPqjSMbmZgiyQE7VfaLmd6gh5P Support code maintainers
Warnings This project, it’s scripts and those contained within this document itself are all without warranty nor will the authors be held liable for damages sustained to users, their hardware or the hardware of others while using this project’s scripts,
Scenario two Logging output -> Pipe (encryption) input -> Encryption -> Pipe (decryption) input -> Log output (rotate) -> Encrypted email Let’s say you’re web server’s threat modal is different than that described by Scenario one and your server still
Scenario three Save custom script copy over SSH -> Target host's Logging output -> Pipe (encryption) input -> Encrypted Log output -> Rotate encrypt and email removing old Write customized pipe listener script over SSH These are the options used
Scenario one Logging output -> Pipe (encryption) input -> Encrypted log output -> Rotate using encrypted email and compression This scenario was written with the following link’s questions as it’s inspiration Serverfault Asymmetric encrypt server logs that end up with
Scenario Four Logging output -> Named Pipe encryption input file -> Encrypt & send output to -> Pipe decryption input file -> Mount decryption input file directory via SSHfs -> Start listener on remote mounted Pipe decryption input file ->
Quick start This document only covers downloading and initial testing of project features. See the Frequently asked questions document FAQ.md for answers to common questions. Step 1 Import public GnuPG key into server that will be running this script or
External application used Note these are organized by licensing agreements that the applications external to this project operate under, Documentation specific to each command bellow can be found with <command> --help or man <command> GNU GPL v2 mutt GNU GPL
CLO Manual and documentation Notes about bellow options If using a “Command line option” to pass values into this project’s main script then they should be prefixed by two dashes (--) as shown, however, if instead you wish to pass
Paranoid Pipes Bash Logics Internal bash commands used within this project’s scripts touch Make an empty file or modify the last edit time on preexisting file. Within this script touch is used within the function Func_rotate_log To make a new
Verifying signed commits and tags Import author’s public GPG key gpg --recv-keys 6E4C46DA15B22310 Assign trust levels to quite git gpg --edit-key 6E4C46DA15B22310 ## Within interactive menu #> trust ## Set number value of trust to key id #> 5 ##
GnuPG tools There are many interesting tools available for GPG, the more note worthy will be spotlighted bellow but their usefulness will depend upon you personal usage requirements. These following external projects should not be bothered by bugs found within
Useful GnuPG command line commands list There are plenty of advanced command line tricks that can be done with GnuPG, the following list of common commands are ordered by least to more advanced commands. GnuPG commands (daily use) Search for
GnuPG commands: key management Generate new key pair gpg --gen-key The above will open an interactive session within the terminal and request information from the user (you) as to what type of keys are being generated, generally an RSA pair
GnuPG installation options Note the following information for non-Linux based operating systems should be considered experimental & untested by the authors of this project unless otherwise specified. Some of the following is not applicable with the scripts contained within this
Configuring GnuPG Regardless of how GnuPG is installed the following configuration lines should be placed within your gpg.conf file to conform to best practices when using PGP encryption tools. Note, email and chat clients will usually have their own separate
___ title: Setting up Jekyll gh-pages ___ ## Install dependancies ``` sudo apt-get install ruby-full git nodejs libgemplugin-ruby ``` > Download a local copy of this project under a non-sudo account ``` ## Add non-sudo user and login to it
Contributing to documentation This file assumes that you’ve already followed directions found within the Contributing_code_initial_setup.md file. This file contains information specific to how these docs are formatted and how new documents should be formatted prior to using pull-request or request-pull
Resolving merge conflicts Install vimdiff or other diff tools ## Debian based distributions sudo apt-get install vim Setting up vimdiff as git mergetool git config --add merge.tool vimdiff git config --add merge.conflictstyle diff3 git config --add mergetool.promp false Using vimdiff
Work flow steps that will repeat (code maintenance) Note the following instructions assume that your have already completed the steps outlined in Contributing_code_initial_setup.md and are operating within the Parinoid_Pipes/ directory. Copy script for line wrapping commit messages This script can
Initial git setup skip any steps that have been completed for other code contributions and set as a global setting within your user’s ~/.gitconfig file. Note you may also try ../Script_Helpers/Contributing_initial_setup.sh script for setting up GnuPG & Git settings. Setup
See Contributing_code_initial_setup.md documentation for instructions on how to add your code contribution information to this file.
Title page Support the original authors financially via the following methods Currency Type Wallet public address USD (PayPal) paypal.me/S0AndS0 BTC (bitcoin) 1NjG8kAiTBcyGnuTLKP4N6MNmCoWWh8fmj LTC (litecoin) LKucbsSHxQxDekJquwpdSpnsdbnqEVbTe2 DOGE (dogecoin) DS9PXxjQr12s1nAUUSQyR7YQK6HM1GbdkC DRK (darkcoin) XradYSbZ2oZT9Qi1JwmFVx3UCzeqfX5Fvy VTC (vertcoin) VvRePCWBatR5nohf2xXXwLLmvUfWG2mFE4 RDD (reddcoin) Ro4CyYZWEPqjSMbmZgiyQE7VfaLmd6gh5P Support code maintainers
Warnings This project, it’s scripts and those contained within this document itself are all without warranty nor will the authors be held liable for damages sustained to users, their hardware or the hardware of others while using this project’s scripts,
Scenario two Logging output -> Pipe (encryption) input -> Encryption -> Pipe (decryption) input -> Log output (rotate) -> Encrypted email Let’s say you’re web server’s threat modal is different than that described by Scenario one and your server still
Scenario three Save custom script copy over SSH -> Target host's Logging output -> Pipe (encryption) input -> Encrypted Log output -> Rotate encrypt and email removing old Write customized pipe listener script over SSH These are the options used
Scenario one Logging output -> Pipe (encryption) input -> Encrypted log output -> Rotate using encrypted email and compression This scenario was written with the following link’s questions as it’s inspiration Serverfault Asymmetric encrypt server logs that end up with
Scenario Four Logging output -> Named Pipe encryption input file -> Encrypt & send output to -> Pipe decryption input file -> Mount decryption input file directory via SSHfs -> Start listener on remote mounted Pipe decryption input file ->
Quick start This document only covers downloading and initial testing of project features. See the Frequently asked questions document FAQ.md for answers to common questions. Step 1 Import public GnuPG key into server that will be running this script or
External application used Note these are organized by licensing agreements that the applications external to this project operate under, Documentation specific to each command bellow can be found with <command> --help or man <command> GNU GPL v2 mutt GNU GPL
CLO Manual and documentation Notes about bellow options If using a “Command line option” to pass values into this project’s main script then they should be prefixed by two dashes (--) as shown, however, if instead you wish to pass
Paranoid Pipes Bash Logics Internal bash commands used within this project’s scripts touch Make an empty file or modify the last edit time on preexisting file. Within this script touch is used within the function Func_rotate_log To make a new
Verifying signed commits and tags Import author’s public GPG key gpg --recv-keys 6E4C46DA15B22310 Assign trust levels to quite git gpg --edit-key 6E4C46DA15B22310 ## Within interactive menu #> trust ## Set number value of trust to key id #> 5 ##
GnuPG tools There are many interesting tools available for GPG, the more note worthy will be spotlighted bellow but their usefulness will depend upon you personal usage requirements. These following external projects should not be bothered by bugs found within
Useful GnuPG command line commands list There are plenty of advanced command line tricks that can be done with GnuPG, the following list of common commands are ordered by least to more advanced commands. GnuPG commands (daily use) Search for
GnuPG commands: key management Generate new key pair gpg --gen-key The above will open an interactive session within the terminal and request information from the user (you) as to what type of keys are being generated, generally an RSA pair
GnuPG installation options Note the following information for non-Linux based operating systems should be considered experimental & untested by the authors of this project unless otherwise specified. Some of the following is not applicable with the scripts contained within this
Configuring GnuPG Regardless of how GnuPG is installed the following configuration lines should be placed within your gpg.conf file to conform to best practices when using PGP encryption tools. Note, email and chat clients will usually have their own separate
GNU Free Documentation License Version 1.3, 3 November 2008 Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. http://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007 Copyright (C) 2007 Free Software Foundation, Inc. http://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU