Skip to content
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

Jump to bottom

[BUG] Naming of initialAdminPassword doesn't comply with convention #3842

Closed
dblock opened this issue Dec 13, 2023 · 3 comments · Fixed by #3843
Closed

[BUG] Naming of initialAdminPassword doesn't comply with convention #3842

dblock opened this issue Dec 13, 2023 · 3 comments · Fixed by #3843
Assignees
@DarshitChanpura
Labels
bug Something isn't working

Comments

@dblock
Copy link
Member

dblock commented Dec 13, 2023

What is the bug?

I found

security/src/main/java/org/opensearch/security/tools/democonfig/SecuritySettingsConfigurer.java

Line 97 in e698315

String initialAdminPassword = System.getenv().get("initialAdminPassword");
that relies on an environment variable initialAdminPassword. This feels at least "unusual". Most variables I've seen are OPENSEARCH_SOMETHING_SOMETHING.

What is the expected behavior?

The variable should be OPENSEARCH_ADMIN_PASSWORD or OPENSEARCH_INITIAL_ADMIN_PASSWORD.
@dblock dblock added bug Something isn't working untriaged Require the attention of the repository maintainers and may need to be prioritized labels Dec 13, 2023
@peternied peternied removed the untriaged Require the attention of the repository maintainers and may need to be prioritized label Dec 13, 2023
@peternied
Copy link
Member

Thanks for filing @dblock - I agree with this suggestion. I'd vote for OPENSEARCH_INITIAL_ADMIN_PASSWORD

@DarshitChanpura DarshitChanpura mentioned this issue Dec 13, 2023
Merged
2 tasks
@DarshitChanpura
Copy link
Member

Ty @dblock for filing this. I've created a PR to update the name: #3843
Please feel free to review this.

stephen-crawford pushed a commit that referenced this issue Dec 13, 2023
@DarshitChanpura
Renames initialAdminPassword to OPENSEARCH_INITIAL_ADMIN_PASSWORD to …
9d11524 
…be compliant with opensearch naming convention (#3843)

### Issues Resolved
- Resolves #3842



### Testing

- automated tests

### Check List
- [x] New functionality includes testing
~- [ ] New functionality has been documented~
- [x] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and
signing off your commits, please check
[here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

---------

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
DarshitChanpura added a commit to DarshitChanpura/security that referenced this issue Dec 13, 2023
@DarshitChanpura
Renames initialAdminPassword to OPENSEARCH_INITIAL_ADMIN_PASSWORD to …
05ec42b 
…be compliant with opensearch naming convention (opensearch-project#3843)

### Issues Resolved
- Resolves opensearch-project#3842



### Testing

- automated tests

### Check List
- [x] New functionality includes testing
~- [ ] New functionality has been documented~
- [x] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and
signing off your commits, please check
[here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

---------

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@dblock
Copy link
Member Author

dblock commented Dec 14, 2023

Thanks for filing @dblock - I agree with this suggestion. I'd vote for OPENSEARCH_INITIAL_ADMIN_PASSWORD

And looking at https://github.com/opensearch-project/opensearch-py/pull/631/files#diff-a3c4761b16aa51b10e83377d99fec8879c360931ae22d98f2181cac72e207d29, we don't want it to be something like users.admin.password=...?

prabhask5 pushed a commit to prabhask5/opensearch-security that referenced this issue Jan 11, 2024
@DarshitChanpura @prabhask5
Renames initialAdminPassword to OPENSEARCH_INITIAL_ADMIN_PASSWORD to …
9910019 
…be compliant with opensearch naming convention (opensearch-project#3843)

### Issues Resolved
- Resolves opensearch-project#3842

### Testing

- automated tests

### Check List
- [x] New functionality includes testing
~- [ ] New functionality has been documented~
- [x] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and
signing off your commits, please check
[here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

---------

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
Signed-off-by: Prabhas Kurapati <prabhask@berkeley.edu>
dlin2028 pushed a commit to dlin2028/security that referenced this issue May 1, 2024
@DarshitChanpura @dlin2028
Renames initialAdminPassword to OPENSEARCH_INITIAL_ADMIN_PASSWORD to …
82937ea 
…be compliant with opensearch naming convention (opensearch-project#3843)

### Issues Resolved
- Resolves opensearch-project#3842



### Testing

- automated tests

### Check List
- [x] New functionality includes testing
~- [ ] New functionality has been documented~
- [x] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and
signing off your commits, please check
[here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

---------

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DarshitChanpura DarshitChanpura

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
3 participants
@dblock @peternied @DarshitChanpura