trocla 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA512: 
-  data.tar.gz: a56b787f5de6d03d6549ba0ff7a0bd99f33df521d77e3bbdbc22f2b8b55ae0bb8e1011c3a43eb6c7bd067066d8e6ad9837ab0aa87aad97e5e45b0fddc45a88a1
-  metadata.gz: e33922bae12b243f51cce3508ae7765e75b43f1cad57bd913d01f90a1c6da8ccde41764b186743d62c10eafe8ddc20f01a872fecc0d7f178e16faae4268afc43
-SHA1: 
-  data.tar.gz: 52fad21a71a8885e4bd731df9e14200e3c97e08f
-  metadata.gz: 31e837a767930953bf64f2e724aaa80b2dabfb5c
+---
+SHA1:
+  metadata.gz: 5013d3c6ab75dc39bbbb5f7c8a77b19f7b5bed1c
+  data.tar.gz: bffc23e9979133c7303c7fde6b4b7a24fe367f8b
+SHA512:
+  metadata.gz: 009e2b762c641a8f10be76d673a3860b98cd3dd91a27b77da5d0775c9312da26f454c1c54a039bc9011d25c6c77dd6813b87007e0a71dcab35839fb09d5a3457
+  data.tar.gz: e873f4ac50bebf1ab00eddb06b3c9cca0040783a46195391f7064cebba0b2c47648454cef391e20831c405ff6280d2354f249050eb5605452f8e1f3f5becbdc7

data/.travis.yml

@@ -1,5 +1,9 @@
 language: ruby
+sudo: false
 rvm:
+  - jruby-18mode
+  - jruby-19mode
+  - 2.2.0
   - 2.1.0
   - 2.0.0
   - 1.9.3

data/Gemfile

@@ -11,12 +11,14 @@ else
   gem "highline", "~> 1.6.2"
 end
 
+if defined?(RUBY_ENGINE) && (RUBY_ENGINE == 'jruby')
+  gem 'jruby-openssl'
+end
 gem "bcrypt"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "mocha"
   if RUBY_VERSION.to_f > 1.8
     gem "rspec"
     gem "rdoc"
@@ -26,4 +28,5 @@ group :development do
     gem "rdoc", "~> 3.8"
     gem "jeweler", "~> 1.6"
   end
+  gem 'rspec-pending_for'
 end

data/README.md

@@ -11,21 +11,26 @@ Furthermore it provides you a simple cli that helps you to modify the password
 storage from the cli.
 
 Trocla does not only create and/or store a plain password, it is also able to
-generate (and store) any kind hashed passwords based on the plain password.
+generate (and store) any kind of hashed passwords based on the plain password.
 As long as the plain password is preset, trocla is able to generate any kind
 of hashed passwords through an easy extendible plugin system.
 
 It is not necessary to store the plain password on the server, you can also
 just feed trocla with the hashed password and use that in your other tools.
 A common example for that is that you let puppet retrieve (and hence create)
-a salted md5 password for a user. This will then store the salted md5 of
+a salted sha512 password for a user. This will then store the salted sha512 of
 a random password AND the plain text password in trocla. Later you can
 retrieve (by deleting) the plain password and send it to the user. Puppet
 will still simply retrieve the hashed password that is stored in trocla,
 while the plain password is not anymore stored on the server.
 
