...
|
{code}
|
h3. Instantiating a ShiroSecurityPolicy Object
|
|
h3. Options
{div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{keepAlive}} | {{true}} | Setting to ensure socket is not closed due to inactivity |
| {{tcpNoDelay}} | {{true}} | Setting to improve TCP protocol performance |
| {{broadcast}} | {{false}} | Setting to choose Multicast over UDP |
| {{connectTimeout}} | {{10000}} | Time to wait for a socket connection to be available. Value is in millis. |
| {{timeout}} | {{30000}} | Time to wait for a response to be received on a connection. Value is in millis. |
| {{reuseAddress}} | {{true}} | Setting to facilitate socket multiplexing |
| {{sync}} | {{true}} | Setting to set endpoint as one-way or request-response |
| {{ssl}} | {{false}} | Setting to specify whether SSL encryption is applied to this endpoint |
| {{sendBufferSize}} | {{65536 bytes}} | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. |
| {{receiveBufferSize}} | {{65536 bytes}} | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. |
| {{corePoolSize}} | {{10}} | The number of allocated threads at component startup. Defaults to 10 |
| {{maxPoolSize}} | {{100}} | The maximum number of threads that may be allocated to this endpoint. Defaults to 100 |
| {{disconnect}} | {{false}} | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. |
| {{lazyChannelCreation}} | {{true}} | Channels can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started. |
| {{transferExchange}} | {{false}} | Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. |
| {{disconnectOnNoReply}} | {{true}} | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. |
| {{noReplyLogLevel}} | {{WARN}} | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. Values are: {{FATAL, ERROR, INFO, DEBUG, OFF}}. |
| {{allowDefaultCodec}} | {{true}} | *Camel 2.4:* The netty component installs a default codec if both, encoder/deocder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. |
| {{textline}} | {{false}} | *Camel 2.4:* Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP. |
| {{delimiter}} | {{LINE}} | *Camel 2.4:* The delimiter to use for the textline codec. Possible values are {{LINE}} and {{NULL}}. |
| {{decoderMaxLineLength}} | {{1024}} | *Camel 2.4:* The max line length to use for the textline codec. |
| {{autoAppendDelimiter}} | {{true}} | *Camel 2.4:* Whether or not to auto append missing end delimiter when sending using the textline codec. |
| {{encoding}} | {{null}} | *Camel 2.4:* The encoding (a charset name) to use for the textline codec. If not provided, Camel will use the JVM default Charset. |
{div}
|
A ShiroSecurityPolicy object is instantiated as follows
|
|
h3. Registry based Options
|
{code}
private final String iniResourcePath = "classpath:shiro.ini";
private final byte[] passPhrase = {
(byte) 0x08, (byte) 0x09, (byte) 0x0A, (byte) 0x0B,
(byte) 0x0C, (byte) 0x0D, (byte) 0x0E, (byte) 0x0F,
(byte) 0x10, (byte) 0x11, (byte) 0x12, (byte) 0x13,
(byte) 0x14, (byte) 0x15, (byte) 0x16, (byte) 0x17};
List<permission> permissionsList = new ArrayList<permission>();
Permission permission = new WildcardPermission("zone1:readwrite:*");
permissionsList.add(permission);
|
|
Codec Handlers and SSL Keystores can be enlisted in the [Registry], such as in the Spring XML file.
The values that could be passed in, are the following:
|
final ShiroSecurityPolicy securityPolicy =
new ShiroSecurityPolicy(iniResourcePath, passPhrase, true, permissionsList);
{code}
|
|
h3. ShiroSecurityPolicy Options
|
{div:class=confluenceTableSmall}
|
|| Name || Default Value || Type || Description ||
|
| {{passphrase}} | password setting to use in order to encrypt/decrypt payloads sent using SSH |
| {{keyStoreFormat}} | keystore format to be used for payload encryption. Defaults to "JKS" if not set |
| {{securityProvider}} | Security provider to be used for payload encryption. Defaults to "SunX509" if not set. |
| {{keyStoreFile}} | Client side certificate keystore to be used for encryption |
| {{trustStoreFile}} | Server side certificate keystore to be used for encryption |
| {{sslHandler}} | Reference to a class that could be used to return an SSL Handler |
| {{encoder}} | A custom Handler class that can be used to perform special marshalling of outbound payloads. Must override {{org.jboss.netty.channel.ChannelDownStreamHandler}}. |
| {{encorders}} | A list of encoder to be used. You can use a String which have values separated by comma, and have the values be looked up in the [Registry]. Just remember to prefix the value with # so Camel knows it should lookup. |
| {{decoder}} | A custom Handler class that can be used to perform special marshalling of inbound payloads. Must override {{org.jboss.netty.channel.ChannelUpStreamHandler}}. |
| {{decoders}} | A list of decorder to be used. You can use a String which have values separated by comma, and have the values be looked up in the [Registry]. Just remember to prefix the value with # so Camel knows it should lookup. |
|
| {{iniResourcePath or ini}} | {{none}} | Resource String or Ini Object | A mandatory Resource String for the iniResourcePath or an instance of an Ini object must be passed to the security policy. Resources can be acquired from the file system, classpath, or URLs when prefixed with "file:, classpath:, or url:" respectively. For e.g "classpath:shiro.ini" |
| {{passPhrase}} | {{An AES 128 based key}} | byte[] | A passPhrase to decrypt ShiroSecurityToken(s) sent along with Message Exchanges |
| {{alwaysReauthenticate}} | {{true}} | boolean | Setting to ensure re-authentication on every individual request. If set to false, the user is authenticated and locked such than only requests from the same user going forward are authenticated. |
| {{permissionsList}} | {{none}} | List<Permission> | A List of permissions required in order for an authenticated user to be authorized to perform further action i.e continue further on the route. If no Permissions list is provided to the ShiroSecurityPolicy object, then authorization is deemed as not required |
| {{cipherService}} | {{AES}} | org.apache.shiro.crypto.CipherService | Shiro ships with AES & Blowfish based CipherServices. You may use one these or pass in your own Cipher implementation |
|
{div}
|
h3. Sending Messages to/from a Netty endpoint
|
h3. Applying Shiro Authentication on a Camel Route
|
|
h4. Netty Producer
In Producer mode, the component provides the ability to send payloads to a socket endpoint
using either TCP or UDP protocols (with optional SSL support).
|
The ShiroSecurityPolicy, tests and permits incoming message exchanges containing a encrypted SecurityToken in the Message Header to proceed further following proper authentication. The SecurityToken object contains a Username/Password details that are used to determine where the user is a valid user.
|
|
The producer mode supports both one-way and request-response based operations.
|
{code}
protected RouteBuilder createRouteBuilder() throws Exception {
final ShiroSecurityPolicy securityPolicy =
new ShiroSecurityPolicy("classpath:shiro.ini", passPhrase);
return new RouteBuilder() {
public void configure() {
onException(UnknownAccountException.class).
to("mock:authenticationException");
onException(IncorrectCredentialsException.class).
to("mock:authenticationException");
onException(LockedAccountException.class).
to("mock:authenticationException");
onException(AuthenticationException.class).
to("mock:authenticationException");
from("direct:secureEndpoint").
to("log:incoming payload").
policy(securityPolicy).
to("mock:success");
}
};
}
{code}
|
|
h4. Netty Consumer
In Consumer mode, the component provides the ability to:
- listen on a specified socket using either TCP or UDP protocols (with optional SSL support),
- receive requests on the socket using text/xml, binary and serialized object based payloads and
- send them along on a route as message exchanges.
|
h3. Applying Shiro Authorization on a Camel Route
|
|
The consumer mode supports both one-way and request-response based operations.
|
Authorization can be applied on a camel route by associating a Permissions List with the ShiroSecurityPolicy. The Permissions List specifies the permissions necessary for the user to proceed with the execution of the route segment. If the user does not have the proper permission set, the request is not authorized to continue any further.
|
|
h3. Usage Samples
h4. A UDP Netty endpoint using Request-Reply and serialized object payload
|
{code}
|
protected RouteBuilder createRouteBuilder() throws Exception {
final ShiroSecurityPolicy securityPolicy =
new ShiroSecurityPolicy("./src/test/resources/securityconfig.ini", passPhrase);
|
RouteBuilder builder = return new RouteBuilder() {
|
public void configure() {
|
from("netty:udp://localhost:5155?sync=true") onException(UnknownAccountException.class).
|
.process(new Processor() {
public void process(Exchange exchange) throws Exception {
Poetry poetry = (Poetry) exchange.getIn().getBody();
poetry.setPoet("Dr. Sarojini Naidu");
|
exchange.getOut().setBody(poetry); to("mock:authenticationException");
|
} onException(IncorrectCredentialsException.class).
|
} to("mock:authenticationException");
|
onException(LockedAccountException.class).
to("mock:authenticationException");
onException(AuthenticationException.class).
to("mock:authenticationException");
from("direct:secureEndpoint").
to("log:incoming payload").
policy(securityPolicy).
to("mock:success");
}
};
|
}
|
};
|
{code}
|
h4. A TCP based Netty consumer endpoint using One-way communication
{code}
RouteBuilder builder = new RouteBuilder() {
public void configure() {
from("netty:tcp://localhost:5150")
.to("mock:result");
}
};
{code}
|
h3. Creating a ShiroSecurityToken and injecting it into a Message Exchange
|
|
h4. An SSL/TCP based Netty consumer endpoint using Request-Reply communication
|
A ShiroSecurityToken object may be created and injected into a Message Exchange using a Shiro Processor called ShiroSecurityTokenInjector. An example of injecting a ShiroSecurityToken using a ShiroSecurityTokenInjector in the client is shown below
|
{code}
|
JndiRegistry registry = new JndiRegistry(createJndiContext());
registry.bind("password", "changeit");
registry.bind("ksf", new File("src/test/resources/keystore.jks"));
registry.bind("tsf", new File("src/test/resources/keystore.jks"));
|
ShiroSecurityToken shiroSecurityToken = new ShiroSecurityToken("ringo", "starr");
ShiroSecurityTokenInjector shiroSecurityTokenInjector =
new ShiroSecurityTokenInjector(shiroSecurityToken, passPhrase);
|
|
context.createRegistry(registry); from("direct:client").
|
context.addRoutes(new RouteBuilder() {
public void configure() {
String netty_ssl_endpoint =
|
"netty:tcp://localhost:5150sync=true&ssl=true&passphrase=#password" process(shiroSecurityTokenInjector).
|
+ "&keyStoreFile=#ksf&trustStoreFile=#tsf";
String return_string =
"When You Go Home, Tell Them Of Us And Say,"
+ "For Your Tomorrow, We Gave Our Today.";
|
to("direct:secureEndpoint");
|
from(netty_ssl_endpoint)
.process(new Processor() {
public void process(Exchange exchange) throws Exception {
exchange.getOut().setBody(return_string);
}
}
}
});
|
{code}
|
h4. Using Multiple Codecs
|
h3. Sending Messages to routes secured by a ShiroSecurityPolicy
|
|
In certain cases it may be necessary to add chains of encoders and decoders to the netty pipeline. To add multpile codecs to a camel netty endpoint the 'encoders' and 'decoders' uri parameters should be used. Like the 'encoder' and 'decoder' parameters they are used to supply references (to lists of ChannelUpstreamHandlers and ChannelDownstreamHandlers) that should be added to the pipeline. Note that if encoders is specified then the encoder param will be ignored, similarly for decoders and the decoder param.
|
Messages and Message Exchanges sent along the camel route where the security policy is applied need to be accompanied by a SecurityToken in the Exchange Header. The SecurityToken is an encrypted object that holds a Username and Password. The SecurityToken is encrypted using AES 128 bit security by default and can be changed to any cipher of your choice.
|
|
The lists of codecs need to be added to the Camel's registry so they can be resolved when the endpoint is created.
|
Given below is an example of how a request may be sent using a ProducerTemplate in Camel along with a SecurityToken
|
|
{snippet:id=registry-beans|lang=java|url=""
|
{code}
@Test
public void testSuccessfulShiroAuthenticationWithNoAuthorization() throws Exception {
//Incorrect password
ShiroSecurityToken shiroSecurityToken = new ShiroSecurityToken("ringo", "stirr");
|
|
Spring's native collections support can be used to specify the codec lists in an application context
|
// TestShiroSecurityTokenInjector extends ShiroSecurityTokenInjector
TestShiroSecurityTokenInjector shiroSecurityTokenInjector =
new TestShiroSecurityTokenInjector(shiroSecurityToken, passPhrase);
|
{snippet:id=registry-beans|lang=xml|url=""
|
|
successEndpoint.expectedMessageCount(1);
|
The bean names can then be used in netty endpoint definitions either as a comma separated list or contained in a List e.g.
|
failureEndpoint.expectedMessageCount(0);
|
{snippet:id=routes|lang=java|url=""
|
or via spring.
|
template.send("direct:secureEndpoint", shiroSecurityTokenInjector);
|
{snippet:id=routes|lang=xml|url=""
|
|
successEndpoint.assertIsSatisfied();
|
h3. Closing Channel When Complete
When acting as a server you sometimes want to close the channel when, for example, a client conversion is finished.
You can do this by simply setting the endpoint option {{disconnect=true}}.
|
failureEndpoint.assertIsSatisfied();
|
However you can also instruct Camel on a per message basis as follows.
To instruct Camel to close the channel, you should add a header with the key {{CamelNettyCloseChannelWhenComplete}} set to a boolean {{true}} value.
For instance, the example below will close the channel after it has written the bye message back to the client:
|
}
|
{code}
|
from("netty:tcp://localhost:8080").process(new Processor() {
public void process(Exchange exchange) throws Exception {
String body = exchange.getIn().getBody(String.class);
exchange.getOut().setBody("Bye " + body);
// some condition which determines if we should close
if (close) {
exchange.getOut().setHeader(NettyConstants.NETTY_CLOSE_CHANNEL_WHEN_COMPLETE, true);
}
}
});
{code}
{include:Endpoint See Also}
- [Mina]
|
