Developing an Audit-logging for FuseESB (servicemix) & Karaf

For many secured environments there's a requirement to log every user management action.

The idea is to have an Audit logging module, that allow the production service, to have a trace for all administrative tasks done in Fuse ESB(servicemix) or karaf over the following channels : (SSH, WebConsole, JMX)

The trace should contain information about user logged, the command performend, channel used, date, ...etc

To run the service you need to download and add event admin service jar into system folder under appropriate path like <Fuse-ESB-install>/system/org/apache/felix/org.apache.felix.eventadmin/1.2.8-fuse-00-43/org.apache.felix.eventadmin-1.2.8-fuse-00-43.jar

Then add following to etc/startup.properties file to auto start EventAdmin service (which will generate events):

org/apache/felix/org.apache.felix.eventadmin/1.2.8-fuse-00-43/org.apache.felix.eventadmin-1.2.8-fuse-00-43.jar=9

The service contains a class LoggingEventListener that implement eventhandler, that just logs the events it receives:

StringBuffer buffer = new StringBuffer();

        buffer.append(String.format("Event [%n"));

        buffer.append(String.format("Topic: %s%n", event.getTopic()));

        for (String name : event.getPropertyNames()) {

            buffer.append(String.format("%n%s = %s", name, event.getProperty(name)));

        }

       

        buffer.append("]");

        LOGGER.info(buffer.toString());

All these events are filtered following properties fixed in blueprint.xml:

<bean id="handler" class="com.abouchama.LoggingEventListener" />

    <service ref="handler" interface="org.osgi.service.event.EventHandler">

        <service-properties>

                  <entry key="event.topics" value="org/apache/*"/>

            </service-properties>

    </service>

You can build & install bundle from Github and deploy it. Once that's done you should see the output I shown in the following example:

Example of log:

17:22:34,119 | INFO | Thread-11 | LoggingEventListener | com.abouchama.LoggingEventListener 25 | Event [
Topic: org/apache/felix/service/command/EXECUTING

command = osgi:list

event.topics = org/apache/felix/service/command/EXECUTING

event.subject = Subject:

                    Principal: UserPrincipal[karaf]

]

In this example you can see sample entries for actions taken via SSH. Log entries contain info like:

                         - Username : karaf

                         - Command performed : osgi:list

                         - Event : org/apache/felix/service/command/EXECUTING

Enjoy :)

Continuous Integration/Delivery featuring Maven, Nexus and Sonar

Continuous Integration:

In an enterprise project, it is important to continually check the non regression of the product realized. Like unit tests, acceptance tests are part of the test harness to implement a project.

Below are the usual set of tasks.

• Build
• Unit Test
• Run Code Quality Checks
• Deploy
• Run Acceptance Test

In my current project, we have chosen below tools for Continuous Integration strategy:

• Maven to build and unit test
• Sonar to perform code quality checks
• Nexus as Maven repository
• Shell Scripting to deploy

In today's post, we will go over how to use Maven and Nexus to build and publish binaries.

Maven to Build and Unit Test:

Building java projects with maven is really easy. You just need to have maven-compiler-plugin in your pom.xml. Java sources will be compiled without doing any more work If you follow standard maven guidelines for your project folder structure.

<plugin>

                        <groupId>org.apache.maven.plugins</groupId>

                        <artifactId>maven-compiler-plugin</artifactId>

                        <version>2.3.2</version>

                  </plugin>

Unit testing is possible with maven-surefire-plugin. Maven-surefire-plugin can run tests with testing frameworks like Junit, TestNG etc.

<plugin>

                        <groupId>org.apache.maven.plugins</groupId>

                        <artifactId>maven-surefire-plugin</artifactId>

                        <configuration>

                             <forkMode>pertest</forkMode>

                             <childDelegation>false</childDelegation>

                             <useFile>true</useFile>

                             <failIfNoTests>false</failIfNoTests>

                             <includes>

                                   <include>**/*Test.java</include>

                             </includes>

                        </configuration>

                  </plugin>

Maven to Publish artifacts to Nexus:

All maven projects have artifacts that are generated by the build. An artifact can be a jar file, war file, zip file, ear file and a pom file. All these artifacts need to be stored in a repository for versioning purposes.

Your project’s pom.xml will have details of Nexus as maven repository in distribtionManagement section. Make sure your maven settings file has authentication details to publish to Nexus repository. Maven deploy goal needs to be executed to deploy to Nexus repository.

Pom.xml:

<project>

...

<distributionManagement>

            <repository>

                  <id>releases</id>

                  <uniqueVersion>false</uniqueVersion>

                  <name>Company Releases</name>       <url>http://localhost:8081/nexus/content/repositories/releases</url>

            </repository>

            <snapshotRepository>

                  <id>snapshots</id>

                  <uniqueVersion>false</uniqueVersion>

                  <name>Company Snapshots</name>           <url>http://localhost:8081/nexus/content/repositories/snapshots</url>

            </snapshotRepository>

      </distributionManagement>

...

</project> 

Settings.xml:

</settings>

...

<servers>

            <server>

                  <id>snapshots</id>

                  <username>deploy</username>

                  <password>deploypwd</password>

            </server>

            <server>

                  <id>releases</id>

                  <username>deploy</username>

                  <password>deploypwd</password>

            </server>

      </servers>

...

</settings>

NB: to prepare your release, and create a new tag on the source code repository:
mvn release: prepare -Dresume = false (alternatively mvn release: clean release: prepare) and to deploy the new tag in the staging repository: mvn release:perform

Continuous delivery:

I invite you to read this interesting book: http://continuousdelivery.com/2010/02/continuous-delivery/

Enjoy !! :-)