-You can use any kind of key/value based storage supported by moneta for
-trocla. By default it uses a simple yaml file.
+Be default trocla uses moneta to store the passwords and can use any kind of
+key/value based storage supported by moneta for trocla. By default it uses a
+simple yaml file.
+However, since version 0.2.0 trocla also supports a pluggable storage backend
+which allows you to write your custom backend. See more about stores below.
+
+Trocla can also be integrated into [Hiera](https://docs.puppetlabs.com/hiera/) by using ZeroPointEnergy's [hiera-backend](https://github.com/ZeroPointEnergy/hiera-backend-trocla).
 
 ## Usage
 
@@ -59,8 +64,11 @@ This will create a pgsql password hash using the username user1.
 
 Valid global options are:
 
-* length: int - Define any lenght that a newly created password should have. Default: 12 - or whatever you define in your global settings.
+* length: int - Define any lenght that a newly created password should have. Default: 16 - or whatever you define in your global settings.
 * charset: (default|alphanumeric|shellsafe) - Which set of chars should be used for a random password? Default: default - or whatever you define in your global settings.
+* profiles: a profile name or an array of profiles matching a profile_name in your configuration. Learn more about profiles below.
+* random: boolean - Whether we allow creation of random passwords or we expect a password to be preset. Default: true - or whatever you define in your global settings.
+* expires: An integer indicating the amount of seconds a value (e.g. password) is available. After expiration a value will not be available anymore and trying to `get` this key will return no value (nil). Meaning that calling create after expiration, would create a new password automatically. There is more about expiration in the storage backends section.
 
 Example:
 
@@ -88,15 +96,22 @@ far.
     trocla set user3 plain
 
 This will ask you for a password and set it under the appropriate key/format.
+We expect a plain password to be entered and will format the password with
+the selected format before storing it.
 
     trocla set --password mysupersecretpassword user4 plain
 
 This will take the password from the cli without asking you.
 
-    trocla set user5 mysql -p *ABC....
+    trocla set user5 mysql -p mysuperdbpassword
 
 This will store a mysql sha1 hash for the key user5, without storing any kind
 of plain text password.
+If you like trocla not to format a password, as you are passing in an already
+formatted password (like the sha512 hash), then you must use `--no-format` to
+skip formatting. Like:
+
+    trocla set user5 sha512crypt --no-format -p '$6$1234$xxxx....'
 
 You can also pipe in a password:
 
@@ -124,37 +139,140 @@ deleted as well, as the hashes wouldn't match anymore the plain text password.
 
 This will delete the plain password of the key user1 and return it.
 
+### formats
+
+    trocla formats
+
+This will list all available and supported formats.
+
 ## Attention
 
 If you don't feed trocla initially with a hash and/or delete the generated
 plain text passwords trocla will likely create a lot of plain text passwords
 and store them on your machine/server. This is by intend and is all about which
 problems (mainly passwords in configuration management manifests) trocla tries
-to address.
+to address. It is possible to store all passwords encrypted in the specific
+backend.
+See backend encryption for more information, however be aware that the key must
+always also reside on the trocla node. So it mainly makes sense if you store
+them on a remote backend like a central database server.
+
+## Formats
+
+Most formats are straight forward to use. Some formats require some additional
+options to work properly. These are documented here:
+
+### pgsql
+
+Password hashes for PostgreSQL servers. Requires the option `username` to be set
+to the username to which the password will be assigned.
+
+### x509
+
+This format takes a set of additional options. Required are:
+
+    subject: A subject for the target certificate. E.g. /C=ZZ/O=Trocla Inc./CN=test/emailAddress=example@example.com
+    OR
+    CN: The CN of the the target certificate. E.g. 'This is my self-signed certificate which doubles as CA'
+
+Additional options are:
+
+    ca                The trocla key of CA (imported into or generated within trocla) that
+                      will be used to sign that certificate.
+    become_ca         Whether the certificate should become a CA or not. Default: false,
+                      to enable set it to true.
+    hash              Hash to be used. Default sha2
+    keysize           Keysize for the new key. Default is: 4096
+    serial            Serial to be used, default is selecting a random one.
+    days              How many days should the certificate be valid. Default 365
+    C                 instead within the subject string
+    ST                instead within the subject string
+    L                 instead within the subject string
+    O                 instead within the subject string
+    OU                instead within the subject string
+    emailAddress      instead within the subject string
+    altnames          An array of subjectAltNames. By default for non CA certificates we
+                      ensure that the CN ends up here as well. If you don't want that.
+                      You need to pass an empty array.
+    name_constraints  An array of domains that are added as permitted x509 NameConstraint.
+                      By default, we do not add any contraint, meaning all domains are
+                      signable by the CA, as soon as we have one item in the list, only
+                      DNS entries matching this list are allowed. Be aware, that older
+                      openssl versions have a bug with [leading dots](https://rt.openssl.org/Ticket/Display.html?id=3562) for name
+                      constraints. So using them might not work everywhere as expected.
 
 ## Installation
 
-Simply build and install the gem. 
+Simply build and install the gem.
 
 ## Configuration
 
 Trocla can be configured in /etc/troclarc.yaml and in ~/.troclarc.yaml. A sample configuration file can be found in `lib/trocla/default_config.yaml`.
+By default trocla configures moneta to store all data in /tmp/trocla.yaml
+
+### Profiles
+
+It is possible to define profiles within the configuration file. The idea behind profiles are to make it easy to group together certain options for
+automatic password generation.
+
+Trocla ships with a default set of profiles, which are part of the `lib/trocla/default_config.yaml` configuration file. It is possible to override
+the existing profiles within your own configuration file, as well as adding more. Note that the profiles part of the configuration file is merged
+together and your configuration file has precedence.
+
+The profiles part in the config is a hash where each entry consist of a name (key) and a hash of options (value).
+
+Profiles make it especially easy to define a preset of options for SSL certificates as you will only need to set the certificate specific options,
+while global options such as C, O or OU can be preset within the profile.
+
+Profiles are used by setting the profiles option to a name of the pre-configured profiles, when passing options to the password option. On the cli
+this looks like:
+
+    trocla create foo plain 'profiles: rootpw'
+
+It is possible to pass mutliple profiles as an array, while the order will also reflect the precedence of the options.
+
+Also it is possible to set a default profiles option in the options part of the configuration file.
 
 ### Storage backends
 
-Trocla can store your passwords in all backends supported by moneta. A simple YAML file configuration may look as follows:
+Trocla has a pluggable storage backend, which allows you to choose the way that values are stored (persistently).
+Such a store is a simple class that implements Trocla::Store and at the moment there are the following store implementations:
+
+* Moneta - the default store using [moneta](https://rubygems.org/gems/moneta) to delegate storing the values
+* Memory - simple inmemory backend. Mainly used for testing.
+
+The backend is chosen based on the `store` configuration option. If it is a symbol, we expect it to be a store that we ship with trocla. Otherwise, we assume it to be a fully qualified ruby class name, that inherits from Trocla::Store. If trocla should load an additional library to be able to find your custom store class, you can set `store_require` to whatever should be passed to a ruby require statement.
+
+Store backends can be configured through the `store_options` configuration.
+
+#### Expiration
+
+We expect storage backends to implement support for the `expires` option, so that keys expire after the passed amount of seconds. Furthermore a storage backend needs to implement the behaviour described by the rspec shared_example 'store_validation' section 'expiration'. Mainly:
+
+* Expiration is always for all formats per key.
+* Adding, deleting or updating a format will keep the existing expiration, but reset the planned expiration.
+* While setting a new plain format will not only erase all other formats, but also erase/reset any expires.
+* Setting a value with an expires option of 0 or false, will remove any existent expiration.
+
+New backends should be tested using the provided shared example.
+
+#### Moneta backends
+
+Trocla uses moneta as its default storage backend and hence can store your passwords in any of moneta's supported backends. By default it uses the yaml backend, which is configured as followed:
 
 ```YAML
-adapter: :YAML
-adapter_options:
+store_options:
+  adapter: :YAML
+  adapter_options:
     :file: '/tmp/trocla.yaml'
 ```
 
 In environments with multiple Puppet masters using an existing DB cluster might make sense. The configured user needs to be granted at least SELECT, INSERT, UPDATE, DELETE and CREATE permissions on your database:
 
 ```YAML
-adapter: :Sequel
-adapter_options:
+store_options:
+  adapter: :Sequel
+  adapter_options:
     :db: 'mysql://db.server.name'
     :user: 'trocla'
     :password: '***'
@@ -162,21 +280,50 @@ adapter_options:
     :table: 'trocla'
 ```
 
-These examples are by no way complete, moneta has much more to offer.
+These examples are by no way complete, moneta has much more to offer. Please have a look at [moneta's documentation](https://github.com/minad/moneta/blob/master/README.md) for further information.
 
-### SSL encryption
+### Backend encryption
 
-You might want to let Trocla encrypt all your passwords
+By default trocla does not encrypt anything it stores. You might want to let Trocla encrypt all your passwords, at the moment the only supported way is SSL.
+Given that often trocla's store is on the same system at it's being used, there might be little sense to encrypt everything while the encryption keys are on the same system. However, if you are for example using an existing DB cluster using backend encryption you won't store any plaintext passwords within the database system.
+
+### Backend SSL encryption
+
+To enable SSL encryption (e.g. by using your puppet masters SSL keys), you need to set the following configuration options:
 
 ```YAML
 encryption: :ssl
-ssl_options:
+encryption_options:
     :private_key: '/var/lib/puppet/ssl/private_keys/trocla.pem'
     :public_key: '/var/lib/puppet/ssl/public_keys/trocla.pem'
 ```
 
 ## Update & Changes
 
+### to 0.2.0
+
+1. New feature profiles: Introduce profiles to make it easy to have a default set of properties. See the profiles section for more information.
+1. New feature expiration: Make it possible that keys can have an expiration. See the expiration section for more information.
+1. Increase default password length to 16.
+1. Add a console safe password charset. It should provide a subset of chars that are easier to type on a physical keyboard.
+1. Fix a bug with encryptions while deleting all formats.
+1. Introduce pluggable stores, so in the future we are able to talk to different backends and not only moneta. For testing and inspiration a simple in memory storage backend was added.
+1. CHANGE: moneta's configuration for `adapter` & `adapter_options` now live under store_options in the configuration file. Till 0.3.0 old configuration entries will still be accepted.
+1. CHANGE: ssl_options is now known as encryption_options. Till 0.3.0 old configuration entries will still be accepted.
+1. Improve randomness when creating a serial number.
+1. Add a new charset: hexadecimal
+1. Add support for name constraints within the x509 format
+1. Clarify documentation of the set action, as well as introduce `--no-format` for the set action.
+
+### to 0.1.3
+
+1. CHANGE: Self signed certificates are no longer CAs by default, actually they have never been due to a bug. If you want that a certificate is also a CA, you *must* pass `become_ca: true` to the options hash. But this makes it actually possible, that you can even have certificate chains. Thanks for initial hint to [Adrien Bréfort](https://github.com/abrefort)
+1. Default keysize is now 4096
+1. SECURITY: Do not increment serial, rather choose a random one.
+1. Fixing setting of altnames, was not possible due to bug, till now.
+1. Add extended tests for the x509 format, that describe all the internal specialities and should give an idea how it can be used.
+1. Add cli option to list all formats
+
 ### to 0.1.1
 
 1. fix storing data longer that public Keysize -11. Thanks [Timo Goebel](https://github.com/timogoebel)

data/bin/trocla

@@ -9,12 +9,12 @@ require 'yaml'
 options = { :config_file => nil, :ask_password => true, :trace => false }
 
 OptionParser.new do |opts|
-  opts.on("--version", "-V", "Version information") do
+  opts.on('--version', '-V', 'Version information') do
     puts Trocla::VERSION::STRING
     exit
   end
 
-  opts.on("--config CONFIG", "-c", "Configuration file") do |v|
+  opts.on('--config CONFIG', '-c', 'Configuration file') do |v|
     if File.exist?(v)
       options[:config_file] = v
     else
@@ -23,19 +23,23 @@ OptionParser.new do |opts|
     end
   end
 
-  opts.on("--trace", "Show stack trace on failure") do
+  opts.on('--trace', 'Show stack trace on failure') do
     options[:trace] = true
   end
 
-  opts.on("--no-random") do
+  opts.on('--no-random', 'Do not generate a random password if there is no plain text password available') do
     options['random'] = false
   end
 
-  opts.on("--length LENGTH") do |v|
+  opts.on('--no-format', 'Do not format a password when setting it using `set`') do
+    options['no_format'] = true
+  end
+
+  opts.on('--length LENGTH', 'Length for a randomly created password') do |v|
     options['length'] = v.to_i
   end
 
-  opts.on("--password [PASSWORD]", "-p", "Provide password at command line") do |pass|
+  opts.on('--password [PASSWORD]', '-p', 'Provide password at command line or STDIN') do |pass|
     options[:ask_password] = false
     options[:password] = pass
   end
@@ -59,23 +63,29 @@ end
 def set(options)
   if options.delete(:ask_password)
     require 'highline/import'
-    password = ask("Enter your password: ") { |q| q.echo = "x" }.to_s
-    pwd2 = ask("Repeat password: ") { |q| q.echo = "x" }.to_s
+    password = ask('Enter your password: ') { |q| q.echo = 'x' }.to_s
+    pwd2 = ask('Repeat password: ') { |q| q.echo = 'x' }.to_s
     unless password == pwd2
-      STDERR.puts "Passwords did not match, exiting!"
+      STDERR.puts 'Passwords did not match, exiting!'
       exit 1
     end
   else
     password = options.delete(:password) || STDIN.read.chomp
   end
   format = options.delete(:trocla_format)
+  no_format = options.delete('no_format')
   trocla = Trocla.new(options.delete(:config_file))
+  value = if no_format
+    password
+  else
+    trocla.formats(format).format(password, options.delete(:other_options).shift.to_s)
+  end
   trocla.set_password(
     options.delete(:trocla_key),
     format,
-    trocla.formats(format).format(password, options.delete(:other_options).shift.to_s)
+    value
   )
-  ""
+  ''
 end
 
 def reset(options)
@@ -93,9 +103,13 @@ def delete(options)
   )
 end
 
+def formats(options)
+  "Available formats: #{Trocla::Formats.all.join(', ')}"
+end
+
 def check_format(format_name)
   if format_name.nil?
-    STDERR.puts "Missing format, exiting..."
+    STDERR.puts 'Missing format, exiting...'
     exit 1
   elsif !Trocla::Formats.available?(format_name)
     STDERR.puts "Error: The format #{format_name} is not available"
@@ -103,13 +117,13 @@ def check_format(format_name)
   end
 end
 
-actions=['create','get','set','reset','delete']
+actions=['create','get','set','reset','delete', 'formats' ]
 
-if !(ARGV.length < 2) && (action=ARGV.shift) && actions.include?(action)
+if (action=ARGV.shift) && actions.include?(action)
     options[:trocla_key] = ARGV.shift
     options[:trocla_format] = ARGV.shift
     options[:other_options] = ARGV
-    check_format(options[:trocla_format]) unless action == 'delete'
+    check_format(options[:trocla_format]) unless ['delete','formats'].include?(action)
     begin
       if result = send(action,options)
         puts result.is_a?(String) ? result : result.inspect
@@ -117,13 +131,14 @@ if !(ARGV.length < 2) && (action=ARGV.shift) && actions.include?(action)
     rescue Exception => e
       unless e.message == 'exit'
         STDERR.puts "Action failed with the following message: #{e.message}"
-        STDERR.puts "(See full trace by running task with --trace)"
+        STDERR.puts '(See full trace by running task with --trace)'
       end
       raise e if options[:trace]
       exit 1
     end
 else
     STDERR.puts "Please supply one of the following actions: #{actions.join(', ')}"
+    STDERR.puts "Use #{$0} --help to get a list of options for these actions"
     exit 1
 end
 

data/lib/VERSION

@@ -1,4 +1,4 @@
 major:0
-minor:1
-patch:2
+minor:2
+patch:0
 build: