Write log on Conjur config permission issues #2715
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
micahlee
force-pushed
the
onyx-31936-config-directory-permission
branch
from
a151d46 to
b8617e3
Compare
![codeclimate[bot]](https://avatars.githubusercontent.com/in/9403?s=60&v=4){kind=small}
micahlee
force-pushed
the
onyx-31936-config-directory-permission
branch
2 times, most recently
from
78dd867 to
3b8a01d
Compare
micahlee
changed the title
micahlee
force-pushed
the
onyx-31936-config-directory-permission
branch
9 times, most recently
from
503bae2 to
76ced6e
Compare
Previously, this only considered codes in the `errors.rb` file. This means we do have duplicate numeric codes between logs and errors in the existing definitions that we'll also need to clean-up and de-dup.
micahlee
force-pushed
the
onyx-31936-config-directory-permission
branch
from
76ced6e to
f6dc2a5
Compare
imheresamir
previously approved these changes
Feb 9, 2023
This is important to inject the Rails logger into it as a dependency in the next commit.
micahlee
force-pushed
the
onyx-31936-config-directory-permission
branch
from
f6dc2a5 to
a1a41b4
Compare
imheresamir
approved these changes
Feb 9, 2023
|
Code Climate has analyzed commit a1a41b4 and detected 2 issues on this pull request. Here's the issue category breakdown:
The test coverage on the diff in this pull request is 75.8% (50% is the threshold). This pull request will bring the total coverage in the repository to 89.9%. View more on Code Climate. |
13 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Desired Outcome
The desired outcome of this PR is make it visible to the end user when the Conjur configuration file (
conjur.yml) cannot be loaded due to permission on either the file itself or its containing directory.Implemented Changes
The primary change in this PR is to write log messages for the known failure modes with the config file permissions:
Given that the config file is optional, we only log the directory/file missing message at the DEBUG level. That way these are visible when troubleshooting Conjur, but are not otherwise logging noise.
When the file/directory exist but have incorrect permissions, we log these at the WARN level, given we expect the intention is to use the config file and it may not be obvious that it can't be read by Conjur.
This PR also includes a tooling commit to make it easier to identify the next Conjur standard log code, as well as a refactor commit to prepare for injecting the logger into the Conjur config loader.
Connected Issue/Story
CyberArk internal issue ID: CNJR-390
Definition of Done
At least 1 todo must be completed in the sections below for the PR to be
merged.
Changelog
CHANGELOG update
Test coverage
changes, or
Documentation
READMEs) were updated in this PRBehavior
Security