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 MTLS mode with updated example requests #7

Open
elisherer opened this issue Oct 10, 2019 · 4 comments
Open

Add MTLS mode with updated example requests #7

elisherer opened this issue Oct 10, 2019 · 4 comments

Comments

@elisherer
Copy link

Hi,
Can you make an "MTLS Mode" that will:

  • Remove the required X-Client-Certificate header from API calls
  • Change the "Example request" (e.g. curl to include --cert REPLACE_WITH_CERT --key REPLACE_WITH_KEY)
  • I don't have an idea on how to handle the Try It (Maybe cancel it if this mode is on, clients would probably not like putting their private keys on public websites)

Screenshot of current:
image
image

@redlanne
Copy link
Collaborator

@elisherer thanks for the issue - we aware of work being required in this area and are coordinating with the security architects to determine the best approach.

@redlanne
Copy link
Collaborator

redlanne commented Oct 10, 2019

it is worth noting that the TryIt tab can be disabled by setting the tryIt option to false

@redlanne
Copy link
Collaborator

@elisherer the first part of what you have requested is available in current release of explorer (just not documented - which will be rectified in next release) an option showMTLSHeader, which is set by default to true, if set to false will hide the required X-Client-Certificate header from the operation details and from the test tool.

Additionally:
If you have set the tryIt option to false as mentioned above the TryIt tab will not show. (Alternatively for an individual API the yaml can specify that the API is not testable e.g.

x-ibm-configuration:
  testable: false

)

If the test tool is still used and invoked the CORS message will indicate its limitations, e.g.:
image

@elisherer
Copy link
Author

elisherer commented Oct 15, 2019

Do you have a suggestion on how to handle the "Example request" section?
(If tried the example code there it will fail unless the client certificate will be added, causing confusion and need for support)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants