nginx_omniauth_adapter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3908b68bd6b56d6a923bca0dc36763e55645a03
-  data.tar.gz: 4aaf9ce2fdb95257094210060b44fdb9e533d163
+  metadata.gz: da45545a31a51031b94607551c7296f3011c3769
+  data.tar.gz: 79f17b771dffb86ff9527b78a7fbbe14d1a71bf1
 SHA512:
-  metadata.gz: 2b42a2d07c831778ea2b9c96e17e928cf2c5c0891edac619d89dfa74d27a14a0994469b2d8fb08e1082b3ce648659e9fbfdc7dcffe461679196621717199dc08
-  data.tar.gz: 366cf4d330531166973f61168e0ccbebf6cbcd7939e5ebc2dd91f87d15aa6cca0ecbca9b18463ce0e44b5b5e27406b6e3c034a889e2ac904dda3185fc9386de8
+  metadata.gz: 84be2b3d973d457a98b52ba75498b3dd84557012dd8fc9ddadeb5e2873fd9a80efb146f2177024214eadbaf1524814869f250c5ce972fce3e5bad3f61aad7714
+  data.tar.gz: 432c64e9ec6b1953947d6a8ed72e6c4eb019db5cf984cd62de39361c4d594ca7800be2686f25caae168c9b14f5ec24ccf8ae58ff951916ab049129a613687a6d

data/README.md

@@ -61,7 +61,7 @@ You can set configuration via environment variables.
 
 The following variables are only available on included config.ru:
 
-- `$NGX_OMNIAUTH_SESSION_COOKIE_NAME`: session cookie name (default `ngx_oauth`)
+- `$NGX_OMNIAUTH_SESSION_COOKIE_NAME`: session cookie name (default `ngx_omniauth`)
 - `$NGX_OMNIAUTH_SESSION_COOKIE_TIMEOUT`: session cookie expiry (default 3 days)
 - `$NGX_OMNIAUTH_DEV=1` or `$RACK_ENV=development`
   - enable dev mode (omniauth developer provider)
