You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by bu...@apache.org on 2019/03/29 10:57:39 UTC
svn commit: r1042752 - in /websites/production/cxf/content:
cache/docs.pageCache docs/jax-rs-http-signature.html
Author: buildbot
Date: Fri Mar 29 10:57:38 2019
New Revision: 1042752
Log:
Production update by buildbot for cxf
Modified:
websites/production/cxf/content/cache/docs.pageCache
websites/production/cxf/content/docs/jax-rs-http-signature.html
Modified: websites/production/cxf/content/cache/docs.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/cxf/content/docs/jax-rs-http-signature.html
==============================================================================
--- websites/production/cxf/content/docs/jax-rs-http-signature.html (original)
+++ websites/production/cxf/content/docs/jax-rs-http-signature.html Fri Mar 29 10:57:38 2019
@@ -34,6 +34,7 @@
<script src='/resources/highlighter/scripts/shCore.js'></script>
<script src='/resources/highlighter/scripts/shBrushJava.js'></script>
<script src='/resources/highlighter/scripts/shBrushXml.js'></script>
+<script src='/resources/highlighter/scripts/shBrushBash.js'></script>
<script>
SyntaxHighlighter.defaults['toolbar'] = false;
SyntaxHighlighter.all();
@@ -118,20 +119,119 @@ Apache CXF -- JAX-RS HTTP Signature
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1553687826736 {padding: 0px;}
-div.rbtoc1553687826736 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1553687826736 li {margin-left: 0px;padding-left: 0px;}
-
-/*]]>*/</style></p><div class="toc-macro rbtoc1553687826736">
-<ul class="toc-indentation"><li><a shape="rect" href="#JAX-RSHTTPSignature-Introduction">Introduction</a></li><li><a shape="rect" href="#JAX-RSHTTPSignature-MavenDependencies">Maven Dependencies</a></li><li><a shape="rect" href="#JAX-RSHTTPSignature-HTTPSignatureoverviewandImplementation">HTTP Signature overview and Implementation</a></li><li><a shape="rect" href="#JAX-RSHTTPSignature-Configuration">Configuration</a></li></ul>
-</div><h1 id="JAX-RSHTTPSignature-Introduction">Introduction</h1><p>CXF adds support for the <a shape="rect" class="external-link" href="https://tools.ietf.org/html/draft-cavage-http-signatures-10" rel="nofollow">HTTP Signatures</a> draft spec since CXF 3.3.0.</p><h1 id="JAX-RSHTTPSignature-MavenDependencies">Maven Dependencies</h1><p>Having the following dependency will let developers write JOSE JWS or JWE code:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+div.rbtoc1553857019500 {padding: 0px;}
+div.rbtoc1553857019500 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1553857019500 li {margin-left: 0px;padding-left: 0px;}
+
+/*]]>*/</style></p><div class="toc-macro rbtoc1553857019500">
+<ul class="toc-indentation"><li><a shape="rect" href="#JAX-RSHTTPSignature-Introduction">Introduction</a></li><li><a shape="rect" href="#JAX-RSHTTPSignature-MavenDependencies">Maven Dependencies</a></li><li><a shape="rect" href="#JAX-RSHTTPSignature-Configuration">Configuration</a>
+<ul class="toc-indentation"><li><a shape="rect" href="#JAX-RSHTTPSignature-Providers">Providers</a></li><li><a shape="rect" href="#JAX-RSHTTPSignature-FinegrainedConfiguration">Fine grained Configuration</a></li><li><a shape="rect" href="#JAX-RSHTTPSignature-ConfigurationProperties">Configuration Properties</a></li></ul>
+</li></ul>
+</div><h1 id="JAX-RSHTTPSignature-Introduction">Introduction</h1><p>CXF adds support for the <a shape="rect" class="external-link" href="https://tools.ietf.org/html/draft-cavage-http-signatures-10" rel="nofollow">HTTP Signatures</a> draft spec since CXF 3.3.0. This provides an alternative to providing message integrity other than <a shape="rect" href="jax-rs-xml-security.html">XML Security</a> and <a shape="rect" href="jax-rs-jose.html">JOSE</a>, and in fact provides a stronger measure of message integrity as it allows the incorporation of HTTP headers in the signature, including the HTTP method and path.</p><h1 id="JAX-RSHTTPSignature-MavenDependencies">Maven Dependencies</h1><p>The following dependency is required to use CXF's HTTP Signature implementation.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="brush: java; gutter: false; theme: Default"><dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-rs-security-http-signature</artifactId>
<version>3.3.1</version>
</dependency>
</pre>
-</div></div><p><br clear="none"></p><h1 id="JAX-RSHTTPSignature-HTTPSignatureoverviewandImplementation">HTTP Signature overview and Implementation</h1><p><br clear="none"></p><h1 id="JAX-RSHTTPSignature-Configuration">Configuration</h1><p>The following configuration properties can be used to configure HTTP Signature with the various filters. Note that they are shared for the most part with <a shape="rect" href="jax-rs-jose.html">JAX-RS JOSE</a>.</p><p><br clear="none"></p><div class="table-wrap"><table class="wrapped confluenceTable"><colgroup span="1"><col span="1"><col span="1"><col span="1"></colgroup><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Configuration Tag</th><th colspan="1" rowspan="1" class="confluenceTh">Default</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.keystore</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan
="1" class="confluenceTd">The Java KeyStore Object to use. This configuration tag is used if you want to pass the KeyStore Object through dynamically.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>rs.security.keystore.type</p></td><td colspan="1" rowspan="1" class="confluenceTd">JKS</td><td colspan="1" rowspan="1" class="confluenceTd"><p>The keystore type.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.keystore.password</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd">The password required to access the keystore.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.keystore.alias</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd"> The keystore alias corresponding to the key to use.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.keystore
.file</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd">The path to the keystore file.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.key.password</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd">The password required to access the private key (in the keystore).</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.key.password.provider</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd">A reference to a PrivateKeyPasswordProvider instance used to retrieve passwords to access keys.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.signature.out.properties</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The signature pr
operties file for Compact or JSON signature creation. If not specified then it falls back to "rs.security.signature.properties".</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.signature.in.properties</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The signature properties file for Compact or JSON signature verification. If not specified then it falls back to "rs.security.signature.properties".</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.signature.properties</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd">The signature properties file for Compact or JSON signature creation/verification.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.signature.algorithm</td><td colspan="1" rowspan="1" class="confluenceTd">rsa-sha256</td><td colspan="1" rowspa
n="1" class="confluenceTd">The signature algorithm to use.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.http.signature.key.id</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd">The signature key id. This is a required configuration option on the outbound side.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.http.signature.out.headers</td><td colspan="1" rowspan="1" class="confluenceTd">all headers incl "(request-target)"</td><td colspan="1" rowspan="1" class="confluenceTd"><p>A list of String values which correspond to the list of HTTP headers that will be signed in the outbound request.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.http.signature.in.headers</td><td colspan="1" rowspan="1" class="confluenceTd">"(request-target)" for a client request</td><td colspan="1" rowspan="1" class="confluenceTd"><p>A list of String valu
es which correspond to the list of HTTP headers that must be signed in the inbound request.</p></td></tr></tbody></table></div><p><br clear="none"></p><p><br clear="none"></p></div>
+</div></div><h1 id="JAX-RSHTTPSignature-Configuration">Configuration</h1><p>CXF supports HTTP Signature creation and verification on both the client and service side.</p><h2 id="JAX-RSHTTPSignature-Providers">Providers</h2><p>To enable HTTP Signature in CXF, it is necessary to add one of the following providers to the client or endpoint:</p><ul><li>Client Outbound Signature Creation: org.apache.cxf.rs.security.httpsignature.filters.CreateSignatureClientFilter</li><li>Client Inbound Signature Verification: org.apache.cxf.rs.security.httpsignature.filters.VerifySignatureClientFilter</li><li>Service Outbound Signature Creation: org.apache.cxf.rs.security.httpsignature.filters.CreateSignatureFilter</li><li>Service Inbound Signature Verification: org.apache.cxf.rs.security.httpsignature.filters.VerifySignatureFilter</li></ul><p>For example in code:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>WebCli
ent Config</b></div><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default">CreateSignatureClientFilter signatureFilter = new CreateSignatureClientFilter();
+
+String address = "http://localhost:" + PORT + "/httpsig/bookstore/books";
+WebClient client =
+ WebClient.create(address, Collections.singletonList(signatureFilter), busFile.toString());</pre>
+</div></div><p>and in Spring:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Spring Config</b></div><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default"><bean id="httpSignatureVerifier" class="org.apache.cxf.rs.security.httpsignature.filters.VerifySignatureFilter">
+ <property name="messageVerifier" ref="messageVerifier"/>
+</bean>
+
+<jaxrs:server address="http://localhost:${testutil.ports.jaxrs-httpsignature}/httpsig">
+ <jaxrs:serviceBeans>
+ <ref bean="serviceBean"/>
+ </jaxrs:serviceBeans>
+ <jaxrs:providers>
+ <ref bean="httpSignatureVerifier"/>
+ </jaxrs:providers>
+</jaxrs:server></pre>
+</div></div><h2 id="JAX-RSHTTPSignature-FinegrainedConfiguration">Fine grained Configuration</h2><p>As well as adding the desired providers (see above), we need to configure them (for example the keys to use, the headers to sign, etc.). There are two options for doing this. In this section we'll look at configuring the providers directly, which allows for a more fine-grained configuration. See below for an alternative using configuration properties that retrieves keys from keystores.</p><p>For outbound signature we need to configure the CreateSignatureClientFilter + CreateSignatureFilter providers with a MessageSigner instance. The MessageSigner contains a number of different constructors that can be used depending on the desired functionality. At a minimum, we need to supply the PrivateKey instance to sign the message, as well as the "Key Id" as defined in the spec. We can also supply the signature algorithm name - if not specified this defaults to "rsa-sha256". Similarly we can su
pply the security provider name, which defaults to "SunRsaSign".</p><p>We can also supply a list of HTTP headers to sign. By default it signs all of the HTTP headers that are made available to it by CXF. On the client side it will also sign the HTTP method and Path via "(request-target)".</p><p>Here is an example from the tests:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default">CreateSignatureClientFilter signatureFilter = new CreateSignatureClientFilter();
+KeyStore keyStore = KeyStore.getInstance("JKS");
+keyStore.load(ClassLoaderUtils.getResourceAsStream("keys/alice.jks", this.getClass()),
+ "password".toCharArray());
+PrivateKey privateKey = (PrivateKey)keyStore.getKey("alice", "password".toCharArray());
+assertNotNull(privateKey);
+
+MessageSigner messageSigner = new MessageSigner(privateKey, "alice-key-id");
+signatureFilter.setMessageSigner(messageSigner);
+
+String address = "http://localhost:" + PORT + "/httpsig/bookstore/books";
+WebClient client =
+ WebClient.create(address, Collections.singletonList(signatureFilter), busFile.toString());
+client.type("application/xml").accept("application/xml");
+
+</pre>
+</div></div><p>For signature verification, we need to supply the VerifySignatureClientFilter and VerifySignatureFilter instances with a MessageVerifier instance. At a minimum, we need to configure the MessageVerifier with a PublicKeyProvider instance, which is an interface which supplies the public key required to verify the signature given the "Key Id" present in the message. As per MessageSigner, we can also specify the signature algorithm that is required, as well as the Security Provider. It defaults to the same values as documented for MessageSigner above. We can also specify a list of HTTP headers which must be signed.</p><p>Here is an example from the tests:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default"><bean id="publicKeyProvider" class="org.apache.cxf.systest.jaxrs.security.httpsignature.CustomPublicKeyProvider"/>
+<bean id="messageVerifier" class="org.apache.cxf.rs.security.httpsignature.MessageVerifier">
+ <constructor-arg>
+ <ref bean="publicKeyProvider"/>
+ </constructor-arg>
+ <constructor-arg>
+ <util:list>
+ <value>(request-target)</value>
+ </util:list>
+ </constructor-arg>
+</bean>
+<bean id="httpSignatureVerifier" class="org.apache.cxf.rs.security.httpsignature.filters.VerifySignatureFilter">
+ <property name="messageVerifier" ref="messageVerifier"/>
+</bean>
+
+<jaxrs:server address="http://localhost:${testutil.ports.jaxrs-httpsignature}/httpsig">
+ <jaxrs:serviceBeans>
+ <ref bean="serviceBean"/>
+ </jaxrs:serviceBeans>
+ <jaxrs:providers>
+ <ref bean="httpSignatureVerifier"/>
+ </jaxrs:providers>
+</jaxrs:server></pre>
+</div></div><p><br clear="none"></p><h2 id="JAX-RSHTTPSignature-ConfigurationProperties">Configuration Properties</h2><p>An alternative to configure the MessageSigner, MessageVerifier instances as documented in the previous section is to use the following security configuration properties instead. These properties rely on obtaining the private keys to sign the messages, as well as the public keys used to verify the messages, from a keystore stored in the local filesystem. Note that the "Key Id" is ignored, we verify the message using the public key defined in the configuration properties.</p><p>The following configuration properties can be used to configure HTTP Signature with the various filters. Note that they are shared for the most part with <a shape="rect" href="jax-rs-jose.html">JAX-RS JOSE</a>.</p><p><br clear="none"></p><div class="table-wrap"><table class="wrapped confluenceTable"><colgroup span="1"><col span="1"><col span="1"><col span="1"></colgroup><tbody><tr><th colspan
="1" rowspan="1" class="confluenceTh">Configuration Tag</th><th colspan="1" rowspan="1" class="confluenceTh">Default</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.keystore</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd">The Java KeyStore Object to use. This configuration tag is used if you want to pass the KeyStore Object through dynamically.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>rs.security.keystore.type</p></td><td colspan="1" rowspan="1" class="confluenceTd">JKS</td><td colspan="1" rowspan="1" class="confluenceTd"><p>The keystore type.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.keystore.password</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd">The password required to access the
keystore.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.keystore.alias</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd"> The keystore alias corresponding to the key to use.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.keystore.file</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd">The path to the keystore file.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.key.password</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd">The password required to access the private key (in the keystore).</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.key.password.provider</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan=
"1" class="confluenceTd">A reference to a PrivateKeyPasswordProvider instance used to retrieve passwords to access keys.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.signature.out.properties</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The signature properties file for Compact or JSON signature creation. If not specified then it falls back to "rs.security.signature.properties".</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.signature.in.properties</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The signature properties file for Compact or JSON signature verification. If not specified then it falls back to "rs.security.signature.properties".</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.signature.properties</td><td colspan="1" rowspan=
"1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd">The signature properties file for Compact or JSON signature creation/verification.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.signature.algorithm</td><td colspan="1" rowspan="1" class="confluenceTd">rsa-sha256</td><td colspan="1" rowspan="1" class="confluenceTd">The signature algorithm to use.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.http.signature.key.id</td><td colspan="1" rowspan="1" class="confluenceTd"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd">The signature key id. This is a required configuration option on the outbound side.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.http.signature.out.headers</td><td colspan="1" rowspan="1" class="confluenceTd">all headers incl "(request-target)"</td><td colspan="1" rowspan="1" class="confluenceTd"><p>A list of String values w
hich correspond to the list of HTTP headers that will be signed in the outbound request.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rs.security.http.signature.in.headers</td><td colspan="1" rowspan="1" class="confluenceTd">"(request-target)" for a client request</td><td colspan="1" rowspan="1" class="confluenceTd"><p>A list of String values which correspond to the list of HTTP headers that must be signed in the inbound request.</p></td></tr></tbody></table></div><p><br clear="none"></p><p>Here is a Java example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default">List<Object> providers = new ArrayList<>();
+providers.add(new CreateSignatureClientFilter());
+providers.add(new VerifySignatureClientFilter());
+String address = "http://localhost:" + PORT + "/httpsigresponse/bookstore/books";
+WebClient client = WebClient.create(address, providers, busFile.toString());
+client.type("application/xml").accept("application/xml");
+
+Map<String, Object> properties = new HashMap<>();
+properties.put("rs.security.signature.out.properties",
+ "org/apache/cxf/systest/jaxrs/security/httpsignature/alice.httpsig.properties");
+properties.put("rs.security.signature.in.properties",
+ "org/apache/cxf/systest/jaxrs/security/httpsignature/bob.httpsig.properties");
+WebClient.getConfig(client).getRequestContext().putAll(properties);</pre>
+</div></div><p>where "alice.httpsig.properties" looks like:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default">rs.security.keystore.type=jks
+rs.security.keystore.password=password
+rs.security.keystore.alias=alice
+rs.security.keystore.file=keys/alice.jks
+rs.security.key.password=password
+rs.security.http.signature.key.id=alice-key-id</pre>
+</div></div><p>Here is a spring example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default"><jaxrs:server address="http://localhost:${testutil.ports.jaxrs-httpsignature}/httpsigresponseprops">
+ <jaxrs:serviceBeans>
+ <ref bean="serviceBean"/>
+ </jaxrs:serviceBeans>
+ <jaxrs:providers>
+ <bean class="org.apache.cxf.rs.security.httpsignature.filters.VerifySignatureFilter" />
+ <bean class="org.apache.cxf.rs.security.httpsignature.filters.CreateSignatureFilter" />
+ </jaxrs:providers>
+ <jaxrs:properties>
+ <entry key="rs.security.signature.in.properties"
+ value="org/apache/cxf/systest/jaxrs/security/httpsignature/alice.httpsig.properties" />
+ <entry key="rs.security.signature.out.properties"
+ value="org/apache/cxf/systest/jaxrs/security/httpsignature/bob.httpsig.properties" />
+ </jaxrs:properties>
+</jaxrs:server></pre>
+</div></div><p><br clear="none"></p></div>
</div>
<!-- Content -->
</td>