Bug 1460596

Summary: please don't pass -k/--insecure to curl when using SSL/TLS
Product: Red Hat Satellite Reporter: Evgeni Golov <egolov>
Component: Docs API GuideAssignee: Sergei Petrosian <spetrosi>
Status: CLOSED CURRENTRELEASE QA Contact: Russell Dickenson <rdickens>
Severity: medium Docs Contact:
Priority: medium    
Version: 6.2.10CC: adahms, egolov, swadeley
Target Milestone: Unspecified   
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-06-16 09:57:52 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Evgeni Golov 2017-06-12 07:05:21 UTC 
Document URL:
https://access.redhat.com/documentation/en-us/red_hat_satellite/6.2/html/api_guide/authenticating_api_calls#Authenticating_API_Calls-Using_SSL_Authentication

Section Number and Name: 
3.1. Using SSL Authentication

Describe the issue: 
The section suggests to call "curl … -k … --cacert katello-server-ca.crt" when talking to the API via TLS. However -k means --insecure and thus curl will ignore the given cacert. Please remove the "-k" to actually check the certificate.

Suggestions for improvement:
The curl line should read:
curl -X GET -u sat_username:sat_password \
-H "Accept:application/json" --cacert katello-server-ca.crt \
https://satellite6.example.com/katello/api/organizations

Additional information: 
IMHO "-X GET" is also not needed here and only confuses the reader.
Comment 1 Andrew Dahms 2017-06-12 08:22:43 UTC 
Assigning to Sergei for review.
Comment 15 Sergei Petrosian 2017-06-16 09:57:52 UTC 
These changes are now live on the Custom Portal.

Thank you