Initial commit.

Author: Andy Lintner

.gitignore

@@ -10,3 +10,14 @@
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
+
+# Eclipse files
+.classpath
+.project
+.settings/
+
+# Maven target folder
+target/
+
+# Mac Files
+.DS_Store

README.md

@@ -0,0 +1,13 @@
+HAP-Java
+=========
+HAP-Java is a Java implementation of the Homekit Accessory Protocol.
+
+Using this library, you can create your own Homekit Accessory or Homekit Accessory Bridge.
+
+Because the MFi Specification is closed to individual developers, and this implementation was made without access to that specification, it may not be complete. iOS devices do recognize and are able to interact with accessories exposed via this library however.
+
+This library would not have been possible without the work done by [Tian Zhang](https://github.com/KhaosT) who did a lot of the hard work of figuring out how the protocol works in his NodeJS implementation.
+
+Usage
+=========
+Read the [Javadoc](http://beowulfe.github.io/HAP-Java/apidocs/) and check out the [Sample}(https://github.com/beowulfe/HAP-Java/tree/sample).

pom.xml

@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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.beowulfe.hap</groupId>
+	<artifactId>hap</artifactId>
+	<name>hap-java</name>
+	<description>Homekit Accessory Protocol for Java</description>
+	<version>0.0.1-SNAPSHOT</version>
+	<dependencies>
+
+		<dependency>
+			<groupId>org.slf4j</groupId>
+			<artifactId>slf4j-api</artifactId>
+			<version>1.7.10</version>
+		</dependency>
+
+		<dependency>
+			<groupId>io.netty</groupId>
+			<artifactId>netty-all</artifactId>
+			<version>4.0.24.Final</version>
+		</dependency>
+
+		<dependency>
+			<groupId>com.nimbusds</groupId>
+			<artifactId>srp6a</artifactId>
+			<version>1.5.2</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.bouncycastle</groupId>
+			<artifactId>bcprov-jdk15on</artifactId>
+			<version>1.51</version>
+		</dependency>
+
+		<dependency>
+			<groupId>net.i2p.crypto</groupId>
+			<artifactId>eddsa</artifactId>
+			<version>0.0.1-SNAPSHOT</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.zeromq</groupId>
+			<artifactId>curve25519-java</artifactId>
+			<version>0.1.0</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.slf4j</groupId>
+			<artifactId>slf4j-api</artifactId>
+			<version>1.7.10</version>
+		</dependency>
+
+		<dependency>
+			<groupId>javax.json</groupId>
+			<artifactId>javax.json-api</artifactId>
+			<version>1.0</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.glassfish</groupId>
+			<artifactId>javax.json</artifactId>
+			<version>1.0.4</version>
+		</dependency>
+
+		<dependency>
+			<groupId>javax.jmdns</groupId>
+			<artifactId>jmdns</artifactId>
+			<version>3.4.2-SNAPSHOT</version>
+		</dependency>
+
+	</dependencies>
+
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-compiler-plugin</artifactId>
+				<version>2.1</version>
+				<configuration>
+					<source>1.8</source>
+					<target>1.8</target>
+				</configuration>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<version>2.10.1</version>
+				<configuration>
+					<excludePackageNames>com.beowulfe.hap.impl</excludePackageNames>
+				</configuration>
+			</plugin>
+		</plugins>
+	</build>
+	<distributionManagement>
+		<site>
+			<id>website</id>
+			<url>https://github.com/beowulfe/hap-java</url>
+		</site>
+	</distributionManagement>
+</project>

src/main/java/com/beowulfe/hap/HomekitAccessory.java

@@ -0,0 +1,66 @@
+package com.beowulfe.hap;
+
+import java.util.Collection;
+
+/**
+ * Base interface for all Homekit Accessories. You can implement this interface directly, but most users will
+ * prefer to use the more full featured interfaces in {@link com.beowulfe.hap.accessories} which include a 
+ * default implementation of {@link #getServices()}. 
+ * 
+ * @author Andy Lintner
+ */
+public interface HomekitAccessory {
+	
+	/**
+	 * A unique identifier that must remain static across invocations to prevent errors with paired iOS devices. When used
+	 * as a child of a Bridge, this value must be greater than 1, as that ID is reserved for the Bridge itself.
+	 * 
+	 * @return the unique identifier.
+	 */
+	int getId();
+
+	/**
+	 * Returns a label to display in iOS.
+	 * 
+	 * @return the label.
+	 */
+	String getLabel();
+	
+	/**
+	 * Performs an operation that can be used to identify the accessory. This action can be performed without
+	 * pairing.
+	 */
+	void identify();
+
+	/**
+	 * Returns a serial number to display in iOS.
+	 * 
+	 * @return the serial number, or null.
+	 */
+	String getSerialNumber();
+
+	/**
+	 * Returns a model name to display in iOS.
+	 * 
+	 * @return the model name, or null.
+	 */
+	String getModel();
+
+	/**
+	 * Returns a manufacturer to display in iOS.
+	 * 
+	 * @return the manufacturer, or null.
+	 */
+	String getManufacturer();
+	
+	/**
+	 * The collection of Services this accessory supports. Services are the primary way to interact with the accessory via
+	 * Homekit. Besides the Services offered here, the accessory will automatically include the required information service.
+	 * 
+	 * This method will only be useful if you're implementing your own accessory type. For the standard accessories, use
+	 * the default implementation provided by the interfaces in {@link com.beowulfe.hap.accessories}.
+	 * 
+	 * @return the collection of services.
+	 */
+	Collection<Service> getServices();
+}

src/main/java/com/beowulfe/hap/HomekitAuthInfo.java

@@ -0,0 +1,72 @@
+package com.beowulfe.hap;
+
+import java.math.BigInteger;
+
+/**
+ * Authentication info that must be provided when constructing a new {@link HomekitServer}. You will need to implement
+ * this interface yourself to provide the necessary callbacks to a persistent storage mechanism. All values provided
+ * must be constant across invocations or the accessories will require re-pairing within iOS.
+ *
+ * @author Andy Lintner
+ */
+public interface HomekitAuthInfo {
+
+	/**
+	 * A pin code used for pairing the device. This pin will be required within iOS in order to complete pairing. The numbers
+	 * cannot be sequential and should not have a repeating pattern.
+	 * 
+	 * @return the pin code, in the form ###-##-###
+	 */
+	String getPin();
+	
+	/**
+	 * A unique MAC address to be advertised with the Homekit information. This does not have to be the MAC address of the 
+	 * network interface. You can generate this using {@link HomekitServer#generateMac()}.
+	 * 
+	 * @return the unique MAC address.
+	 */
+	String getMac();
+
+	/**
+	 * The Salt that will be used when hashing the pin code to send to the client. You should generate this using 
+	 * {@link HomekitServer#generateSalt()}.
+	 * 
+	 * @return the Salt.
+	 */
+	BigInteger getSalt();
+
+	/**
+	 * The private key used by the server during pairing and message encryption. You should generate this using
+	 * {@link HomekitServer#generateKey()}
+	 * 
+	 * @return the private key.
+	 */
+	byte[] getPrivateKey();
+	
+	/**
+	 * Called during the pairing process, you should store the user and public key in a manner that the public key can later
+	 * be retrieved using {@link #getUserPublicKey(String)}. This must be stored in a persistent store as pairing will
+	 * need to be reset if the information is lost.
+	 * 
+	 * @param username the iOS device's username. The value will not be meaningful to anything but iOS.
+	 * @param publicKey the iOS device's public key.
+	 */
+	void createUser(String username, byte[] publicKey);
+	
+	/**
+	 * Called when an iOS device needs to remove an existing pairing. Subsequent calls to {@link #getUserPublicKey(String)} for this
+	 * username return null.
+	 * 
+	 * @param username the username to delete from the persistent store.
+	 */
+	void removeUser(String username);
+
+	/**
+	 * Called when an already paired iOS device is re-connecting. The public key returned by this method will be compared
+	 * with the signature of the pair verification request to validate the device.
+	 * 
+	 * @param username the username of the iOS device to retrieve the public key for.
+	 * @return the previously stored public key for this user.
+	 */
+	byte[] getUserPublicKey(String username);
+}

src/main/java/com/beowulfe/hap/HomekitCharacteristicChangeCallback.java

@@ -0,0 +1,20 @@
+package com.beowulfe.hap;
+
+import com.beowulfe.hap.characteristics.EventableCharacteristic;
+
+/**
+ * A callback interface for notifying subscribers that a characteristic value has changed. 
+ * 
+ * {@link EventableCharacteristic}s can be subscribed to, and in doing so, are supplied an instance of this class. Implementors
+ * should call the {@link #changed()} method on the passed object when a subscribed characteristic changes.
+ *
+ * @author Andy Lintner
+ */
+@FunctionalInterface
+public interface HomekitCharacteristicChangeCallback {
+
+	/**
+	 * Call when the value of the characteristic that was subscribed to when this object was passed changes.
+	 */
+	public void changed();
+}