Initial commit

This commit is contained in:
Paul Schaub 2018-06-01 15:55:00 +02:00
commit 7d3788df54
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
9 changed files with 585 additions and 0 deletions

36
.gitignore vendored Normal file
View file

@ -0,0 +1,36 @@
# IntelliJ
.idea
.idea/*
*.iml
.idea/workspace.xml
# Mac OS X
.DS_Store
.classpath
.project
.settings
.gradle
gradle.properties
build/
core/build/
debug/build/
experimental/build/
extensions/build/
gradle/wrapper/gradle-wrapper.properties
oxstore/
bin/
core/bin
debug/bin
experimental/bin
extensions/bin
target/
.metadata
cmd.ipr
cmd.iws

45
README.md Normal file
View file

@ -0,0 +1,45 @@
# OpenPGP for XMPP Instant Messaging Demo Client
This command line XMPP client is part of my [Summer of Code 2018 project](https://vanitasvitae.github.io/GSOC2018/).
It demonstrates the capabilities of the OX-IM-API I wrote.
### OpenPGP for XMPP: Instant Messaging
The client implements [XEP-0373](https://xmpp.org/extensions/xep-0373.html) and [XEP-0374](https://xmpp.org/extensions/xep-0374.html) in order to encrypt messages using [OpenPGP](https://tools.ietf.org/html/rfc4880).
### Installation
In order to install the client, you have to follow these steps:
```
# create a working directory
mkdir ox
cd ox
# Prepare Smack
git clone https://github.com/vanitasvitae/Smack.git
cd Smack
git checkout c9c22068a3e07d44c88225f04bbf47189caae3f9
gradle install
# Prepare pgpainless
cd ..
git clone https://github.com/vanitasvitae/pgpainless.git
cd pgpainless
git checkout 9af42c7231a6837694461e087ef5b3c51e451ef5
gradle install
# prepare the client
cd ..
git clone https://github.com/vanitasvitae/oxclient.git
cd oxclient
gradle build
```
### Running the client
The last command above generates the executable `build/libs/cmd-1.0-SNAPSHOT.jar`.
That can be executed using
```
java -jar build/libs/cmd-1.0-SNAPSHOT.jar
```

28
build.gradle Normal file
View file

@ -0,0 +1,28 @@
group 'de.vanitasvitae.oxclient'
version '1.0-SNAPSHOT'
apply plugin: 'java'
sourceCompatibility = 1.8
repositories {
mavenLocal()
mavenCentral()
maven {
url 'https://oss.sonatype.org/content/repositories/snapshots'
}
}
ext {
smackVersion="4.4.0-alpha1-SNAPSHOT"
}
dependencies {
testCompile "org.igniterealtime.smack:smack-core:$smackVersion"
compile "org.igniterealtime.smack:smack-java7:$smackVersion"
compile "org.igniterealtime.smack:smack-resolver-dnsjava:$smackVersion"
compile "org.igniterealtime.smack:smack-tcp:$smackVersion"
compile "org.igniterealtime.smack:smack-openpgp:$smackVersion"
compile "org.igniterealtime.smack:smack-openpgp-bouncycastle:$smackVersion"
compile "org.igniterealtime.smack:smack-experimental:$smackVersion"
}

BIN
gradle/wrapper/gradle-wrapper.jar vendored Normal file

Binary file not shown.

172
gradlew vendored Executable file
View file

@ -0,0 +1,172 @@
#!/usr/bin/env sh
##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS=""
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
warn () {
echo "$*"
}
die () {
echo
echo "$*"
echo
exit 1
}
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin, switch paths to Windows format before running java
if $cygwin ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi
# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")
# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi
exec "$JAVACMD" "$@"

84
gradlew.bat vendored Normal file
View file

@ -0,0 +1,84 @@
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS=
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto init
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto init
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:init
@rem Get command-line arguments, handling Windows variants
if not "%OS%" == "Windows_NT" goto win9xME_args
:win9xME_args
@rem Slurp the command line arguments.
set CMD_LINE_ARGS=
set _SKIP=2
:win9xME_args_slurp
if "x%~1" == "x" goto execute
set CMD_LINE_ARGS=%*
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

2
settings.gradle Normal file
View file

@ -0,0 +1,2 @@
rootProject.name = 'cmd'

View file

@ -0,0 +1,194 @@
package de.vanitasvitae.oxclient;
import java.io.File;
import java.util.Scanner;
import java.util.Set;
import org.jivesoftware.smack.packet.Message;
import org.jivesoftware.smack.packet.Presence;
import org.jivesoftware.smack.roster.Roster;
import org.jivesoftware.smack.roster.RosterEntry;
import org.jivesoftware.smack.tcp.XMPPTCPConnection;
import org.jivesoftware.smackx.ox.OXInstantMessagingManager;
import org.jivesoftware.smackx.ox.OpenPgpManager;
import org.jivesoftware.smackx.ox.OpenPgpV4Fingerprint;
import org.jivesoftware.smackx.ox.PubSubDelegate;
import org.jivesoftware.smackx.ox.bouncycastle.BCOpenPgpProvider;
import org.jivesoftware.smackx.ox.bouncycastle.FileBasedBcOpenPgpStore;
import org.jivesoftware.smackx.ox.callback.SecretKeyBackupSelectionCallback;
import org.jivesoftware.smackx.ox.callback.SecretKeyRestoreSelectionCallback;
import name.neuhalfen.projects.crypto.bouncycastle.openpgp.BouncyGPG;
import name.neuhalfen.projects.crypto.bouncycastle.openpgp.keys.callbacks.KeyringConfigCallbacks;
import org.jxmpp.jid.BareJid;
import org.jxmpp.jid.EntityBareJid;
import org.jxmpp.jid.impl.JidCreate;
import org.jxmpp.stringprep.XmppStringprepException;
public class Client {
private final XMPPTCPConnection connection;
public Client(String username, String password) throws XmppStringprepException {
this.connection = new XMPPTCPConnection(username, password);
}
public void start() throws Exception {
BouncyGPG.registerProvider();
connection.connect().login();
Scanner scanner = new Scanner(System.in);
BareJid user = connection.getUser().asBareJid();
OpenPgpManager manager = OpenPgpManager.getInstanceFor(connection);
BCOpenPgpProvider provider = new BCOpenPgpProvider(user);
FileBasedBcOpenPgpStore store = new FileBasedBcOpenPgpStore(new File("oxstore"), user,
KeyringConfigCallbacks.withUnprotectedKeys());
provider.setStore(store);
manager.setOpenPgpProvider(provider);
OXInstantMessagingManager instantManager = OXInstantMessagingManager.getInstanceFor(connection);
instantManager.addOpenPgpEncryptedMessageListener((from, originalMessage, decryptedPayload, chat) -> System.out.println("Received OX chat message from " + from + ":\n" +
decryptedPayload.<Message.Body>getExtension(
Message.Body.ELEMENT, Message.Body.NAMESPACE)
.getMessage()));
instantManager.announceSupportForOxInstantMessaging();
Roster.getInstanceFor(connection).setSubscriptionMode(Roster.SubscriptionMode.accept_all);
System.out.println("Client logged in successfully. To get a list of available commands, enter \"help\".");
BareJid jid;
outerloop: while (true) {
String cmd = scanner.nextLine();
switch (cmd) {
case "publishKeys":
if (provider.primaryOpenPgpKeyPairFingerprint() == null) {
System.out.println("No private key available. Try to generate one using \"generateKey\"");
break;
}
manager.announceSupportAndPublish();
System.out.println("Keys published successfully.");
break;
case "listContacts":
for (RosterEntry e : Roster.getInstanceFor(connection).getEntries()) {
System.out.println(e.getJid() +
" canSeeMe: " + e.canSeeMyPresence() +
" canSeeThem: " + e.canSeeHisPresence() +
" OX-support: " + instantManager.contactSupportsOxInstantMessaging(e.getJid()));
}
break;
case "addContact":
System.out.println("Enter a JID:");
jid = JidCreate.bareFrom(scanner.nextLine());
System.out.println("Enter a Nickname:");
String nick = scanner.nextLine();
Roster.getInstanceFor(connection).createEntry(jid, nick, null);
break;
case "exit":
case "quit":
connection.disconnect(new Presence(Presence.Type.unavailable));
System.out.println("Bye Bye!");
break outerloop;
case "generateKey":
provider.createOpenPgpKeyPair();
System.out.println("Key generated.");
System.out.println(manager.getOurFingerprint());
break;
case "deleteMetadata":
PubSubDelegate.deletePubkeysListNode(connection);
System.out.println("Metadata deleted.");
break;
case "fingerprint":
System.out.println("Enter a JID (leave empty to display our fingerprint):");
String l = scanner.nextLine();
if (l.isEmpty()) {
System.out.println(provider.primaryOpenPgpKeyPairFingerprint());
} else {
jid = JidCreate.bareFrom(l);
for (OpenPgpV4Fingerprint f : provider.availableOpenPgpPublicKeysFingerprints(jid)) {
System.out.println(f);
}
}
break;
case "encrypt":
if (provider.primaryOpenPgpKeyPairFingerprint() == null) {
System.out.println("No private key available. Try to generate one using \"generateKey\"");
break;
}
System.out.println("Enter a JID:");
jid = JidCreate.entityBareFrom(scanner.nextLine());
System.out.println("Enter a message:");
String message = scanner.nextLine();
instantManager.chatWith(((EntityBareJid) jid).asEntityBareJid())
.send(new Message(jid), message);
System.out.println("Message sent.");
break;
case "backup":
if (provider.primaryOpenPgpKeyPairFingerprint() == null) {
System.out.println("No private key available. Try to generate one using \"generateKey\"");
break;
}
manager.backupSecretKeyToServer(
System.out::println,
availableSecretKeys -> availableSecretKeys);
break;
case "restore":
manager.restoreSecretKeyServerBackup(
() -> {
System.out.println("Enter Backup Code:");
return scanner.nextLine();
},
availableSecretKeys -> {
if (availableSecretKeys.size() > 1) {
System.out.println("Select key to restore:");
int i = 1;
for (OpenPgpV4Fingerprint f : availableSecretKeys) {
System.out.println(i++ + f.toString());
}
int s = scanner.nextInt();
i = 1;
for (OpenPgpV4Fingerprint f : availableSecretKeys) {
if (i++ == s) {
return f;
}
}
System.out.println("Invalid selection.");
return null;
}
if (availableSecretKeys.size() == 1) {
return availableSecretKeys.iterator().next();
}
System.out.println("Backup does not contain a key.");
return null;
});
System.out.println(manager.getOurFingerprint());
break;
case "help":
System.out.println("Available commands:");
System.out.println("\tfingerprint - Display OpenPGP fingerprints of users.");
System.out.println("\tlistContacts - List the roster of contacts.");
System.out.println("\taddContact - Add a user to the roster.");
System.out.println("\tencrypt - Send an encrypted message to a recipient.");
System.out.println("\tgenerateKey - Generate and use a fresh OpenPGP key.");
System.out.println("\tpublishKeys - Publish public keys.");
System.out.println("\tbackup - Put a backup of our secret keys into a private pubsub node.");
System.out.println("\trestore - Restore a secret key backup.");
System.out.println("\texit/quit - Exit the client.");
break;
}
}
}
}

View file

@ -0,0 +1,24 @@
package de.vanitasvitae.oxclient;
import java.util.Scanner;
import org.jivesoftware.smack.SmackConfiguration;
public class Main {
public static void main(String[] args) throws Exception {
SmackConfiguration.DEBUG = false;
SmackConfiguration.setDefaultReplyTimeout(10 * 1000);
String username, password;
Scanner scanner = new Scanner(System.in);
System.out.println("Please enter your JID:");
username = scanner.nextLine();
System.out.println("Please enter your password:");
password = scanner.nextLine();
Client client = new Client(username, password);
client.start();
}
}