soar_aspects 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rspec +2 -0
- data/.travis.yml +5 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +60 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/soar_aspects.rb +46 -0
- data/lib/soar_aspects/version.rb +3 -0
- data/soar_aspects.gemspec +33 -0
- metadata +99 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: da29884687701e891aca1fef54651bb5801cf93c
|
4
|
+
data.tar.gz: f29e293808d76e4254a35f878d715452c4eafb58
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 87a5c90fa215f093deb0718ee36c9687b9e8003f1718cdab6013b80d0e2a81cbe394e4e3db3d4129292525580b8f93d89fca185d18c47d42a217e53d0f192aa7
|
7
|
+
data.tar.gz: 37414486f4f3426812e5fbc1624d64f8508b0ff02778b4a4e9f8a4d92848f5ecd92784531264a45dae5003aa6f6adaa454ff4c5e9361c89a0ea3a385a98b35af
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2016 Ernst Van Graan
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,60 @@
|
|
1
|
+
# SoarAspects
|
2
|
+
|
3
|
+
This library facilitates injection of SOAR aspects into the rack middleware env, making the aspects available to other middleware.
|
4
|
+
|
5
|
+
Aspects currently supported:
|
6
|
+
- configuration
|
7
|
+
- auditing
|
8
|
+
- route signatures
|
9
|
+
|
10
|
+
## Installation
|
11
|
+
|
12
|
+
Add this line to your application's Gemfile:
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
gem 'soar_aspects'
|
16
|
+
```
|
17
|
+
|
18
|
+
And then execute:
|
19
|
+
|
20
|
+
$ bundle
|
21
|
+
|
22
|
+
Or install it yourself as:
|
23
|
+
|
24
|
+
$ gem install soar_aspects
|
25
|
+
|
26
|
+
## Usage
|
27
|
+
|
28
|
+
SoarAspects::config = @config
|
29
|
+
SoarAspects::signed_routes = @signed_routes
|
30
|
+
SoarAspects::auditing = @auditing
|
31
|
+
use SoarAspects
|
32
|
+
|
33
|
+
### configuration
|
34
|
+
|
35
|
+
A configuration of interest to your middleware. In the SOAR architecture the configuration is a dictionary.
|
36
|
+
|
37
|
+
### signed_routes
|
38
|
+
|
39
|
+
SOAR routing middleware is interested in the meta of routes, such as security NFRs. signed_routes is a dictionary keyed by route path, and with a boolean value indicating whether the route should be signed. E.g.
|
40
|
+
|
41
|
+
```
|
42
|
+
{ '/secure' => true, '/unsecure' => false }
|
43
|
+
```
|
44
|
+
|
45
|
+
### auditing
|
46
|
+
|
47
|
+
SOAR uses auditors for logging and other reporting. auditing here is an object that adheres to https://rubygems.org/gems/soar_auditor_api
|
48
|
+
|
49
|
+
## Contributing
|
50
|
+
|
51
|
+
Please send feedback and comments to the author at:
|
52
|
+
|
53
|
+
Ernst van Graan <ernst.van.graan@hetzner.co.za>
|
54
|
+
|
55
|
+
This gem is sponsored by Hetzner (Pty) Ltd - http://hetzner.co.za
|
56
|
+
|
57
|
+
## License
|
58
|
+
|
59
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
60
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "soar_aspects"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
data/lib/soar_aspects.rb
ADDED
@@ -0,0 +1,46 @@
|
|
1
|
+
require "soar_aspects/version"
|
2
|
+
|
3
|
+
module SoarAspects
|
4
|
+
class Aspects
|
5
|
+
attr_reader :app
|
6
|
+
|
7
|
+
@@configuration = nil
|
8
|
+
@@signed_routes = nil
|
9
|
+
@@auditing = nil
|
10
|
+
|
11
|
+
def self.configuration=(configuration)
|
12
|
+
@@configuration = configuration
|
13
|
+
end
|
14
|
+
|
15
|
+
def self.configuration
|
16
|
+
@@configuration
|
17
|
+
end
|
18
|
+
|
19
|
+
def self.signed_routes=(signed_routes)
|
20
|
+
@@signed_routes = signed_routes
|
21
|
+
end
|
22
|
+
|
23
|
+
def self.signed_routes
|
24
|
+
@@signed_routes
|
25
|
+
end
|
26
|
+
|
27
|
+
def self.auditing=(auditing)
|
28
|
+
@@auditing = auditing
|
29
|
+
end
|
30
|
+
|
31
|
+
def self.auditing
|
32
|
+
@@auditing
|
33
|
+
end
|
34
|
+
|
35
|
+
def initialize(app)
|
36
|
+
@app = app
|
37
|
+
end
|
38
|
+
|
39
|
+
def call(env)
|
40
|
+
env['configuration'] = @@configuration
|
41
|
+
env['signed_routes'] = @@signed_routes
|
42
|
+
env['auditing'] = @@auditing
|
43
|
+
@app.call(env)
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
@@ -0,0 +1,33 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'soar_aspects/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "soar_aspects"
|
8
|
+
spec.version = SoarAspects::VERSION
|
9
|
+
spec.authors = ["Ernst Van Graan"]
|
10
|
+
spec.email = ["ernst.van.graan@hetzner.co.za"]
|
11
|
+
|
12
|
+
spec.summary = %q{Library facilitating seeding of SOAR aspects in the rack environment}
|
13
|
+
spec.description = %q{Library facilitating seeding of SOAR aspects in the rack environment}
|
14
|
+
spec.homepage = "https://github.com/hetznerZA/soar_aspects"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
|
18
|
+
# to allow pushing to a single host or delete this section to allow pushing to any host.
|
19
|
+
# if spec.respond_to?(:metadata)
|
20
|
+
# spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
|
21
|
+
# else
|
22
|
+
# raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
|
23
|
+
# end
|
24
|
+
|
25
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
26
|
+
spec.bindir = "exe"
|
27
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
28
|
+
spec.require_paths = ["lib"]
|
29
|
+
|
30
|
+
spec.add_development_dependency "bundler", "~> 1.12"
|
31
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
32
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
33
|
+
end
|
metadata
ADDED
@@ -0,0 +1,99 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: soar_aspects
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Ernst Van Graan
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-07-14 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.12'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.12'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.0'
|
55
|
+
description: Library facilitating seeding of SOAR aspects in the rack environment
|
56
|
+
email:
|
57
|
+
- ernst.van.graan@hetzner.co.za
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- ".gitignore"
|
63
|
+
- ".rspec"
|
64
|
+
- ".travis.yml"
|
65
|
+
- Gemfile
|
66
|
+
- LICENSE.txt
|
67
|
+
- README.md
|
68
|
+
- Rakefile
|
69
|
+
- bin/console
|
70
|
+
- bin/setup
|
71
|
+
- lib/soar_aspects.rb
|
72
|
+
- lib/soar_aspects/version.rb
|
73
|
+
- soar_aspects.gemspec
|
74
|
+
homepage: https://github.com/hetznerZA/soar_aspects
|
75
|
+
licenses:
|
76
|
+
- MIT
|
77
|
+
metadata: {}
|
78
|
+
post_install_message:
|
79
|
+
rdoc_options: []
|
80
|
+
require_paths:
|
81
|
+
- lib
|
82
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
83
|
+
requirements:
|
84
|
+
- - ">="
|
85
|
+
- !ruby/object:Gem::Version
|
86
|
+
version: '0'
|
87
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
88
|
+
requirements:
|
89
|
+
- - ">="
|
90
|
+
- !ruby/object:Gem::Version
|
91
|
+
version: '0'
|
92
|
+
requirements: []
|
93
|
+
rubyforge_project:
|
94
|
+
rubygems_version: 2.5.1
|
95
|
+
signing_key:
|
96
|
+
specification_version: 4
|
97
|
+
summary: Library facilitating seeding of SOAR aspects in the rack environment
|
98
|
+
test_files: []
|
99
|
+
has_rdoc:
|