Skip to content

Support pii data removal #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Support pii data removal #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0aac102
Support pii data removal via config
Nov 30, 2020
d57853e
Update readme
Nov 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 0 additions & 25 deletions .github/workflows/cahngelog.yml
View file
Open in desktop

This file was deleted.

25 changes: 24 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,4 +186,27 @@ require 'securenative'
options = SecureNative::Options.new(api_key: 'API_KEY', max_events: 10, log_level: 'ERROR', proxy_headers: ['CF-Connecting-IP'])

SecureNative::Client.init_with_options(options)
```
```

## Remove PII Data From Headers

By default, SecureNative SDK remove any known pii headers from the received request.
We also support using custom pii headers and regex matching via configuration, for example:

### Option 1: Using config file
```yaml
"SECURENATIVE_API_KEY": YOUR_API_KEY
"SECURENATIVE_PII_HEADERS": ["apiKey"]
```

Initialize sdk as shown above.

### Options 2: Using ConfigurationBuilder

```ruby
require 'securenative'

options = SecureNative::Options.new(api_key: 'API_KEY', pii_regex_pattern: '((?i)(http_auth_)(\w+)?)')

SecureNative::Client.init_with_options(options)
```
9 changes: 6 additions & 3 deletions lib/securenative/config/configuration_builder.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@
module SecureNative
module Config
class ConfigurationBuilder
attr_reader :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy, :proxy_headers
attr_writer :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy, :proxy_headers
attr_reader :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy, :proxy_headers, :pii_headers, :pii_regex_pattern
attr_writer :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy, :proxy_headers, :pii_headers, :pii_regex_pattern

def initialize(api_key: nil, api_url: 'https://api.securenative.com/collector/api/v1', interval: 1000,
max_events: 1000, timeout: 1500, auto_send: true, disable: false, log_level: 'FATAL',
fail_over_strategy: SecureNative::FailOverStrategy::FAIL_OPEN, proxy_headers: nil)
fail_over_strategy: SecureNative::FailOverStrategy::FAIL_OPEN, proxy_headers: nil,
pii_headers: nil, pii_regex_pattern: nil)
@api_key = api_key
@api_url = api_url
@interval = interval
Expand All @@ -19,6 +20,8 @@ def initialize(api_key: nil, api_url: 'https://api.securenative.com/collector/ap
@log_level = log_level
@fail_over_strategy = fail_over_strategy
@proxy_headers = proxy_headers
@pii_headers = pii_headers
@pii_regex_pattern = @pii_regex_pattern
end

def self.default_securenative_options
Expand Down
4 changes: 3 additions & 1 deletion lib/securenative/config/configuration_manager.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ def self.load_config
disable: _get_env_or_default(properties, 'SECURENATIVE_DISABLE', options.disable),
log_level: _get_env_or_default(properties, 'SECURENATIVE_LOG_LEVEL', options.log_level),
fail_over_strategy: _get_env_or_default(properties, 'SECURENATIVE_FAILOVER_STRATEGY', options.fail_over_strategy),
proxy_headers: _get_env_or_default(properties, 'SECURENATIVE_PROXY_HEADERS', options.proxy_headers))
proxy_headers: _get_env_or_default(properties, 'SECURENATIVE_PROXY_HEADERS', options.proxy_headers),
pii_headers: _get_env_or_default(properties, 'SECURENATIVE_PII_HEADERS', options.pii_headers),
pii_regex_pattern: _get_env_or_default(properties, 'SECURENATIVE_REGEX_PATTERN', options.pii_regex_pattern))
end
end
end
Expand Down
6 changes: 3 additions & 3 deletions lib/securenative/context.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ def self.from_http_request(request, options)
client_token = SecureNative::Frameworks::Hanami.get_client_token(request) if client_token.nil?

begin
headers = SecureNative::Frameworks::Rails.get_headers(request)
headers = SecureNative::Frameworks::Sinatra.get_headers(request) if headers.nil?
headers = SecureNative::Frameworks::Hanami.get_headers(request) if headers.nil?
headers = SecureNative::Frameworks::Rails.get_headers(request, options)
headers = SecureNative::Frameworks::Sinatra.get_headers(request, options) if headers.nil?
headers = SecureNative::Frameworks::Hanami.get_headers(request, options) if headers.nil?

