Skip to content

Add SAML authentication request attributes to logging metadata #8329

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

Merged
mitchellhenke merged 1 commit into from
May 4, 2023
Merged

Add SAML authentication request attributes to logging metadata #8329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions app/controllers/saml_idp_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,8 @@ def log_external_saml_auth_request

analytics.saml_auth_request(
requested_ial: requested_ial,
requested_aal_authn_context: saml_request&.requested_aal_authn_context,
force_authn: saml_request&.force_authn?,
service_provider: saml_request&.issuer,
)
end
Expand Down
6 changes: 6 additions & 0 deletions app/services/analytics_events.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2684,17 +2684,23 @@ def saml_auth(
end

# @param [Integer] requested_ial
# @param [String,nil] requested_aal_authn_context
# @param [Boolean,nil] force_authn
# @param [String] service_provider
# An external request for SAML Authentication was received
def saml_auth_request(
requested_ial:,
requested_aal_authn_context:,
force_authn:,
service_provider:,
**extra
)
track_event(
'SAML Auth Request',
{
requested_ial: requested_ial,
requested_aal_authn_context: requested_aal_authn_context,
force_authn: force_authn,
service_provider: service_provider,
**extra,
}.compact,
Expand Down
23 changes: 23 additions & 0 deletions spec/controllers/saml_idp_controller_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,6 +569,7 @@ def name_id_version(format_urn)
with('SAML Auth Request', {
requested_ial: authn_context,
service_provider: sp1_issuer,
force_authn: false,
})
expect(@analytics).to receive(:track_event).
with('SAML Auth', {
Expand Down Expand Up @@ -710,6 +711,7 @@ def name_id_version(format_urn)
with('SAML Auth Request', {
requested_ial: 'ialmax',
service_provider: sp1_issuer,
force_authn: false,
})
expect(@analytics).to receive(:track_event).
with('SAML Auth', {
Expand Down Expand Up @@ -925,6 +927,19 @@ def name_id_version(format_urn)
saml_final_post_auth(saml_request(saml_settings(overrides: { force_authn: true })))
expect(session[:sp][:final_auth_request]).to be_falsey
end

it 'logs SAML Auth Request' do
stub_analytics
expect(@analytics).to receive(:track_event).
with('SAML Auth Request', {
requested_ial: Saml::Idp::Constants::IAL1_AUTHN_CONTEXT_CLASSREF,
service_provider: 'http://localhost:3000',
requested_aal_authn_context: Saml::Idp::Constants::AAL2_AUTHN_CONTEXT_CLASSREF,
force_authn: true,
})

saml_get_auth(saml_settings(overrides: { force_authn: true }))
end
end

context 'service provider is inactive' do
Expand Down Expand Up @@ -1549,6 +1564,8 @@ def name_id_version(format_urn)
with('SAML Auth Request', {
requested_ial: Saml::Idp::Constants::IAL1_AUTHN_CONTEXT_CLASSREF,
service_provider: 'http://localhost:3000',
requested_aal_authn_context: Saml::Idp::Constants::AAL2_AUTHN_CONTEXT_CLASSREF,
force_authn: false,
})

saml_get_auth(saml_settings)
Expand Down Expand Up @@ -1992,6 +2009,8 @@ def name_id_version(format_urn)
with('SAML Auth Request', {
requested_ial: Saml::Idp::Constants::IAL2_AUTHN_CONTEXT_CLASSREF,
service_provider: 'http://localhost:3000',
requested_aal_authn_context: Saml::Idp::Constants::AAL2_AUTHN_CONTEXT_CLASSREF,
force_authn: false,
})
expect(@analytics).to receive(:track_event).
with('SAML Auth', analytics_hash)
Expand Down Expand Up @@ -2037,6 +2056,8 @@ def stub_requested_attributes
with('SAML Auth Request', {
requested_ial: Saml::Idp::Constants::IAL1_AUTHN_CONTEXT_CLASSREF,
service_provider: 'http://localhost:3000',
requested_aal_authn_context: Saml::Idp::Constants::AAL2_AUTHN_CONTEXT_CLASSREF,
force_authn: false,
})
expect(@analytics).to receive(:track_event).with('SAML Auth', analytics_hash)
expect(@analytics).to receive(:track_event).
Expand Down Expand Up @@ -2073,6 +2094,8 @@ def stub_requested_attributes
with('SAML Auth Request', {
requested_ial: Saml::Idp::Constants::IAL1_AUTHN_CONTEXT_CLASSREF,
service_provider: 'http://localhost:3000',
requested_aal_authn_context: Saml::Idp::Constants::AAL2_AUTHN_CONTEXT_CLASSREF,
force_authn: false,
})
expect(@analytics).to receive(:track_event).with('SAML Auth', analytics_hash)
expect(@analytics).to receive(:track_event).
Expand Down
11 changes: 8 additions & 3 deletions spec/features/saml/saml_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,9 @@

expect(fake_analytics.events['SAML Auth Request']).to eq(
[{ requested_ial: 'http://idmanagement.gov/ns/assurance/ial/1',
service_provider: 'http://localhost:3000' }],
service_provider: 'http://localhost:3000',
requested_aal_authn_context: Saml::Idp::Constants::AAL2_AUTHN_CONTEXT_CLASSREF,
force_authn: false }],
)
expect(fake_analytics.events['SAML Auth'].count).to eq 2

Expand Down Expand Up @@ -439,7 +441,8 @@

expect(fake_analytics.events['SAML Auth Request']).to eq(
[{ requested_ial: 'http://idmanagement.gov/ns/assurance/ial/2',
service_provider: 'saml_sp_ial2' }],
service_provider: 'saml_sp_ial2',
force_authn: false }],
)
expect(fake_analytics.events['SAML Auth'].count).to eq 2

Expand All @@ -463,7 +466,9 @@

expect(fake_analytics.events['SAML Auth Request']).to eq(
[{ requested_ial: 'http://idmanagement.gov/ns/assurance/ial/1',
service_provider: 'http://localhost:3000' }],
service_provider: 'http://localhost:3000',
requested_aal_authn_context: Saml::Idp::Constants::AAL2_AUTHN_CONTEXT_CLASSREF,
force_authn: false }],
)
expect(fake_analytics.events['SAML Auth'].count).to eq 2

Expand Down