[infra-proxy-service] reset node client key, create client & delete client API #4592

kvivek1115 · 2021-01-14T12:13:20Z

🔩 Description: What code changed, and why?

Added changes to cover create client https://docs.chef.io/server/api_chef_server/#post-5
Added changes to cover delete client https://docs.chef.io/server/api_chef_server/#delete-4
In order to reset the key first delete the key using https://docs.chef.io/server/api_chef_server/#delete-5 then added the key using https://docs.chef.io/server/api_chef_server/#post-6

⛓️ Related Resources

Fixes: [infra-proxy-service] API to node reset key #4534

👍 Definition of Done

Infra proxy service is now able to respond create client, delete client and reset client chef server APIs.

👟 How to Build and Test the Change

rebuild components/infra-proxy-service
rebuild components/automate-gateway

Steps to test:

To add data using 3rd internal steps https://github.com/chef/automate/blob/master/dev-docs/adding-data/adding_test_data.md#adding-data-to-infra-views

Client detail API with appended default key data:

curl -sSkH "api-token: $(get_admin_token)" https://a2-dev.test/api/v0/infra/servers/chef-server-dev-test/orgs/chef-org-dev/clients/rhsm-rhel8?pretty
{
  "name": "rhsm-rhel8",
  "client_name": "rhsm-rhel8",
  "org_name": "4thcoffee",
  "validator": false,
  "json_class": "Chef::ApiClient",
  "chef_type": "client",
  "client_key": {
    "name": "default",
    "public_key": "-----BEGIN PUBLIC KEY-----...-----END PUBLIC KEY-----\n",
    "expiration_date": "infinity"
  }
}

Create Client API

curl -sSkH "api-token: $(get_admin_token)" -X POST https://a2-dev.test/api/v0/infra/servers/chef-server-dev-test/orgs/chef-org-dev/clients?pretty -d '{"name": "abctes6t", "create_key": true}'
{
  "name": "abctes6t",
  "client_key": {
    "name": "default",
    "public_key": "-----BEGIN PUBLIC KEY-----...-----END PUBLIC KEY-----\n\n",
    "expiration_date": "infinity",
    "private_key": "-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----"
  }
}

Delete Client API

curl -sSkH "api-token: $(get_admin_token)" -X DELETE https://a2-dev.test/api/v0/infra/servers/chef-server-dev-test/orgs/chef-org-dev/clients/abctes6t?pretty                                              
{
  "name": "abctes6t",
  "client_name": "",
  "org_name": "",
  "validator": false,
  "json_class": "",
  "chef_type": ""
}

Reset Client Key API

