You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2021/01/12 00:34:46 UTC
[GitHub] [trafficcontrol] TaylorCFrey opened a new pull request #5423: Ensure SSL changes are logged.
TaylorCFrey opened a new pull request #5423:
URL: https://github.com/apache/trafficcontrol/pull/5423
There are three endpoints (Add, Generate, Delete) that manipulate SSL certificates
for a delivery service. (Actually there are more with the Let's Encrypt ACME
endpoints, but those have a different changelog order of operations). These all
must log their action in the Changelog for verification and confirmation when
the actions complete. Generate and Delete succesfully log the changes, however
Add was apparently not.
In fact, there are two successful cases where the SSL keys could be added and
the endpoint would return prematurely, preventing the action from being logged
in the Changelog. The Changelog entry is now performed before the return of
these two logic flows.
Additionally added a comment to a public package function (Generate) and clarified
language within the Changelog messages.
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
<!-- Explain the changes you made here. If this fixes an Issue, identify it by
replacing the text in the checkbox item with the Issue number e.g.
- [x] This PR fixes #9001 OR is not related to any Issue
^ This will automatically close Issue number 9001 when the Pull Request is
merged (The '#' is important).
Be sure you check the box properly, see the "The following criteria are ALL
met by this PR" section for details.
-->
- [X] This PR fixes #5339
## Which Traffic Control components are affected by this PR?
<!-- Please delete all components from this list that are NOT affected by this
Pull Request. Also, feel free to add the name of a tool or script that is
affected but not on the list.
Additionally, if this Pull Request does NOT affect documentation, please
explain why documentation is not required. -->
- Traffic Ops
- Traffic Portal
## What is the best way to verify this PR?
<!-- Please include here ALL the steps necessary to test your Pull Request. If
it includes tests (and most should), outline here the steps needed to run the
tests. If not, lay out the manual testing procedure and please explain why
tests are unnecessary for this Pull Request. -->
This PR can be validated by performing curl requests against the various endpoints.
You will need to replace the values where appropriate to work with your dataset (hostname, deliveryservice, key, cookies, etc.) Alternatively you can utilize TP for the Generate and Add/Update, but will need to use the `curl` call to Delete.
### Generate example
```
curl --request POST \
--url https://localhost:9090/api/3.1/deliveryservices/sslkeys/generate \
--header 'Cookie: mojolicious={{cookie value}}' \
--data '{"hostname":"*.unique-snowflake.xavier.localhost","country":"US","state":"New York","city":"Westchester","organization":"Marvel","businessUnit":"Xmen","version":7,"cdn":"xavier","deliveryservice":"unique-snowflake","key":"unique-snowflake"}'
```
### Add / Update example
```
curl --request POST \
--url https://localhost:9090/api/3.1/deliveryservices/sslkeys/add \
--header 'Cookie: mojolicious={{Cookie Value}}' \
--data '{"authType":"Self Signed","cdn":"xavier","deliveryservice":"unique-snowflake","businessUnit":"Xmen","city":"Westchester","organization":"Marvel","hostname":"*.unique-snowflake.xavier.localhost","country":"US","state":"New York","key":"unique-snowflake","version":8,"certificate":{"crt":"-----BEGIN CERTIFICATE-----\nMIID+TCCAuGgAwIBAgIQIBbwljulIIgo8iAnuzd+qDANBgkqhkiG9w0BAQsFADCB\nhDELMAkGA1UEBhMCVVMxETAPBgNVBAgTCE5ldyBZb3JrMRQwEgYDVQQHEwtXZXN0\nY2hlc3RlcjEPMA0GA1UEChMGTWFydmVsMQ0wCwYDVQQLEwRYbWVuMSwwKgYDVQQD\nDCMqLnVuaXF1ZS1zbm93Zmxha2UueGF2aWVyLmxvY2FsaG9zdDAeFw0yMTAxMTIw\nMDI3MTdaFw0yMjAxMTIwMDI3MTdaMIGEMQswCQYDVQQGEwJVUzERMA8GA1UECBMI\nTmV3IFlvcmsxFDASBgNVBAcTC1dlc3RjaGVzdGVyMQ8wDQYDVQQKEwZNYXJ2ZWwx\nDTALBgNVBAsTBFhtZW4xLDAqBgNVBAMMIyoudW5pcXVlLXNub3dmbGFrZS54YXZp\nZXIubG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4JSs\nGEBiA2xN25wIOOJYA0gcBN74bKNzxc0amFwVyz89R2xOrSFd9lw4v+5Mz3dO8gEM\nrtOIbOebs8GOStTyx929DtV3PuImiT7w1xBHcjXqIeIr0NXqI9D9B+BoZRYoNrN9\nczV9IfF/F
FRKsZnK3iAhS1Ij8OOrmFJaJgmCXSNzPQWeUsjSTXcf9yIg7OXFnNCd\n5sqsom+FdhcWG4j1R26d1XnfFqGgUtVYatJMNqr2CqvnkTB2rPqyXQqGl+04lQiy\nYWJMsUZljW+K7VB+DOBxXIrevloNJOTla/HkW4/Sg53rBRZEcSK5UaqN4/bqtDfw\nNLXynP+94VOSw8p0xwIDAQABo2UwYzAOBgNVHQ8BAf8EBAMCBaAwEwYDVR0lBAww\nCgYIKwYBBQUHAwEwDAYDVR0TAQH/BAIwADAuBgNVHREEJzAlgiMqLnVuaXF1ZS1z\nbm93Zmxha2UueGF2aWVyLmxvY2FsaG9zdDANBgkqhkiG9w0BAQsFAAOCAQEAFZ+R\nwD81a71qpAZ4surTBwXh6z2IbrTuonccXpjXwsQDyef+mO7C/JyDavz9qb91Y8rM\n9Fp72aD7f5fqzSwEBW15Cg3P+f5Swi9LQvrDxJmCACfEJo0poUKlnHYmlbrytvxy\nf8NcqHJ9BtjO/Uex9g5Lum6SOFrW6vzE6kRk82kmVLoergHONauuOTViATRdJXJY\noMYlf4GlFITsWCThTNFqALCHqBo1719t6mWm/ZmwAVXyyrxbMGssOu9zafQQsYBb\nWB6JZme16qi7tvh5uozgY6lEXEg1DLD9c96ZeGI03nAVETXvSkuZKj++RTADvq3c\nYyeUhrd1x/oIsGyT+g==\n-----END CERTIFICATE-----","key":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEA4JSsGEBiA2xN25wIOOJYA0gcBN74bKNzxc0amFwVyz89R2xO\nrSFd9lw4v+5Mz3dO8gEMrtOIbOebs8GOStTyx929DtV3PuImiT7w1xBHcjXqIeIr\n0NXqI9D9B+BoZRYoNrN9czV9IfF/FFRKsZnK3iAhS1Ij8OOrmFJaJgmCXSN
zPQWe\nUsjSTXcf9yIg7OXFnNCd5sqsom+FdhcWG4j1R26d1XnfFqGgUtVYatJMNqr2Cqvn\nkTB2rPqyXQqGl+04lQiyYWJMsUZljW+K7VB+DOBxXIrevloNJOTla/HkW4/Sg53r\nBRZEcSK5UaqN4/bqtDfwNLXynP+94VOSw8p0xwIDAQABAoIBAAdPL262oboEy1/r\nayUW0NCCh07tRt6aT0lPzJ7K2Ha9/yuU7daasGk1RS+R/PP/qRUdTaFfByCsRRgL\no6rx1VkF8YJLFk94otJytvn48KpZ8N3bc5ufarhxs9qOxjcMCpEFNH8MbZ8uMfmi\naK/xFnY2S38dFEhh0JLrkz2Lr6+CST+t2BtNwnn6olO0Xa7GI9LvxzQOuGCoEjky\nhavrbj3VnW4twLm5BwhahwjcN8u0BU+GdZokxn6cK3PkH6hczUOCGHLGywUHK5Ho\n9dDvm54mI+MHTatlBPkjKQUYyO8rI/wYalEN2yXILqIM1IoRh3wVRtgoCUQk3HHW\ncrKx7wECgYEA9pCWS9rJNFEQRZazQMQMX4gS7eEtR57vjQQq0+QLJ7FSSoRTC9w7\nn3LG+pD7xa2xlleDL+CfV8gf+Ppqx0v83gaWmGnIIGWifqkdqNydSPQIZeIKtDtO\n0X0nkM1SrmCr247yq+0t+69llyBe2vcRpetXi4qGPuzAEeDfunnlqUcCgYEA6Sy5\nR4d/OTOY3TdsbcPQkMxq25vEd+5xV7Up9sq9/mb14z6G2gMZdffAqvn5Ax+9XN+2\nrzdNeTjJrIkzbKpWp5I+QjBXlksjK4hxHu1dFmbD4JyQKjAl8/w3faKbIGHbi4K5\nHoMQOer8VWmmH1CAvyFb5raQBrhGUoEBZxgCmIECgYBgbAiqn2PB1tWzMQzmjgR8\ns30bk8yeTpRFpFSPSoXmPtz8kSTc5YJXh44y3NHo61UggxaleYU20edW+a8aQygf\n
N5pa/jsqGDTkrYQQzj2gEvbZyP0AoJThLb10TidAVEPA9/UEsRsjauMip6EQpkA7\nj35L7p8zKmiuVS+JADSE7wKBgCidEJyD3kYBVbPaTnmD7NT7tfUQWZUmI/nJ5UhG\nIfeoyVVOc8CPX6TrhVSCe7vukFYX5UL5l/XwTThPIXTg6nz/fPacYvUbm0Ge300q\nvNcFCUMbIgUnI8Uufh/U7b4jLVFMcJ/+5hmgc1kRMM0tgW9JCS/TRpzVBfKi47Ko\nPPOBAoGBAL7vg3/R6RWY3vnWCTKGyOtZr3Fh87ypIijnQNZ2xjZIUwDhBk7gx80y\nmpueAjR+nQb3JfXGrV4iiGbRWIWZwf1Rj4HIUthkT01cQ3AUxcnYu+M4/Rv47lJr\nII+J8PzjT0ft6pKTX5MSMeyT8FeJqrskp/jj9DwJ240vnAtiflwn\n-----END RSA PRIVATE KEY-----\n","csr":"-----BEGIN CERTIFICATE REQUEST-----\nMIICyjCCAbICAQAwgYQxCzAJBgNVBAYTAlVTMREwDwYDVQQIEwhOZXcgWW9yazEU\nMBIGA1UEBxMLV2VzdGNoZXN0ZXIxDzANBgNVBAoTBk1hcnZlbDENMAsGA1UECxME\nWG1lbjEsMCoGA1UEAwwjKi51bmlxdWUtc25vd2ZsYWtlLnhhdmllci5sb2NhbGhv\nc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDglKwYQGIDbE3bnAg4\n4lgDSBwE3vhso3PFzRqYXBXLPz1HbE6tIV32XDi/7kzPd07yAQyu04hs55uzwY5K\n1PLH3b0O1Xc+4iaJPvDXEEdyNeoh4ivQ1eoj0P0H4GhlFig2s31zNX0h8X8UVEqx\nmcreICFLUiPw46uYUlomCYJdI3M9BZ5SyNJNdx/3IiDs5cWc0J3myqyib4V2FxYb\niPVHbp3V
ed8WoaBS1Vhq0kw2qvYKq+eRMHas+rJdCoaX7TiVCLJhYkyxRmWNb4rt\nUH4M4HFcit6+Wg0k5OVr8eRbj9KDnesFFkRxIrlRqo3j9uq0N/A0tfKc/73hU5LD\nynTHAgMBAAGgADANBgkqhkiG9w0BAQsFAAOCAQEAIenbNRJsOZ0qZyjCwQW7lYV4\nMRi1Gz2mBJeE7UB9DELa7KwXxpvjftFhZRe1xuB3JYjqVt/x6YYkpQLr+6PXrRqW\ncHsjO5Y+uTdpnP2CjuMA0nK3ssZMKEmUBTR5DXKUL6JR+QqL6psvfbI+DTCoa9ra\npRz+1QQY/wz+ejuGrbdGWPcRcSPpZo1nhJjwIIHlkI/aZ7FdFQxsniQkFP2IVhBg\nCPxE/8hNrdsnbJw5gGy0WbAOqTSRv2Bbwr0YhbgXK8AqnmTtoGKhKGe1x/UmMQIA\nkMqiiKN8g03aSZl3YWSxgnhOHJ19LNAFBTPqgOVO2gdt0XLYl4EoUiA25zKnUw==\n-----END CERTIFICATE REQUEST-----\n"},"expiration":"2022-01-12T00:27:17Z"}'
```
### Delete
```
curl --request DELETE \
--url https://localhost:9090/api/3.1/deliveryservices/xmlId/{{xmlID}}/sslkeys \
--header 'Cookie: mojolicious={{Cooking Value}}'
```
## If this is a bug fix, what versions of Traffic Control are affected?
<!-- If this PR fixes a bug, please list here all of the affected versions - to
the best of your knowledge. It's also pretty helpful to include a commit hash
of where 'master' is at the time this PR is opened (if it affects master),
because what 'master' means will change over time. For example, if this PR
fixes a bug that's present in master (at commit hash '1df853c8'), in v4.0.0,
and in the current 4.0.1 Release candidate (e.g. RC1), then this list would
look like:
- master (1df853c8)
- 4.0.0
- 4.0.1 (RC1)
If you don't know what other versions might have this bug, AND don't know how
to find the commit hash of 'master', then feel free to leave this section
blank (or, preferably, delete it entirely).
-->
master (0ad2086)
## The following criteria are ALL met by this PR
<!-- Check the boxes to signify that the associated statement is true. To
"check a box", replace the space inside of the square brackets with an 'x'.
e.g.
- [ x] <- Wrong
- [x ] <- Wrong
- [] <- Wrong
- [*] <- Wrong
- [x] <- Correct!
-->
- [X] This PR includes tests OR I have explained why tests are unnecessary
- [X] This PR includes documentation OR I have explained why documentation is unnecessary
- [ ] This PR includes an update to CHANGELOG.md OR such an update is not necessary
- [X] This PR includes any and all required license headers
- [X] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
## Additional Information
<!-- If you would like to include any additional information on the PR for
potential reviewers please put it here.
Some examples of this would be:
- Before and after screenshots/gifs of the Traffic Portal if it is affected
- Links to other dependent Pull Requests
- References to relevant context (e.g. new/updates to dependent libraries,
mailing list records, blueprints)
Feel free to leave this section blank (or, preferably, delete it entirely).
-->
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] mattjackson220 merged pull request #5423: Ensure SSL changes are logged.
Posted by GitBox <gi...@apache.org>.
mattjackson220 merged pull request #5423:
URL: https://github.com/apache/trafficcontrol/pull/5423
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org