devise_pkcs12_authenticatable 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39f4ea9093428f249714901f66cfe03c24095307
-  data.tar.gz: 080c9912059e55f269faf3996aa72cbf3f0a20dd
+  metadata.gz: 40ff4fa4b8851a95458b12c85b50a296a4c1821b
+  data.tar.gz: 68545dd286347c8eafab88f1198e1bc3d275af1a
 SHA512:
-  metadata.gz: bfcd00a1814e20030ffa49a41c7a4b2176aeb7f7a4efb9bb8bbd8d5a6658dfe0757e445fbaf80f16773d52de69883547eb0bafa4946d0827b697e1d37f625e75
-  data.tar.gz: 6736276dfec95f164e0bf7170c6b07d2989f6bf354842f63ba649068199b90f7084265fcf05d464a58f4e71b68b432ac241b637ff88cb76e6a29f2d637ae2111
+  metadata.gz: aec7fb81e92c939d880c5290b5d777ed3d993a1517426d2c6d92bc837f0250cd4d9e6f87c50dbb2bb46ff00cbb4fbc02a16f58d7dd06fa8aa93d9cdefc662383
+  data.tar.gz: 01f1eb9cd6c97d81f6c355a2271aaf7f81ccf34549548ffe471c426ce2248f02c740903522ac59c4fdca7ace0f70c27b9073ee757e519a8b6292d55efc1aeddd

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog for `devise_pkcs12_authenticatable`
+
+## Version 0.0.2 - Apr 19, 2015
+
+* Initial version, added README

data/README.md

@@ -1,14 +1,22 @@
-# DevisePkcs12Authenticatable
+# Devise PKCS #12 Authenticatable [![Gem Version](https://badge.fury.io/rb/devise_pkcs12_authenticatable.svg)](http://badge.fury.io/rb/devise_pkcs12_authenticatable)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/devise_pkcs12_authenticatable`. To experiment with that code, run `bin/console` for an interactive prompt.
+`devise_pkcs12_authenticatable` is client side SSL certificate authentication (based on [PKCS #12](https://en.wikipedia.org/wiki/PKCS_12)) support for [Devise](https://github.com/plataformatec/devise) applications.
+For authentication `devise_pkcs12_authenticatable` uses field called `CN` (Common Name) from Distinguished Name (DN) of the SSl certificate subject
+and keys for any authentication mechanism from `config/initializers/devise.rb` called `config.authentication_keys`.
 
-TODO: Delete this and the text above, and describe your gem
+## Requirements
+
+- NGINX
+- Ruby 1.9.3 or greater
+- Rails 4.1.8 or greater
+- Devise 3.4.1 or greater
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this lines to your application's Gemfile:
 
 ```ruby
+gem 'devise', '~> 3.4.1'
 gem 'devise_pkcs12_authenticatable'
 ```
 
@@ -16,24 +24,52 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
+
+1. Setup [NGINX](http://wiki.nginx.org/Install) and [Configure HTTPS](http://nginx.org/en/docs/http/configuring_https_servers.html)
 
-    $ gem install devise_pkcs12_authenticatable
+  Add next parameters to `/path/to/your/site.conf`, for example in Ubuntu your configuration file can be found here: `/etc/nginx/sites-enabled/your-site.conf`
+  ```
+  server {
+    ...
+    ssl_verify_client on;
+    # Root Certificate Authority(CA) that you used to sign your client certificates
+    ssl_client_certificate /path/to/your/ca.crt;
+    ...
 
-## Usage
+    location ... {
+      ...
+      proxy_set_header X-CLIENT-VERIFY   $ssl_client_verify;
+      proxy_set_header X-SSL-CLIENT-S-DN $ssl_client_s_dn;
+      ...
+    }
+  }
+  ```
+
+2. Setup [Devise](https://github.com/plataformatec/devise)
+
+3. Setup `devise_pkcs12_authenticatable`
+
+  Add the following to your Devise model (ie. `User.rb`):
+
+  ```ruby
+  devise :pkcs12_authenticatable # , ... and other modules, don't add :database_authenticatable as this module is intended to replace it
+  ```
 
-TODO: Write usage instructions here
+  Your model needs one attribute called `cn`, migration allow you to do so:
 
-## Development
+    `add_column :users, :cn, :string, null: false, index: true`
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+  If you need to configure `devise_pkcs12_authenticatable` then add to your config/initializers/devise.rb
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+  ```ruby
+  Devise.setup do |config|
+    ...
+    # Attribute in your model for pkcs12 authentication
+    config.pkcs12_common_name_field = :common_name # By default :cn
+  end
+  ```
 
-## Contributing
+## License
 
-1. Fork it ( https://github.com/[my-github-username]/devise_pkcs12_authenticatable/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+`devise_pkcs12_authenticatable` is released under the MIT License. See the LICENSE file for more information.

data/lib/devise_pkcs12_authenticatable/version.rb

@@ -1,3 +1,3 @@
 module DevisePKCS12Authenticatable
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_pkcs12_authenticatable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alexander Grigoriev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -87,8 +87,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - devise_pkcs12_authenticatable.gemspec