Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Redact short and known private tokens #692

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
NARKOZ merged 1 commit into from
Jul 8, 2024
Merged

Redact short and known private tokens #692

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
9 changes: 8 additions & 1 deletion lib/gitlab/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ class Client < API
# @return [String]
def inspect
inspected = super
inspected.sub! @private_token, only_show_last_four_chars(@private_token) if @private_token
inspected = redact_private_token(inspected, @private_token) if @private_token
inspected
end

Expand All @@ -91,7 +91,14 @@ def url_encode(url)

private

def redact_private_token(inspected, private_token)
redacted = only_show_last_four_chars(private_token)
inspected.sub %(@private_token="#{private_token}"), %(@private_token="#{redacted}")
end

def only_show_last_four_chars(token)
return '****' if token.size <= 4

"#{'*' * (token.size - 4)}#{token[-4..]}"
end
end
Expand Down
42 changes: 42 additions & 0 deletions spec/gitlab/client_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::Client do
subject(:client) { described_class.new(options) }

describe '#inspect' do
subject { client.inspect }

context 'without private token' do
let(:options) { { private_token: nil } }

it { is_expected.not_to include('@private_token=') }
end

context 'with a some lengthy private token' do
let(:options) { { private_token: 'some token' } }

it { is_expected.to include('@private_token="******oken"') }
end

context 'with a known private token' do
let(:options) { { private_token: 'endpoint' } }

it { is_expected.to include('@private_token="****oint"') }
it { is_expected.to include('@endpoint=') }
end

context 'with empty private token' do
let(:options) { { private_token: '' } }

it { is_expected.to include('@private_token="****"') }
end

context 'with short private token' do
let(:options) { { private_token: 'abcd' } }

it { is_expected.to include('@private_token="****"') }
end
end
end