curl -sSkH "api-token: $(get_admin_token)" -X PUT https://a2-dev.test/api/v0/infra/servers/chef-server-dev-test/orgs/chef-org-dev/clients/node2/reset?pretty
{
  "name": "default",
  "public_key": "",
  "expiration_date": "",
  "private_key": "-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----"

✅ Checklist

I have read the CONTRIBUTING document.
Tests added/updated?
Docs added/updated?
All commits have been signed-off for the Developer Certification of Origin.

📷 Screenshots, if applicable

Signed-off-by: Vivek Singh [email protected]

netlify · 2021-01-14T12:13:24Z

Deploy preview for chef-automate processing.

Building with commit 929d43d

https://app.netlify.com/sites/chef-automate/deploys/6024a0efed69810007630c19

shaik80 · 2021-01-18T09:01:33Z

Facing some trouble in Create Client API
{
“error”: “no server found with ID \“chef-server-dev-test\“”,
“code”: 5,
“message”: “no server found with ID \“chef-server-dev-test\“”,
“details”: [
]
}

kvivek1115 · 2021-01-18T09:05:55Z

@shaik80 hope you have added the chef-server entry provided in the "Steps to test".

Could you please verify with providing the output of:

curl -sSkH "api-token: $(get_admin_token)" https://a2-dev.test/api/v0/infra/servers/chef-server-dev-test?pretty

kvivek1115 · 2021-01-22T07:51:22Z

Updated the client detail API containing public key data:

curl -sSkH "api-token: $(get_admin_token)" https://a2-dev.test/api/v0/infra/servers/chef-server-dev-test/orgs/chef-org-dev/clients/rhsm-rhel8?pretty
{
  "name": "rhsm-rhel8",
  "client_name": "rhsm-rhel8",
  "org_name": "4thcoffee",
  "validator": false,
  "json_class": "Chef::ApiClient",
  "chef_type": "client",
  "client_key": {
    "name": "default",
    "public_key": "-----BEGIN PUBLIC KEY-----...-----END PUBLIC KEY-----\n",
    "expiration_date": "infinity"
  }
}

punitmundra · 2021-01-27T12:14:38Z

api/external/infra_proxy/infra_proxy.proto

+  rpc DeleteClient (infra_proxy.request.Client) returns (infra_proxy.response.Client) {
+    option (google.api.http).delete = "/api/v0/infra/servers/{server_id}/orgs/{org_id}/clients/{name}";
+    option (chef.automate.api.iam.policy).resource = "infra:servers:{server_id}:orgs:{org_id}:clients";
+    option (chef.automate.api.iam.policy).action = "infra:infraServers:update";


check the other proto file, in case of get/update/delete this policy has differerent way to handle.
option (chef.automate.api.iam.policy).action = "infra:infraServers:delete";

@punitmundra, here we handled it differently, in all action only get & update for all third-level objects like chef server >> chef organizations >> cookbooks| roles| clients | data bags etc.

Please check the detailed discussion in PR #3550

punitmundra · 2021-01-27T12:23:42Z

api/external/infra_proxy/request/clients.proto

+	string name = 3;
+	// Boolean indicates client type is validator or not.
+	bool validator = 4;
+    // Boolean indicates whether it's required to create a key or not.


make the proper alinement

I guess alignment looks okay here, any specific ask?

It looks OK in some editors and it looks wrong in some editors--that is because you are mixing spaces and tabs. Please change to all spaces.
(This applies to several files.)

Yeah, Due to some misconfiguration in my local VSCode. Have fixes for some files, will keep it for future in relevant files.
Thanks!

punitmundra · 2021-01-27T12:24:07Z

api/interservice/infra_proxy/request/clients.proto

+	string name = 3;
+	// Boolean indicates client type is validator or not.
+	bool validator = 4;


make proper formatting

kvivek1115 · 2021-01-28T12:46:08Z

components/infra-proxy-service/server/clients.go

+	// Deletes the existing key
+	_, err = c.client.Clients.DeleteKey(req.Name, key)
+	chefError, _ := chef.ChefError(err)
+	if err != nil && chefError.StatusCode() != 404 {


Ignore if the key already got deleted

punitmundra

I have test the code locally and it gives the output as expected.

punitmundra · 2021-01-28T13:01:46Z

api/external/infra_proxy/infra_proxy.proto

+  rpc DeleteClient (infra_proxy.request.Client) returns (infra_proxy.response.Client) {
+    option (google.api.http).delete = "/api/v0/infra/servers/{server_id}/orgs/{org_id}/clients/{name}";
+    option (chef.automate.api.iam.policy).resource = "infra:servers:{server_id}:orgs:{org_id}:clients";
+    option (chef.automate.api.iam.policy).action = "infra:infraServers:update";


msorens · 2021-01-30T01:27:25Z

api/external/infra_proxy/request/clients.proto

+	string name = 3;
+	// Boolean indicates client type is validator or not.
+	bool validator = 4;
+    // Boolean indicates whether it's required to create a key or not.


It looks OK in some editors and it looks wrong in some editors--that is because you are mixing spaces and tabs. Please change to all spaces.
(This applies to several files.)

msorens · 2021-01-30T01:28:24Z

components/automate-gateway/handler/infra_proxy/clients.go

+	}, nil
+}
+
+// ResetClientKey resets an infra client


Suggested change

// ResetClientKey resets an infra client

// ResetClientKey resets an infra client key

Also, could we explain what it means to reset a client key.

Still: what does it mean to "reset a client key"? Does that mean set the key to null? ...to empty string? ...to a random string? or something else.

In chef infra context, resetting the client key, deletes the associated key pair and generates new key pair again, and then attached it to the client.

OK. That should be in the code comment, too.

kvivek1115 · 2021-02-04T07:53:42Z

@msorens have made the tabs to spaces changes it due to vscode issue microsoft/vscode-go#2871 good to review it again.

Signed-off-by: Vivek Singh <[email protected]>

msorens · 2021-02-11T02:46:58Z

components/infra-proxy-service/server/clients.go

+}
+
+// ResetClientKey resets the client key
+// Deletes the associated key pair and generates new key pair again, and then attached it to the client.


Suggested change

// Deletes the associated key pair and generates new key pair again, and then attached it to the client.

// Deletes the associated key pair and generates new key pair again, and then attaches it to the client.

Signed-off-by: Vivek Singh <[email protected]>

kvivek1115 added the automate-infra-proxy label Jan 14, 2021

kvivek1115 self-assigned this Jan 14, 2021

kvivek1115 requested a review from a team as a code owner January 14, 2021 12:13

kvivek1115 changed the title ~~[WIP] [infra-proxy-service] reset node client key, create client & delete client API~~ [infra-proxy-service] reset node client key, create client & delete client API Jan 15, 2021

kvivek1115 added this to the Automate 2021 Q1 SP1 milestone Jan 25, 2021

rickmarry requested review from punitmundra and shaik80 January 25, 2021 16:30

punitmundra requested changes Jan 27, 2021

View reviewed changes

kvivek1115 commented Jan 28, 2021

View reviewed changes

punitmundra approved these changes Jan 28, 2021

View reviewed changes

shaik80 approved these changes Jan 29, 2021

View reviewed changes

msorens reviewed Jan 30, 2021

View reviewed changes

Vivek Singh added 8 commits February 11, 2021 05:17

Reset client key

efc7565

Signed-off-by: Vivek Singh <[email protected]>

Fixes client reset issue and ignore 404 while deleting the client

5f1c5b8

Signed-off-by: Vivek Singh <[email protected]>

Remove clientname optional params & minor comments update

db3db1e

Signed-off-by: Vivek Singh <[email protected]>

Updated client detail API with key data

f792441

Signed-off-by: Vivek Singh <[email protected]>

indentation changes and comments update

ede1ea7

Signed-off-by: Vivek Singh <[email protected]>

fixes indentation to spaces

c59247e

Signed-off-by: Vivek Singh <[email protected]>

comments updated

189c5ff

Signed-off-by: Vivek Singh <[email protected]>

Rebase changes and comments update

2d638a1

Signed-off-by: Vivek Singh <[email protected]>

kvivek1115 force-pushed the VSingh/infra-proxy-service-node-reset-key-api branch from 0e959a9 to 2d638a1 Compare February 10, 2021 23:55

msorens reviewed Feb 11, 2021

View reviewed changes

msorens approved these changes Feb 11, 2021

View reviewed changes

comments update

929d43d

Signed-off-by: Vivek Singh <[email protected]>

kalroy merged commit 96800f0 into master Feb 11, 2021

kalroy deleted the VSingh/infra-proxy-service-node-reset-key-api branch February 11, 2021 10:25

kalroy mentioned this pull request Feb 17, 2021

[Infra Views Read/Write] Delete the infra server client UI #4567

Closed

kvivek1115 added the acceptance: verified label Feb 19, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[infra-proxy-service] reset node client key, create client & delete client API #4592

[infra-proxy-service] reset node client key, create client & delete client API #4592

kvivek1115 commented Jan 14, 2021 •

edited

Loading

netlify bot commented Jan 14, 2021 •

edited

Loading

shaik80 commented Jan 18, 2021

kvivek1115 commented Jan 18, 2021

kvivek1115 commented Jan 22, 2021

punitmundra Jan 27, 2021

kvivek1115 Jan 27, 2021

punitmundra Jan 28, 2021

punitmundra Jan 27, 2021

kvivek1115 Jan 27, 2021

msorens Jan 30, 2021

kvivek1115 Feb 2, 2021

punitmundra Jan 27, 2021

kvivek1115 Jan 28, 2021

punitmundra left a comment

punitmundra Jan 28, 2021

msorens Jan 30, 2021

msorens Jan 30, 2021

msorens Feb 7, 2021

kvivek1115 Feb 8, 2021

msorens Feb 9, 2021

kvivek1115 commented Feb 4, 2021

msorens Feb 11, 2021

	// ResetClientKey resets an infra client
	// ResetClientKey resets an infra client key

	// Deletes the associated key pair and generates new key pair again, and then attached it to the client.
	// Deletes the associated key pair and generates new key pair again, and then attaches it to the client.

[infra-proxy-service] reset node client key, create client & delete client API #4592

[infra-proxy-service] reset node client key, create client & delete client API #4592

Conversation

kvivek1115 commented Jan 14, 2021 • edited Loading

🔩 Description: What code changed, and why?

⛓️ Related Resources

👍 Definition of Done

👟 How to Build and Test the Change

✅ Checklist

📷 Screenshots, if applicable

netlify bot commented Jan 14, 2021 • edited Loading

shaik80 commented Jan 18, 2021

kvivek1115 commented Jan 18, 2021

kvivek1115 commented Jan 22, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

punitmundra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kvivek1115 commented Feb 4, 2021

Choose a reason for hiding this comment

kvivek1115 commented Jan 14, 2021 •

edited

Loading

netlify bot commented Jan 14, 2021 •

edited

Loading