# Standard Ruby request
headers = request.header.to_hash if headers.nil?
Expand Down
48 changes: 41 additions & 7 deletions lib/securenative/frameworks/hanami.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ module SecureNative
module Frameworks
class Hanami
SECURENATIVE_COOKIE = '_sn'
PII_HEADERS = %w[authorization access_token apikey password passwd secret api_key]

def self.get_client_token(request)
begin
Expand Down Expand Up @@ -33,18 +34,51 @@ def self.get_method(request)
end
end

def self.get_headers(request)
def self.get_headers(request, options)
begin
headers = {}
if !options.pii_headers.nil?
request.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
if !header.downcase.in?(options.pii_headers) && !header.upcase.in?(options.pii_headers)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}

request.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
}
if headers.length == 0
request.headers.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
if !header.downcase.in?(options.pii_headers) && !header.upcase.in?(options.pii_headers)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}
end
elsif options.pii_regex_pattern.nil?
request.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
unless options.pii_regex_pattern.match(header)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}

if headers.length == 0
request.headers.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
if headers.length == 0
request.headers.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
unless options.pii_regex_pattern.match(header)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}
end
else
request.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
if !header.downcase.in?(PII_HEADERS) && !header.upcase.in?(PII_HEADERS)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}

if headers.length == 0
request.headers.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
if !header.downcase.in?(PII_HEADERS) && !header.upcase.in?(PII_HEADERS)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}
end
end
return headers
rescue StandardError
Expand Down
48 changes: 41 additions & 7 deletions lib/securenative/frameworks/rails.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ module SecureNative
module Frameworks
class Rails
SECURENATIVE_COOKIE = '_sn'
PII_HEADERS = %w[authorization access_token apikey password passwd secret api_key]

def self.get_client_token(request)
begin
Expand Down Expand Up @@ -35,18 +36,51 @@ def self.get_method(request)
end
end

def self.get_headers(request)
def self.get_headers(request, options)
begin
headers = {}
if !options.pii_headers.nil?
request.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
if !header.downcase.in?(options.pii_headers) && !header.upcase.in?(options.pii_headers)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}

request.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
}
if headers.length == 0
request.headers.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
if !header.downcase.in?(options.pii_headers) && !header.upcase.in?(options.pii_headers)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}
end
elsif options.pii_regex_pattern.nil?
request.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
unless options.pii_regex_pattern.match(header)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}

if headers.length == 0
request.headers.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
if headers.length == 0
request.headers.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
unless options.pii_regex_pattern.match(header)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}
end
else
request.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
if !header.downcase.in?(PII_HEADERS) && !header.upcase.in?(PII_HEADERS)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}

if headers.length == 0
request.headers.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
if !header.downcase.in?(PII_HEADERS) && !header.upcase.in?(PII_HEADERS)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}
end
end
return headers
rescue StandardError
Expand Down
48 changes: 41 additions & 7 deletions lib/securenative/frameworks/sinatra.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ module SecureNative
module Frameworks
class Sinatra
SECURENATIVE_COOKIE = '_sn'
PII_HEADERS = %w[authorization access_token apikey password passwd secret api_key]

def self.get_client_token(request)
begin
Expand Down Expand Up @@ -33,18 +34,51 @@ def self.get_method(request)
end
end

def self.get_headers(request)
def self.get_headers(request, options)
begin
headers = {}
if !options.pii_headers.nil?
request.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
if !header.downcase.in?(options.pii_headers) && !header.upcase.in?(options.pii_headers)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}

request.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
}
if headers.length == 0
request.headers.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
if !header.downcase.in?(options.pii_headers) && !header.upcase.in?(options.pii_headers)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}
end
elsif options.pii_regex_pattern.nil?
request.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
unless options.pii_regex_pattern.match(header)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}

if headers.length == 0
request.headers.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
if headers.length == 0
request.headers.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
unless options.pii_regex_pattern.match(header)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}
end
else
request.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
if !header.downcase.in?(PII_HEADERS) && !header.upcase.in?(PII_HEADERS)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}

if headers.length == 0
request.headers.env.select { |k, _| k.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || k =~ /^HTTP_/ }.each { |header|
if !header.downcase.in?(PII_HEADERS) && !header.upcase.in?(PII_HEADERS)
headers[header[0].downcase.gsub("http_", "").gsub("_", "-")] = header[1]
end
}
end
end
return headers
rescue StandardError
Expand Down