@@ -100,15 +100,15 @@ run NginxOmniauthAdapter.app(
 4. _nginx_ handles 401 with `error_page`, so do internal redirection (`/_auth/initiate`)
 5. _nginx_ handles `/_auth/initiate`. It will be proxied to _adapter app_ `GET /initiate`.
   - Also _nginx_ passes some information for callback to _adapter app._
-  - `x-ngx-oauth-initiate-back-to` URL to back after logged in
-  - `x-ngx-oauth-initiate-callback` URL that proxies to _adapter app_ `/callback`. This must be same domain to _backend app_ for cookie.
+  - `x-ngx-omniauth-initiate-back-to` URL to back after logged in
+  - `x-ngx-omniauth-initiate-callback` URL that proxies to _adapter app_ `/callback`. This must be same domain to _backend app_ for cookie.
 6. _adapter app_ `GET /initiate` redirects to `/auth/:provider`.
 7. _Browser_ do some authenticate in _adapter app_ with Omniauth.
-8. _adapter app's_ omniauth callback sets valid session, then redirects to `/_auth/callback`, where specified at `x-ngx-oauth-initiate-callback`.
+8. _adapter app's_ omniauth callback sets valid session, then redirects to `/_auth/callback`, where specified at `x-ngx-omniauth-initiate-callback`.
   - _Adapter app_ gives GET parameter named `session` on redirect. It contains encrypted session.
 9. _nginx_ handles `/_auth/callback`. It will be proxied to _adapter app_ `/callback`.
   - This decrypts given encrypted session string and set to cookie.
-  - Then redirect to `x-ngx-oauth-initiate-back-to`.
+  - Then redirect to `x-ngx-omniauth-initiate-back-to`.
 10. _browser_ backs to URL where attempted to access first, at step 1.
 11. _nginx_ sends auth subrequest to _backend app_ `/test`.
 12. _backend app_ `/test` returns 200, because request has valid session cookie.

data/config.ru

@@ -31,9 +31,9 @@ allowed_back_to_url      = if ENV['NGX_OMNIAUTH_ALLOWED_BACK_TO_URL']
 
 use(
   Rack::Session::Cookie,
-  key:          ENV['NGX_OMNIAUTH_SESSION_COOKIE_NAME'] || 'ngx_oauth',
+  key:          ENV['NGX_OMNIAUTH_SESSION_COOKIE_NAME'] || 'ngx_omniauth',
   expire_after: ENV['NGX_OMNIAUTH_SESSION_COOKIE_TIMEOUT'] ? ENV['NGX_OMNIAUTH_SESSION_COOKIE_TIMEOUT'].to_i : (60 * 60 * 24 * 3),
-  secret:       ENV['NGX_OMNIAUTH_SESSION_SECRET'] || 'ngx_oauth_secret_dev',
+  secret:       ENV['NGX_OMNIAUTH_SESSION_SECRET'] || 'ngx_omniauth_secret_dev',
   old_secret:   ENV['NGX_OMNIAUTH_SESSION_SECRET_OLD'],
 )
 

data/example/nginx-site.conf

@@ -29,12 +29,12 @@ server {
     error_page 401 = /_auth/initiate;
 
     # Receive user info from adapter
-    auth_request_set $ngx_oauth_provider $upstream_http_x_ngx_oauth_provider;
-    auth_request_set $ngx_oauth_user $upstream_http_x_ngx_oauth_user;
-    auth_request_set $ngx_oauth_info $upstream_http_x_ngx_oauth_info;
-    proxy_set_header x-ngx-oauth-provider $ngx_oauth_provider;
-    proxy_set_header x-ngx-oauth-user $ngx_oauth_user;
-    proxy_set_header x-ngx-oauth-info $ngx_oauth_info;
+    auth_request_set $ngx_omniauth_provider $upstream_http_x_ngx_omniauth_provider;
+    auth_request_set $ngx_omniauth_user $upstream_http_x_ngx_omniauth_user;
+    auth_request_set $ngx_omniauth_info $upstream_http_x_ngx_omniauth_info;
+    proxy_set_header x-ngx-omniauth-provider $ngx_omniauth_provider;
+    proxy_set_header x-ngx-omniauth-user $ngx_omniauth_user;
+    proxy_set_header x-ngx-omniauth-info $ngx_omniauth_info;
 
     # pass to backend application as usual as you do.
     proxy_pass http://app;
@@ -57,8 +57,8 @@ server {
     proxy_pass_request_body off;
     proxy_set_header Content-Length "";
     proxy_set_header Host $http_host;
-    proxy_set_header x-ngx-oauth-initiate-back-to http://$http_host$request_uri;
-    proxy_set_header x-ngx-oauth-initiate-callback http://$http_host/_auth/callback;
+    proxy_set_header x-ngx-omniauth-initiate-back-to http://$http_host$request_uri;
+    proxy_set_header x-ngx-omniauth-initiate-callback http://$http_host/_auth/callback;
     proxy_pass http://auth_adapter/initiate;
   }
 

data/example/test_backend.rb

@@ -5,9 +5,9 @@ get '/' do
   content_type :text
 
   {
-    provider: request.env['HTTP_X_NGX_OAUTH_PROVIDER'],
-    user: request.env['HTTP_X_NGX_OAUTH_USER'],
-    info: JSON.parse(request.env['HTTP_X_NGX_OAUTH_INFO'].unpack('m*')[0]),
+    provider: request.env['HTTP_X_NGX_OMNIAUTH_PROVIDER'],
+    user: request.env['HTTP_X_NGX_OMNIAUTH_USER'],
+    info: JSON.parse(request.env['HTTP_X_NGX_OMNIAUTH_INFO'].unpack('m*')[0]),
   }.to_json
 end
 

data/lib/nginx_omniauth_adapter/app.rb

@@ -6,7 +6,7 @@ require 'json'
 
 module NginxOmniauthAdapter
   class App < Sinatra::Base
-    CONTEXT_RACK_ENV_NAME = 'nginx-oauth2-adapter'.freeze
+    CONTEXT_RACK_ENV_NAME = 'nginx-omniauth-adapter'.freeze
     SESSION_PASS_CIPHER_ALGORITHM = 'aes-256-gcm'.freeze
 
     set :root, File.expand_path(File.join(__dir__, '..', '..', 'app'))
@@ -224,9 +224,9 @@ module NginxOmniauthAdapter
       end
 
       headers(
-        'x-ngx-oauth-provider' => current_user[:provider],
-        'x-ngx-oauth-user' => current_user[:uid],
-        'x-ngx-oauth-info' => [current_user[:info].to_json].pack('m*'),
+        'x-ngx-omniauth-provider' => current_user[:provider],
+        'x-ngx-omniauth-user' => current_user[:uid],
+        'x-ngx-omniauth-info' => [current_user[:info].to_json].pack('m*'),
       )
 
       content_type :text
@@ -234,11 +234,11 @@ module NginxOmniauthAdapter
     end
 
     get '/initiate' do
-      back_to = URI.encode_www_form_component(request.env['HTTP_X_NGX_OAUTH_INITIATE_BACK_TO'])
-      callback = URI.encode_www_form_component(request.env['HTTP_X_NGX_OAUTH_INITIATE_CALLBACK'])
+      back_to = URI.encode_www_form_component(request.env['HTTP_X_NGX_OMNIAUTH_INITIATE_BACK_TO'])
+      callback = URI.encode_www_form_component(request.env['HTTP_X_NGX_OMNIAUTH_INITIATE_CALLBACK'])
 
       if back_to == '' || callback == '' || back_to.nil? || callback.nil?
-        halt 400, {'Content-Type' => 'text/plain'}, 'x-ngx-oauth-initiate-back-to and x-ngx-oauth-initiate-callback header are required'
+        halt 400, {'Content-Type' => 'text/plain'}, 'x-ngx-omniauth-initiate-back-to and x-ngx-omniauth-initiate-callback header are required'
       end
 
       redirect "#{adapter_host}/auth?back_to=#{back_to}&callback=#{callback}"

data/lib/nginx_omniauth_adapter/version.rb

@@ -1,3 +1,3 @@
 module NginxOmniauthAdapter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/nginx_omniauth_adapter.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Shota Fukumori (sora_h)"]
   spec.email         = ["her@sorah.jp"]
 
-  spec.summary       = %q{oauth2 adapter for ngx_http_auth_request_module}
+  spec.summary       = %q{omniauth adapter for ngx_http_auth_request_module}
   spec.homepage      = "https://github.com/sorah/nginx_omniauth_adapter"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nginx_omniauth_adapter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Shota Fukumori (sora_h)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-01 00:00:00.000000000 Z
+date: 2015-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -157,5 +157,5 @@ rubyforge_project:
 rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
-summary: oauth2 adapter for ngx_http_auth_request_module
+summary: omniauth adapter for ngx_http_auth_request_module
 test_files: []