PGP Encryption using Apache Camel

PGP (Pretty Good Privacy) Encryption is a widely used encryption mechanism which can be used to provide public key encryption.
There are many PGP encryption implementations using Java language which are quite complex. But Apache Camel Crypto component facilitates a very simple and convenient way of implementing PGP encryption.
Following code encrypts a given message using Apache Camel. org.apache.camel:camel-crypto is the only one library i have used here.
Most of the example in the internet shows the way which a file is used as the input for the encryption. But here i will show you how to directly encrypt a string (text message).
I'm using the public key in the public.gpg file to encrypt the message. The code is really straight foreword. Complete working project is available on GitHub and the URL is available at the bottom. All required key files are available there. You can clone the project and execute the program.

	package com.lakj.comspace.pgp.encryption;
	import java.io.File;
	import org.apache.camel.CamelContext;
	import org.apache.camel.ProducerTemplate;
	import org.apache.camel.builder.RouteBuilder;
	import org.apache.camel.converter.crypto.PGPDataFormat;
	import org.apache.camel.impl.DefaultCamelContext;
	/**
	* This app encrypt a given string text message and save it to a file.
	*
	* Created by Lak J Comspace on 8/9/2018.
	*
	*/
	public class App {
	public static void main(String[] args) throws Exception {
	final String mySecretMessage = "This is a top secret.";
	final String outputDirPath = "output";
	final String encryptedFileName = "mySecretFile.txt";
	File outputDir = new File(outputDirPath);
	outputDir.mkdirs(); // Create output directory if does not exist.
	System.out.println("Start encryption...");
	CamelContext camelContext = new DefaultCamelContext();
	camelContext.addRoutes(new RouteBuilder() {
	public void configure() throws Exception {
	PGPDataFormat format = new PGPDataFormat();
	format.setKeyFileName("file:keys/public.gpg");
	format.setKeyUserid("pgpencrypt@lakjcomspace.com");
	format.setArmored(true);
	from("direct:textContent").marshal(format)
	.to("file:" + outputDirPath + "/?fileName=" + encryptedFileName + "&charset=utf-8");
	}
	});
	camelContext.start();
	ProducerTemplate template = camelContext.createProducerTemplate();
	template.sendBody("direct:textContent", mySecretMessage);
	camelContext.stop();
	System.out.println("Encrypted file was saved.");
	}
	}

view raw App.java hosted with ❤ by GitHub

Following is the GitHub URL of complete project of this tutorial.
https://github.com/lakjcomspace/PGPEncryption

Docker MySQL Automatic Backups using Cron and Supervisor

mysqldump command allows you to create an SQL dump file of the database. By executing this command using a scheduler application like Windows Task Scheduler or Linux Cron you can create periodic backups automatically.
But when it comes to Docker MySQL image you cannot do this since base image does not contain any scheduler application. Even though we can install a scheduler utility like Cron on MySQL image, it does not do what we want since the MySQL container executes only the DB application at the container startup. It does not trigger the executable related to the scheduler application.
Here is my solution to the above problem. Using 'Supervisor' application to execute both MySQL and Cron. Supervisor is a process monitoring and controlling application for UNIX-like operating systems.

Following is the step by step guide to the solution. All these steps are instructions in the Dockerfile of the final output image. You don't want to do these things manually except copying the contents of the files. My Dockerfile will do the job. I'm listing these thing here just for your clarification.

1. Use MySQL docker image as the base image.
2. Install Cron on base image.
3. Install Supervisor on base image.
4. Prepare supervisord.conf Supervisor configuration file so that it starts MySQL DB and Contrab.
5. Add an entry to Crontab file so that it execute the dbdump.sh (Shell script which contains the mysqldump commands) everyday 11.45pm.

Following are the files which do all these things. Place all files inside a single folder and build image of the final container.

Every commands are straight forward where you can search and find more information. But touchrootcron in supervisord.conf file is something special. This is a trick to solve permission problem in Docker layered file system (Read for Docker layered file system and copy-on-write (CoW) strategy). root crontab file should be in the writable layer container layer.

	echo *** Backup Started on `date` ***
	timestamp=`date +%Y%m%d_%H%M`
	echo Creating backup file mydb.sql
	mysqldump -u root --password="mydbpwd" --routines mydb > /home/lakj-backups/mydb-$timestamp.sql
	echo Finished creating backup file.

