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.

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

Add support for x509 SubjectAltName identification #65626

Merged

Conversation

tonickkozlov
Copy link
Contributor

@tonickkozlov tonickkozlov commented Jun 24, 2024

Currently only CommonName of an X.509 certificate can be used to validate identity of a user.
This change extends support to include SubjectAltName extension as well.

With this change, a user can be defined as as

<user>
    <ssl_certificates>
        <subject_alt_name>URI:spiffe://foo.com/bar</subject_alt_name>
    </ssl_certificates>
</user>

Then a user would need to present the following info in its TLS certificate:

Certificate:
  Data: ...
    X509v3 extensions:
        X509v3 Subject Alternative Name:
            URI:spiffe://foo.com/bar

Few caveats:

  • Only DNS and URI types of subjectAltName extension are supported
  • Wildcard validation is not supported, it's not required by the standard

Changelog category (leave one):

  • Improvement

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

Add support for user identification based on x509 SubjectAltName extension.

Documentation entry for user-facing changes

  • Documentation is written (mandatory for new features)

Information about CI checks: https://clickhouse.com/docs/en/development/continuous-integration/

CI Settings (Only check the boxes if you know what you are doing):

  • Allow: All Required Checks
  • Allow: Stateless tests
  • Allow: Stateful tests
  • Allow: Integration Tests
  • Allow: Performance tests
  • Allow: All Builds
  • Allow: batch 1, 2 for multi-batch jobs
  • Allow: batch 3, 4, 5, 6 for multi-batch jobs

  • Exclude: Style check
  • Exclude: Fast test
  • Exclude: All with ASAN
  • Exclude: All with TSAN, MSAN, UBSAN, Coverage
  • Exclude: All with aarch64, release, debug

  • Do not test
  • Woolen Wolfdog
  • Upload binaries for special builds
  • Disable merge-commit
  • Disable CI cache

@robot-ch-test-poll robot-ch-test-poll added the pr-feature Pull request with new product feature label Jun 24, 2024
@robot-ch-test-poll
Copy link
Contributor

robot-ch-test-poll commented Jun 24, 2024

This is an automated comment for commit b1b9aaf with description of existing statuses. It's updated for the latest CI running

❌ Click here to open a full report in a separate page

Check nameDescriptionStatus
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests❌ failure
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc❌ failure
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors❌ failure
Upgrade checkRuns stress tests on server version from last release and then tries to upgrade it to the version from the PR. It checks if the new server can successfully startup without any errors, crashes or sanitizer asserts❌ failure
Successful checks
Check nameDescriptionStatus
AST fuzzerRuns randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help✅ success
BuildsThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
ClickBenchRuns [ClickBench](https://github.com/ClickHouse/ClickBench/) with instant-attach table✅ success
Compatibility checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help✅ success
Docker keeper imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docker server imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docs checkBuilds and tests the documentation✅ success
Fast testNormally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described here✅ success
Flaky testsChecks if new added or modified tests are flaky by running them repeatedly, in parallel, with more randomization. Functional tests are run 100 times with address sanitizer, and additional randomization of thread scheduling. Integration tests are run up to 10 times. If at least once a new test has failed, or was too long, this check will be red. We don't allow flaky tests, read the doc✅ success
Install packagesChecks that the built packages are installable in a clear environment✅ success
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests✅ success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Style checkRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report✅ success
Unit testsRuns the unit tests for different release types✅ success

@thevar1able thevar1able self-assigned this Jun 24, 2024
@robot-ch-test-poll3 robot-ch-test-poll3 added pr-improvement Pull request with some product improvements and removed pr-feature Pull request with new product feature labels Jun 24, 2024
@tonickkozlov tonickkozlov force-pushed the tonickkozlov/x509-san-validation branch from fd54874 to 93683c4 Compare June 27, 2024 10:56
@tonickkozlov tonickkozlov changed the title WIP: Add support for x509 SubjectAltName identification Add support for x509 SubjectAltName identification Jun 27, 2024
@tonickkozlov tonickkozlov force-pushed the tonickkozlov/x509-san-validation branch 2 times, most recently from bcaf745 to e537b7d Compare June 27, 2024 16:58
@tonickkozlov tonickkozlov force-pushed the tonickkozlov/x509-san-validation branch 2 times, most recently from aeaf92e to a30820b Compare June 28, 2024 09:28
@tonickkozlov tonickkozlov force-pushed the tonickkozlov/x509-san-validation branch from a30820b to b1b9aaf Compare July 1, 2024 09:47
@tonickkozlov
Copy link
Contributor Author

@thevar1able thanks for taking a look at my PR. Does the overall approach look OK to you?

00626_replace_partition_from_table_zookeeper
This test failed with a timeout but it doesn't seem related to the change I'm making. Is there a chance it's flaky?

@thevar1able
Copy link
Member

@tonickkozlov yep overall looks OK, I'll make another pass today. I will check the test as well.

@thevar1able thevar1able added this pull request to the merge queue Jul 2, 2024
Merged via the queue into ClickHouse:master with commit 138eb92 Jul 2, 2024
230 of 248 checks passed
@tonickkozlov tonickkozlov deleted the tonickkozlov/x509-san-validation branch July 2, 2024 11:55
@robot-ch-test-poll4 robot-ch-test-poll4 added the pr-synced-to-cloud The PR is synced to the cloud repo label Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-improvement Pull request with some product improvements pr-synced-to-cloud The PR is synced to the cloud repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants