Module: Sym

Included in:
App::Commands::BaseCommand, App::Commands::Decrypt, App::Commands::Encrypt, App::Commands::OpenEditor, App::PrivateKey::Decryptor, App::PrivateKey::Handler
Defined in:
lib/sym.rb,
lib/sym/app.rb,
lib/sym/data.rb,
lib/sym/errors.rb,
lib/sym/app/cli.rb,
lib/sym/version.rb,
lib/sym/app/args.rb,
lib/sym/constants.rb,
lib/sym/app/output.rb,
lib/sym/magic_file.rb,
lib/sym/application.rb,
lib/sym/app/cli_slop.rb,
lib/sym/app/commands.rb,
lib/sym/app/keychain.rb,
lib/sym/data/decoder.rb,
lib/sym/data/encoder.rb,
lib/sym/configuration.rb,
lib/sym/app/short_name.rb,
lib/sym/cipher_handler.rb,
lib/sym/app/output/base.rb,
lib/sym/app/output/file.rb,
lib/sym/app/output/noop.rb,
lib/sym/app/input/handler.rb,
lib/sym/app/output/stdout.rb,
lib/sym/app/password/cache.rb,
lib/sym/data/wrapper_struct.rb,
lib/sym/app/commands/decrypt.rb,
lib/sym/app/commands/encrypt.rb,
lib/sym/extensions/with_retry.rb,
lib/sym/app/commands/print_key.rb,
lib/sym/app/commands/show_help.rb,
lib/sym/app/password/providers.rb,
lib/sym/app/private_key/handler.rb,
lib/sym/extensions/with_timeout.rb,
lib/sym/app/commands/open_editor.rb,
lib/sym/app/private_key/detector.rb,
lib/sym/extensions/class_methods.rb,
lib/sym/app/commands/base_command.rb,
lib/sym/app/commands/generate_key.rb,
lib/sym/app/commands/show_version.rb,
lib/sym/app/private_key/decryptor.rb,
lib/sym/app/commands/show_examples.rb,
lib/sym/extensions/instance_methods.rb,
lib/sym/app/commands/bash_completion.rb,
lib/sym/app/commands/keychain_add_key.rb,
lib/sym/app/private_key/base64_decoder.rb,
lib/sym/app/private_key/key_source_check.rb,
lib/sym/app/commands/password_protect_key.rb,
lib/sym/app/password/providers/memcached_provider.rb

Defined Under Namespace

Modules: App, CipherHandler, Constants, Data, Errors, Extensions Classes: Application, Configuration, MagicFile

Constant Summary collapse

VERSION = 
'3.0.0'
DESCRIPTION = 
<<~eof

   Sym is a ruby library (gem) that offers both the command line interface 
   (CLI) and a set of rich Ruby APIs, which make it rather trivial to add 
   encryption and decryption of sensitive data to your development or deployment 
   workflow.
   
   For additional security the private key itself can be encrypted with a 
   user-generated password. For decryption using the key the password can be 
   input into STDIN, or be defined by an ENV variable, or an OS-X Keychain Entry. 
   
   Unlike many other existing encryption tools, Sym focuses on getting out of 
   your way by offering a streamlined interface with password caching (if 
   MemCached is installed and running locally) in hopes to make encryption of 
   application secrets nearly completely transparent to the developers. 
   
   Sym uses symmetric 256-bit key encryption with the AES-256-CBC cipher, 
   same cipher as used by the US Government. 
   
   For password-protecting the key Sym uses AES-128-CBC cipher. The resulting 
   data is zlib-compressed and base64-encoded. The keys are also base64 encoded 
   for easy copying/pasting/etc.
   
   Sym accomplishes encryption transparency by combining several convenient features:
    
     1. Sym can read the private key from multiple source types, such as pathname, 
        an environment variable name, a keychain entry, or CLI argument. You simply 
        pass either of these to the -k flag — one flag that works for all source types.
    
     2. By utilizing OS-X Keychain on a Mac, Sym offers truly secure way of 
        storing the key on a local machine, much more secure then storing it on a file system,
    
     3. By using a local password cache (activated with -c) via an in-memory provider 
        such as memcached, sym invocations take advantage of password cache, and 
        only ask for a password once per a configurable time period, 
   
     4. By using SYM_ARGS environment variable, where common flags can be saved. This 
        is activated with sym -A,
    
     5. By reading the key from the default key source file ~/.sym.key which 
        requires no flags at all,
    
     6. By utilizing the --negate option to quickly encrypt a regular file, or decrypt 
        an encrypted file with extension .enc
    
     7. By implementing the -t (edit) mode, that opens an encrypted file in your $EDITOR, 
        and replaces the encrypted version upon save & exit, optionally creating a backup.
    
     8. By offering the Sym::MagicFile ruby API to easily read encrypted files into memory.

  Please refer the module documentation available here:
  https://www.rubydoc.info/gems/sym
   
eof

Class Method Summary collapse

Class Method Details

.config ⇒ Object 



120
121
122
 
# File 'lib/sym.rb', line 120

def config
  Sym::Configuration.config
end

.default_key ⇒ Object 



128
129
130
 
# File 'lib/sym.rb', line 128

def default_key
  File.read(default_key_file) rescue nil
end

.default_key? ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
 
# File 'lib/sym.rb', line 132

def default_key?
  File.exist?(default_key_file)
end

.default_key_file ⇒ Object 



124
125
126
 
# File 'lib/sym.rb', line 124

def default_key_file
  config.default_key_file
end