view raw dbdump.sh hosted with ❤ by GitHub

	FROM mysql:5.7
	MAINTAINER Lak J Comspace
	# Installing Crontab
	RUN apt-get update && apt-get -y install -qq --force-yes cron
	#Installing Supervisor
	RUN apt-get update && apt-get -y install -qq --force-yes supervisor
	# Copying supervisord.conf file as the supervisor config
	COPY supervisord.conf /etc/supervisor/conf.d/supervisord.conf
	# Add shell script which contains mysqldump command and grant execution rights
	ADD dbdump.sh /opt/lakj/dbdump.sh
	RUN chmod +x /opt/lakj/dbdump.sh
	# Folling entries will be added to the Crontab file. PATH entry should be available to execute the commands.
	# Log entries related to the backup process will be added to lakj-backup.log file.
	RUN echo "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" >> lakjcron
	RUN echo "45 23 * * * sh /opt/lakj/dbdump.sh >> /home/lakj-backups/lakj-backup.log 2>&1\n" >> lakjcron
	RUN crontab lakjcron
	RUN rm lakjcron
	# DB dumps will be created in this folder.
	RUN mkdir /home/lakj-backups
	# Command to execute Supervisor
	CMD ["/usr/bin/supervisord", "-c", "/etc/supervisor/supervisord.conf"]

view raw Dockerfile hosted with ❤ by GitHub

	[supervisord]
	nodaemon=true
	[program:touchrootcron]
	priority = 1
	startsecs = 0
	autorestart = false
	command=touch /var/spool/cron/crontabs/root
	[program:mysql]
	priority = 2
	startsecs = 0
	autorestart = false
	command=service mysql start
	[program:cron]
	priority = 3
	startsecs = 0
	autorestart = false
	command=/etc/init.d/cron start

view raw supervisord.conf hosted with ❤ by GitHub

Don't hesitate to put a comment if you have any problem.

Excluding Property Files from Jar File : Maven Shade Plugin

Recently, i wanted to create a single Jar file with all the dependencies while the property files are excluded which are coming from the project. But the property files which are coming from dependencies should be preserved. My idea was to externalize property file so that someone can edit them without going inside Jar.

I tried several options.

1. Using Maven Resources Plugin 

Resources plugin perfectly work for the need. But it excludes the property files even when i run the project from the IDE (Eclipse/NetBeans)

2. Using Maven Assembly Plugin

I tried jar-with-dependencies pre-defined assembly descriptor with few customization. I used exclusion in unpackOptions. But it excludes property files which are coming from all the dependent modules.

Finally i found the working solution. It was Maven Shade Plugin

Following is example pom.xml. There you can see how i have used Maven Shade Plugin with property file excluding configurations. Shade plugin can be use to filter any file file from any dependent module conveniently.
Since i wanted an executable Jar i have specially used ManifestResourceTransformer in the Shade configurations.

	<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.lakj.comspace</groupId>
	<artifactId>shade-sample</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>
	<name>shade-sample</name>
	<properties>
	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	</properties>
	<dependencies>
	<dependency>
	<groupId>junit</groupId>
	<artifactId>junit</artifactId>
	<version>3.8.1</version>
	<scope>test</scope>
	</dependency>
	</dependencies>
	<build>
	<plugins>
	<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-shade-plugin</artifactId>
	<version>3.0.0</version>
	<executions>
	<execution>
	<goals>
	<goal>shade</goal>
	</goals>
	<configuration>
	<transformers>
	<transformer
	implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
	<mainClass>com.lakj.comspace.shadesample.App</mainClass>
	</transformer>
	</transformers>
	<filters>
	<filter>
	<artifact>com.lakj.comspace:shade-sample</artifact>
	<excludes>
	<exclude>*.properties</exclude>
	</excludes>
	</filter>
	</filters>
	</configuration>
	</execution>
	</executions>
	</plugin>
	</plugins>
	</build>
	</project>

view raw pom.xml hosted with ❤ by GitHub