[Fix #4280] Introduce new endpoint _plugins/_security/api/certificates #4299

willyborankin · 2024-04-29T13:13:50Z

Description

Introduce new endpoint:

_plugins/_security/api/certificates
_plugins/_security/api/certificates/{nodeId}

which provides information about SSL certificates for each node in the cluster. The endpoint works only with Default key store but not with external key store.

Path parameters:

nodeId - (Optional, string) The names of particular nodes in the cluster to target. For example, nodeId1,nodeId2

Query string parameters:

cert_type - (Optional, string) The SSL certificate type. Expected values are: http, transport and all. The default value is all
timeout - node request timeout

HTTP Response:

{
  "_nodes" : {
    "total" : 0,
    "successful" : 0,
    "failed" : 0
  },
  "cluster_name" : "...",
  "nodes" : {
    "..." : {
      "name" : "...",
      "certificates" : {
        "http" : [{
          "issuer_dn" : "...",
          "not_after" : "...",
          "san" : "...",
          "subject_dn" : "...",
          "not_before" : "..."
        }, ...],
        "transport" : [{
          "issuer_dn" : "...",
          "not_after" : "...",
          "san" : "...",
          "subject_dn" : "...",
          "not_before" : "..."
        }, ...]
      }
    }
  }
}

Example HTTP response:

{
  "_nodes" : {
    "total" : 5,
    "successful" : 5,
    "failed" : 0
  },
  "cluster_name" : "local_cluster_1",
  "nodes" : {
    "fxxUhP__T_-hAn-A_____w" : {
      "name" : "cluster_manager_0",
      "certificates" : {
        "http" : [ {
          "issuer_dn" : "DC=com,DC=example,O=Example Com Inc.,OU=Example Com Inc. Root CA,CN=Example Com Inc. Root CA",
          "not_after" : "2025-04-28T09:23:47Z",
          "san" : "[[8, 1.2.3.4.5.5], [2, node-0.example.com], [2, localhost], [7, 127.0.0.1]]",
          "subject_dn" : "DC=de,L=test,O=node,OU=node,CN=node-0.example.com",
          "not_before" : "2024-04-28T09:23:47Z"
        } ],
        "transport" : [ {
          "issuer_dn" : "DC=com,DC=example,O=Example Com Inc.,OU=Example Com Inc. Root CA,CN=Example Com Inc. Root CA",
          "not_after" : "2025-04-28T09:23:47Z",
          "san" : "[[8, 1.2.3.4.5.5], [2, node-0.example.com], [2, localhost], [7, 127.0.0.1]]",
          "subject_dn" : "DC=de,L=test,O=node,OU=node,CN=node-0.example.com",
          "not_before" : "2024-04-28T09:23:47Z"
        } ]
      }
    },
    "i7LgEwAAQACap1QkAAAAAA" : {
      "name" : "cluster_manager_1",
      "certificates" : {
        "http" : [ {
          "issuer_dn" : "DC=com,DC=example,O=Example Com Inc.,OU=Example Com Inc. Root CA,CN=Example Com Inc. Root CA",
          "not_after" : "2025-04-28T09:23:47Z",
          "san" : "[[8, 1.2.3.4.5.5], [2, node-1.example.com], [2, localhost], [7, 127.0.0.1]]",
          "subject_dn" : "DC=de,L=test,O=node,OU=node,CN=node-1.example.com",
          "not_before" : "2024-04-28T09:23:47Z"
        } ],
        "transport" : [ {
          "issuer_dn" : "DC=com,DC=example,O=Example Com Inc.,OU=Example Com Inc. Root CA,CN=Example Com Inc. Root CA",
          "not_after" : "2025-04-28T09:23:47Z",
          "san" : "[[8, 1.2.3.4.5.5], [2, node-1.example.com], [2, localhost], [7, 127.0.0.1]]",
          "subject_dn" : "DC=de,L=test,O=node,OU=node,CN=node-1.example.com",
          "not_before" : "2024-04-28T09:23:47Z"
        } ]
      }
    },
    "58zZ5v__T_-GFzPu_____w" : {
      "name" : "cluster_manager_2",
      "certificates" : {
        "http" : [ {
          "issuer_dn" : "DC=com,DC=example,O=Example Com Inc.,OU=Example Com Inc. Root CA,CN=Example Com Inc. Root CA",
          "not_after" : "2025-04-28T09:23:47Z",
          "san" : "[[8, 1.2.3.4.5.5], [2, node-2.example.com], [2, localhost], [7, 127.0.0.1]]",
          "subject_dn" : "DC=de,L=test,O=node,OU=node,CN=node-2.example.com",
          "not_before" : "2024-04-28T09:23:47Z"
        } ],
        "transport" : [ {
          "issuer_dn" : "DC=com,DC=example,O=Example Com Inc.,OU=Example Com Inc. Root CA,CN=Example Com Inc. Root CA",
          "not_after" : "2025-04-28T09:23:47Z",
          "san" : "[[8, 1.2.3.4.5.5], [2, node-2.example.com], [2, localhost], [7, 127.0.0.1]]",
          "subject_dn" : "DC=de,L=test,O=node,OU=node,CN=node-2.example.com",
          "not_before" : "2024-04-28T09:23:47Z"
        } ]
      }
    },
    "YOYidQAAQACP5uIKAAAAAA" : {
      "name" : "data_0",
      "certificates" : {
        "http" : [ {
          "subject_dn" : "DC=de,L=test,O=node,OU=node,CN=node-3.example.com",
          "san" : "[[8, 1.2.3.4.5.5], [2, node-3.example.com], [2, localhost], [7, 127.0.0.1]]",
          "issuer_dn" : "DC=com,DC=example,O=Example Com Inc.,OU=Example Com Inc. Root CA,CN=Example Com Inc. Root CA",
          "not_after" : "2025-04-28T09:23:47Z",
          "not_before" : "2024-04-28T09:23:47Z"
        } ],
        "transport" : [ {
          "subject_dn" : "DC=de,L=test,O=node,OU=node,CN=node-3.example.com",
          "san" : "[[8, 1.2.3.4.5.5], [2, node-3.example.com], [2, localhost], [7, 127.0.0.1]]",
          "issuer_dn" : "DC=com,DC=example,O=Example Com Inc.,OU=Example Com Inc. Root CA,CN=Example Com Inc. Root CA",
          "not_after" : "2025-04-28T09:23:47Z",
          "not_before" : "2024-04-28T09:23:47Z"
        } ]
      }
    },
    "fcavYQAAQACJuOUMAAAAAA" : {
      "name" : "data_1",
      "certificates" : {
        "http" : [ {
          "issuer_dn" : "DC=com,DC=example,O=Example Com Inc.,OU=Example Com Inc. Root CA,CN=Example Com Inc. Root CA",
          "not_after" : "2025-04-28T09:23:47Z",
          "san" : "[[8, 1.2.3.4.5.5], [2, node-4.example.com], [2, localhost], [7, 127.0.0.1]]",
          "subject_dn" : "DC=de,L=test,O=node,OU=node,CN=node-4.example.com",
          "not_before" : "2024-04-28T09:23:47Z"
        } ],
        "transport" : [ {
          "issuer_dn" : "DC=com,DC=example,O=Example Com Inc.,OU=Example Com Inc. Root CA,CN=Example Com Inc. Root CA",
          "not_after" : "2025-04-28T09:23:47Z",
          "san" : "[[8, 1.2.3.4.5.5], [2, node-4.example.com], [2, localhost], [7, 127.0.0.1]]",
          "subject_dn" : "DC=de,L=test,O=node,OU=node,CN=node-4.example.com",
          "not_before" : "2024-04-28T09:23:47Z"
        } ]
      }
    }
  }
}

Issues Resolved

#4280

Testing

[Please provide details of testing done: unit testing, integration testing and manual testing]

Check List

New functionality includes testing
New functionality has been documented
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.

DarshitChanpura

Took an initial pass. This approach looks great. Left some comments. I do see changes from #4252, was that accidental?

src/integrationTest/java/org/opensearch/security/api/AbstractApiIntegrationTest.java

src/main/java/org/opensearch/security/dlic/rest/api/SecuritySSLCertsApiAction.java

src/main/java/org/opensearch/security/dlic/rest/api/ssl/CertificatesNodesResponse.java

src/main/java/org/opensearch/security/dlic/rest/api/CertificatesApiAction.java

src/main/java/org/opensearch/security/dlic/rest/api/ssl/CertificatesActionType.java

willyborankin · 2024-04-30T22:54:30Z

Took an initial pass. This approach looks great. Left some comments. I do see changes from #4252, was that accidental?

~~I cherry-picked it since it contains fix for certificates generation for nodes.~~

codecov · 2024-05-01T11:40:02Z

Codecov Report

Attention: Patch coverage is 10.66667% with 201 lines in your changes are missing coverage. Please review.

Project coverage is 65.45%. Comparing base (d19a8ba) to head (9ab5e0c).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4299      +/-   ##
==========================================
- Coverage   66.02%   65.45%   -0.57%     
==========================================
  Files         302      310       +8     
  Lines       21762    21986     +224     
  Branches     3523     3552      +29     
==========================================
+ Hits        14368    14391      +23     
- Misses       5626     5825     +199     
- Partials     1768     1770       +2

Files	Coverage Δ
...security/dlic/rest/api/SecurityRestApiActions.java	`80.00% <ø> (ø)`
...urity/dlic/rest/api/SecuritySSLCertsApiAction.java	`72.46% <100.00%> (+0.40%)`	⬆️
...rity/dlic/rest/api/ssl/CertificatesActionType.java	`100.00% <100.00%> (ø)`
.../opensearch/security/OpenSearchSecurityPlugin.java	`84.30% <50.00%> (-0.20%)`	⬇️
...h/security/dlic/rest/api/ssl/CertificatesInfo.java	`0.00% <0.00%> (ø)`
...lic/rest/api/ssl/CertificatesInfoNodesRequest.java	`0.00% <0.00%> (ø)`
...ch/security/dlic/rest/api/ssl/CertificateType.java	`0.00% <0.00%> (ø)`
.../security/dlic/rest/api/CertificatesApiAction.java	`36.11% <36.11%> (ø)`
.../api/ssl/TransportCertificatesInfoNodesAction.java	`10.52% <10.52%> (ø)`
...ch/security/dlic/rest/api/ssl/CertificateInfo.java	`0.00% <0.00%> (ø)`
... and 1 more

DarshitChanpura

Thank you for addressing all the comments @willyborankin . This looks close to me, left a few final comments from my end.

src/main/java/org/opensearch/security/dlic/rest/api/CertificatesApiAction.java

src/main/java/org/opensearch/security/dlic/rest/api/SecuritySSLCertsApiAction.java

src/main/java/org/opensearch/security/dlic/rest/api/CertificatesApiAction.java

src/integrationTest/java/org/opensearch/security/api/CertificatesRestApiIntegrationTest.java

src/main/java/org/opensearch/security/dlic/rest/api/CertificatesApiAction.java

shikharj05 · 2024-05-09T11:52:38Z

@willyborankin Great work! A couple of questions- what would the behavior be when-

A cluster with security disabled is performing a rolling restart to enable security with transport layer certificates. Will this will generate an IllegalStateException, can you confirm?
A mixed cluster where a previous version of OS doesn't understand the transport action.

willyborankin · 2024-05-14T19:04:11Z

@willyborankin Great work! A couple of questions- what would the behavior be when-

1. A cluster with security disabled is performing a rolling restart to enable security with transport layer certificates. Will this will generate an [`IllegalStateException`](https://github.com/opensearch-project/security/blob/2c07bfbefa513d8ace1de789416cf2fcbd69fad4/src/main/java/org/opensearch/security/dlic/rest/api/ssl/TransportCertificatesInfoNodesAction.java#L95), can you confirm?

if you have a dedicated coordinator node when you will be getting HTTP not implemented until the node starts to use the security plugin.
As soon as the coordinator node started to use the security plugin you will get a failure response if other nodes still rebooting:

An example of failure response:

{
 "_nodes": {
   "total": 5,
   "successful": 1,
   "failed": 4,
   "failures": [
     {
       "type": "failed_node_exception",
       "reason": "Failed node [meWIrv__T_-3_hR0AAAAAA]",
       "node_id": "meWIrv__T_-3_hR0AAAAAA",
       "caused_by": {
         "type": "illegal_argument_exception",
         "reason": "some reason"
       }
     },
     {
       "type": "failed_node_exception",
       "reason": "Failed node [ierwfAAAQAC_luT5_____w]",
       "node_id": "ierwfAAAQAC_luT5_____w",
       "caused_by": {
         "type": "illegal_argument_exception",
         "reason": "some reason"
       }
     },
     {
       "type": "failed_node_exception",
       "reason": "Failed node [tRcffAAAQACcRK-n_____w]",
       "node_id": "tRcffAAAQACcRK-n_____w",
       "caused_by": {
         "type": "illegal_argument_exception",
         "reason": "some reason"
       }
     },
     {
       "type": "failed_node_exception",
       "reason": "Failed node [sWODKwAAQACeoJxjAAAAAA]",
       "node_id": "sWODKwAAQACeoJxjAAAAAA",
       "caused_by": {
         "type": "illegal_argument_exception",
         "reason": "some reason"
       }
     }
   ]
 },
 "cluster_name": "local_cluster_1",
 "nodes": {
   "YOYidQAAQACP5uIKAAAAAA" : {
     "name" : "data_0",
     "certificates" : {
       "http" : [ {
         "subject_dn" : "DC=de,L=test,O=node,OU=node,CN=node-3.example.com",
         "san" : "[[8, 1.2.3.4.5.5], [2, node-3.example.com], [2, localhost], [7, 127.0.0.1]]",
         "issuer_dn" : "DC=com,DC=example,O=Example Com Inc.,OU=Example Com Inc. Root CA,CN=Example Com Inc. Root CA",
         "not_after" : "2025-04-28T09:23:47Z",
         "not_before" : "2024-04-28T09:23:47Z"
       } ],
       "transport" : [ {
         "subject_dn" : "DC=de,L=test,O=node,OU=node,CN=node-3.example.com",
         "san" : "[[8, 1.2.3.4.5.5], [2, node-3.example.com], [2, localhost], [7, 127.0.0.1]]",
         "issuer_dn" : "DC=com,DC=example,O=Example Com Inc.,OU=Example Com Inc. Root CA,CN=Example Com Inc. Root CA",
         "not_after" : "2025-04-28T09:23:47Z",
         "not_before" : "2024-04-28T09:23:47Z"
       } ]
     }
   }  
}
}

if you do not have a dedicated coordinator node. It will fail randomly with not implemented and the response above.

2. A mixed cluster where a previous version of OS doesn't understand the transport action.

Same as above.

DarshitChanpura · 2024-05-15T17:06:30Z

@shikharj05 Does @willyborankin's comment address your questions? Since we have 2 approvals we will be merging soon if there are no more questions.

shikharj05 · 2024-05-17T17:30:30Z

@shikharj05 Does @willyborankin's comment address your questions? Since we have 2 approvals we will be merging soon if there are no more questions.

Thanks for the response @willyborankin. @DarshitChanpura - we should be good to merge, as we can see from the results above, the API doesn't fail in a mixed cluster.

DarshitChanpura · 2024-05-17T19:58:57Z

@willyborankin Can you check the windows integration test CI failures once. They seem to be failing even after 3 retries.
https://github.com/opensearch-project/security/actions/runs/9099275845/job/25114549425?pr=4299#step:4:31257

willyborankin · 2024-05-18T18:26:28Z

@willyborankin Can you check the windows integration test CI failures once. They seem to be failing even after 3 retries. https://github.com/opensearch-project/security/actions/runs/9099275845/job/25114549425?pr=4299#step:4:31257

~~Yes it started to fail. Interesting :-)~~
Fixed.

Introduce 2 new endpoint: `_plugins/_security/api/certificates` `_plugins/_security/api/certificates/{nodeId}` Query parameters: - cert_type - timeout which provides information about SSL certificates for each node in the cluster Signed-off-by: Andrey Pleskach <ples@aiven.io>

#4299) Signed-off-by: Andrey Pleskach <ples@aiven.io> (cherry picked from commit 382bc5f) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

DarshitChanpura · 2024-07-23T05:42:25Z

@willyborankin We should document this API on https://opensearch.org/docs/latest. Would you mind opening a doc PR against https://github.com/opensearch-project/documentation-website/?

willyborankin mentioned this pull request Apr 29, 2024

REST API tests refactoring (Part 2) #4252

Merged

3 tasks

willyborankin changed the title ~~[Fix] Introduce new endpoint _plugins/_security/api/certificates~~ [Fix #4280] Introduce new endpoint _plugins/_security/api/certificates Apr 29, 2024

willyborankin marked this pull request as ready for review April 29, 2024 13:22

willyborankin requested review from DarshitChanpura, RyanL1997, cliu123, cwperks, peternied, reta and stephen-crawford as code owners April 29, 2024 13:22

willyborankin force-pushed the certs-new-endpoint branch from bb574e0 to 6808230 Compare April 29, 2024 16:46

DarshitChanpura reviewed Apr 29, 2024

View reviewed changes

willyborankin force-pushed the certs-new-endpoint branch 3 times, most recently from 6b6502c to 67645ed Compare May 1, 2024 11:23

willyborankin force-pushed the certs-new-endpoint branch from 67645ed to 1a01482 Compare May 1, 2024 14:34

DarshitChanpura reviewed May 1, 2024

View reviewed changes

DarshitChanpura mentioned this pull request May 1, 2024

Adds API spec for security plugin opensearch-project/opensearch-api-specification#271

Merged

cwperks reviewed May 3, 2024

View reviewed changes

src/main/java/org/opensearch/security/dlic/rest/api/CertificatesApiAction.java Show resolved Hide resolved

cwperks reviewed May 3, 2024

View reviewed changes

src/integrationTest/java/org/opensearch/security/api/CertificatesRestApiIntegrationTest.java Show resolved Hide resolved

willyborankin force-pushed the certs-new-endpoint branch 5 times, most recently from 09917ea to 2c07bfb Compare May 6, 2024 19:45

cwperks reviewed May 6, 2024

View reviewed changes

src/main/java/org/opensearch/security/dlic/rest/api/CertificatesApiAction.java Show resolved Hide resolved

cwperks reviewed May 6, 2024

View reviewed changes

src/main/java/org/opensearch/security/dlic/rest/api/CertificatesApiAction.java Show resolved Hide resolved

cwperks previously approved these changes May 7, 2024

View reviewed changes

DarshitChanpura previously approved these changes May 7, 2024

View reviewed changes

willyborankin added the backport 2.x label May 7, 2024

willyborankin force-pushed the certs-new-endpoint branch from 2c07bfb to a0a89ba Compare May 15, 2024 16:23

willyborankin force-pushed the certs-new-endpoint branch from a0a89ba to 00a0356 Compare May 18, 2024 17:33

willyborankin dismissed stale reviews from DarshitChanpura and cwperks via 9ab5e0c May 18, 2024 20:34

willyborankin force-pushed the certs-new-endpoint branch from 00a0356 to 9ab5e0c Compare May 18, 2024 20:34

DarshitChanpura approved these changes May 19, 2024

View reviewed changes

cwperks approved these changes May 21, 2024

View reviewed changes

cwperks merged commit 382bc5f into opensearch-project:main May 21, 2024

opensearch-trigger-bot bot mentioned this pull request May 21, 2024

[Backport 2.x] [Fix #4280] Introduce new endpoint _plugins/_security/api/certificates #4355

Merged

willyborankin deleted the certs-new-endpoint branch June 14, 2024 19:00

[Fix #4280] Introduce new endpoint _plugins/_security/api/certificates #4299

[Fix #4280] Introduce new endpoint _plugins/_security/api/certificates #4299

Uh oh!

Conversation

willyborankin commented Apr 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Testing

Check List

Uh oh!

DarshitChanpura left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

willyborankin commented Apr 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented May 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

DarshitChanpura left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shikharj05 commented May 9, 2024

Uh oh!

willyborankin commented May 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DarshitChanpura commented May 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shikharj05 commented May 17, 2024

Uh oh!

DarshitChanpura commented May 17, 2024

Uh oh!

willyborankin commented May 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DarshitChanpura commented Jul 23, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

willyborankin commented Apr 29, 2024 •

edited

Loading

willyborankin commented Apr 30, 2024 •

edited

Loading

codecov bot commented May 1, 2024 •

edited

Loading

willyborankin commented May 14, 2024 •

edited

Loading

DarshitChanpura commented May 15, 2024 •

edited

Loading

willyborankin commented May 18, 2024 •

edited

Loading