soar_smaak 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37ab95cb119f68e830f45587aa09c336ac5f11b2
-  data.tar.gz: 731e14a0d878053d7b71ddee74dc69be3213469a
+  metadata.gz: 54105076178483895fe0e6a804ab68575c328dfa
+  data.tar.gz: 74883a8412232860c90b1d41b0d96f5ad7aa38ff
 SHA512:
-  metadata.gz: dd6abe2f923047b0ebe092c26cea8c01e364629b36fc91a5f24adbe0949865f3f34c6521f0a6f0af9bbd9450eaeb6e12b43d80a2fb22f23c44be0a71c12aab11
-  data.tar.gz: 18f28528d0518a32fe936868f23091705bf76047522fed6b3b02327770001bbb6dbdec65a7f874bcf59060bfb0f69fa8f340ea87721b73633363af3170e07086
+  metadata.gz: 903b24fcabbc5c8073de057a0ad30c39c86813209ff76c3013cb3b38f29e73e8b53823186ec6b2479f7abed52a8f067c57df772503c711038429ce27584b6114
+  data.tar.gz: 629977dec239617f6b7191e56d0abfb231954ee7c879dcf40cd8d25f6166ca634cb35b31bc60830a5fa89ac9d9d7e2572d04ecd5b0ebd8ecbc05e3601cf376a5

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 .ruby-gemset
 .ruby-version
+*.gem

data/README.md

@@ -1,12 +1,12 @@
 # SoarSmaak
 
-This library offers Rack middle-ware for SMAAK communication. SoarSmaak::Router will refuse request in case of any failure with a 500. Requests are examined to determine whether the route the request is destined for requires message signing, or whether the request itself is a SMAAK request. If either are true, the SMAAK message is interpreted and verified. The message is decrypted if it was encrypted, and passed to the rack application stack unencrypted, only if the signature is verified. After processing by the application stack, responses are signed into SMAAK responses, and encrypted if the authorization message indicated it should be. Non-SMAAK messages are passed through to the application stack without interpretation or verification.
+This library offers Rack middle-ware for SMAAK communication. Requests are examined to determine whether the route the request is destined for requires message signing, or whether the request itself is a SMAAK request. If either are true, the SMAAK message is interpreted and verified. The message is decrypted if it was encrypted, and passed to the rack application stack unencrypted, only if the signature is verified. After processing by the application stack, responses are signed into SMAAK responses, and encrypted if the authorization message indicated it should be. Non-SMAAK messages are passed through to the application stack without interpretation or verification. SoarSmaak::Router will refuse requests with a 500 in the case of any failures.
 
 ## Dependencies
 
-### configuration
+### configuration : optional
 
-A dictionary including a SMAAK public and private key identifying the service component in question, as well as an optional associations dictionary with the identity and public key and pre-shared key of associations that the SMAAK middleware should verify. An example follows:
+A dictionary including a SMAAK public and private key identifying the service component in question, as well as an optional associations dictionary with the identity and public key and pre-shared key of associations that the SMAAK middleware should verify. If a configuration is not provided, SMAAK will be disabled. An example follows:
 
 ```
 public_key: |
@@ -28,16 +28,16 @@ associations:
     psk: 655U0Rw6Rk12
 ```
 
-### signed_routes
+### signed_routes: optional
 
-A dictionary of paths and an indication whether the route is signed, e.g.
+A dictionary of paths and an indication whether the route is signed. If no routes are signed, SMAAK requests will still be verified if detected. If signed routes are provided, SMAAK verification will be done and non-SMAAK requests will be refused on those routes. E.g.
 
 ```
   { "/secure-service" => true,
     "/another-service" => false }
 ```
 
-### auditing
+### auditing: optional
 
 An auditing provider that adheres to the API specified here: https://rubygems.org/gems/soar_auditor_api. If an auditing provider is not present, $stderr will be used.
 

data/lib/soar_smaak/version.rb

@@ -1,3 +1,3 @@
 module SoarSmaak
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soar_smaak
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ernst Van Graan