Skip to content

Commit bf81514

Browse files
committed
adding how to use X509 client keys
1 parent 438925b commit bf81514

File tree

3 files changed

+279
-3
lines changed

3 files changed

+279
-3
lines changed

REST/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,19 @@ For a more in-depth description see the [How-to article on setting up the connec
2525

2626
To be able to connect over RAD/REST we require you use the secure *https* transport and in order for this to the system you're connecting to must have a valid SSL certificate in place for the client to know it can be trusted.
2727

28-
Many production systems will have certificate in place issued by either a *public CA* (Certificate Authority) or an *internal CA* managed by the company (we're call these a *managed CA*). However quite often systems you're testing on might not have one of these certificates from a managed CA. For example you might be using a Oracle Solaris running in VirtualBox on your laptop. In this case to still be able to connect to the server you'll need to copy a certificate the host CA created over to the system you're connecting from.
28+
Many production systems will have certificate in place issued by either a *public CA* (Certificate Authority) or an *internal CA* managed by the company (we're calling these a *managed CA*). However quite often systems you're testing on might not have one of these certificates from a managed CA. For example you might be using a Oracle Solaris running in VirtualBox on your laptop. In this case to still be able to connect to the server you'll need to copy the self-signed certificate the host CA created over to the system you're connecting from.
2929

30-
By default in Oracle Solaris 11.4 the `identity:cert` service will act as the host CA and create the certificates using the hostname and DNS name information it can find after installation. It will create and put them in `/etc/certs/localhost/hoast-ca/` and it's the `hostca.crt` you're looking to copy across (the `host.key` should remain in place). It's important to realize that the names that the certificate was created with should be the same as the name the client sees, if it doesn't match you'll have to create a certificate by hand and then put it in the same location.
30+
By default in Oracle Solaris 11.4 the `identity:cert` service will act as the host CA and create the certificates using the hostname and DNS name information it can find after installation. It will create and put them in `/etc/certs/localhost/hoast-ca/` and it's the `hostca.crt` you're looking to copy across (the `hostca.key` should remain in place). It's important to realize that the name or IP address that the certificate was created with should be the same as the name or IP address that the client sees, if it doesn't match you'll have to create a certificate by hand and then put it in the same location.
3131

3232
Once you have the certificates created, copied and the SMF service started you can use your favorite client tool and start connecting with the server.
3333

34+
If you're going to be connecting to multiple servers with self-signed certificates, you will probably want to rename the `hostca.crt` you've copied from each server to know which file goes with which server.
35+
3436
## More Documentation
3537

3638
So now you know how to connect, the next question that tends to rise is where to find an explanation of the full RAD/REST API. There are of course the online [docs on the RAD interface](https://docs.oracle.com/cd/E37838_01/html/E68270/index.html) which also has a [section on REST in it](https://docs.oracle.com/cd/E37838_01/html/E68270/gpzxz.html#scrolltoc). But this is by no means a complete description of the API. Plus the API is also dynamic, as we add RAD modules there are more endpoints to talk to. To solve for this we've included a documentation package in Oracle Solaris 11.4 called `webui-docs`, that when added to the system with give an extra *Application* in the Oracle Solaris WebUI. Once installed you'll see "**Solaris Documentation**" as an option below "**Solaris Analytics**" and "**Solaris Dashboard**" in the "**Applications**" pull-down menu. Once selected you'll see a link to "**Solaris APIs**", and clicking this will bring you to the full REST API description of all the RAD modules on that system.
3739

3840

3941

40-
Copyright (c) 2020, Oracle and/or its affiliates.
42+
Copyright (c) 2022, Oracle and/or its affiliates.
4143
Licensed under the Universal Permissive License v 1.0 as shown at <https://oss.oracle.com/licenses/upl/>.

0 commit comments

Comments
 (0)