mirror of
https://codeberg.org/Mercury-IM/Smack
synced 2025-12-08 14:11:07 +01:00
Add Use of Cryptographic Hashfunctions (XEP-300)
Also move bouncycastle dep from smack-omemo to smack-experimental.
This commit is contained in:
parent
f5ef42ec56
commit
28f3130cf9
GPG key ID:
62BEE9264BF17311
10 changed files with 770 additions and 1 deletions
|
|
@ -0,0 +1,317 @@
|
|||
/**
|
||||
*
|
||||
* Copyright © 2017 Paul Schaub
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.jivesoftware.smackx.hashes;
|
||||
|
||||
import org.bouncycastle.jce.provider.BouncyCastleProvider;
|
||||
import org.jivesoftware.smack.Manager;
|
||||
import org.jivesoftware.smack.XMPPConnection;
|
||||
import org.jivesoftware.smackx.disco.ServiceDiscoveryManager;
|
||||
import org.jivesoftware.smackx.hashes.element.HashElement;
|
||||
|
||||
import java.math.BigInteger;
|
||||
import java.security.MessageDigest;
|
||||
import java.security.NoSuchAlgorithmException;
|
||||
import java.security.NoSuchProviderException;
|
||||
import java.security.Security;
|
||||
import java.util.Arrays;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.WeakHashMap;
|
||||
|
||||
import static org.jivesoftware.smackx.hashes.HashManager.ALGORITHM.BLAKE2B160;
|
||||
import static org.jivesoftware.smackx.hashes.HashManager.ALGORITHM.BLAKE2B256;
|
||||
import static org.jivesoftware.smackx.hashes.HashManager.ALGORITHM.BLAKE2B384;
|
||||
import static org.jivesoftware.smackx.hashes.HashManager.ALGORITHM.BLAKE2B512;
|
||||
import static org.jivesoftware.smackx.hashes.HashManager.ALGORITHM.MD5;
|
||||
import static org.jivesoftware.smackx.hashes.HashManager.ALGORITHM.SHA3_224;
|
||||
import static org.jivesoftware.smackx.hashes.HashManager.ALGORITHM.SHA3_256;
|
||||
import static org.jivesoftware.smackx.hashes.HashManager.ALGORITHM.SHA3_384;
|
||||
import static org.jivesoftware.smackx.hashes.HashManager.ALGORITHM.SHA3_512;
|
||||
import static org.jivesoftware.smackx.hashes.HashManager.ALGORITHM.SHA_1;
|
||||
import static org.jivesoftware.smackx.hashes.HashManager.ALGORITHM.SHA_224;
|
||||
import static org.jivesoftware.smackx.hashes.HashManager.ALGORITHM.SHA_256;
|
||||
import static org.jivesoftware.smackx.hashes.HashManager.ALGORITHM.SHA_384;
|
||||
import static org.jivesoftware.smackx.hashes.HashManager.ALGORITHM.SHA_512;
|
||||
|
||||
/**
|
||||
* Manager that can be used to determine support for hash functions.
|
||||
*/
|
||||
public final class HashManager extends Manager {
|
||||
|
||||
static {
|
||||
Security.addProvider(new BouncyCastleProvider());
|
||||
}
|
||||
public static final String PROVIDER = "BC";
|
||||
|
||||
public static final String PREFIX_NS_ALGO = "urn:xmpp:hash-function-text-names:";
|
||||
|
||||
public enum NAMESPACE {
|
||||
V1 ("urn:xmpp:hashes:1"),
|
||||
V2 ("urn:xmpp:hashes:2");
|
||||
|
||||
final String name;
|
||||
|
||||
NAMESPACE(String name) {
|
||||
this.name = name;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return this.name;
|
||||
}
|
||||
}
|
||||
|
||||
public static final List<ALGORITHM> RECOMMENDED = Collections.unmodifiableList(Arrays.asList(
|
||||
SHA_256, SHA_384, SHA_512,
|
||||
SHA3_256, SHA3_384, SHA3_512,
|
||||
BLAKE2B256, BLAKE2B384, BLAKE2B512));
|
||||
|
||||
private static final WeakHashMap<XMPPConnection, HashManager> INSTANCES = new WeakHashMap<>();
|
||||
|
||||
/**
|
||||
* Constructor of the HashManager.
|
||||
* By default the Manager announces support for XEP-0300, as well as for the RECOMMENDED set of hash algorithms.
|
||||
* Those contain SHA256, SHA384, SHA512, SHA3-256, SHA3-384, SHA3-512, BLAKE2B256, BLAKE2B384 and BLAKE2B512.
|
||||
* Those algorithms got recommended here: https://xmpp.org/extensions/xep-0300.html#recommendations
|
||||
* @param connection connection
|
||||
*/
|
||||
private HashManager(XMPPConnection connection) {
|
||||
super(connection);
|
||||
ServiceDiscoveryManager sdm = ServiceDiscoveryManager.getInstanceFor(connection);
|
||||
sdm.addFeature(NAMESPACE.V2.toString());
|
||||
addAlgorithmsToFeatures(RECOMMENDED);
|
||||
}
|
||||
|
||||
public static HashElement calculateHashElement(ALGORITHM algorithm, byte[] data) {
|
||||
return new HashElement(algorithm, hash(algorithm, data));
|
||||
}
|
||||
|
||||
public static HashElement assembleHashElement(ALGORITHM algorithm, byte[] hash) {
|
||||
return new HashElement(algorithm, hash);
|
||||
}
|
||||
|
||||
/**
|
||||
* Announce support for the given list of algorithms.
|
||||
* @param algorithms
|
||||
*/
|
||||
public void addAlgorithmsToFeatures(List<ALGORITHM> algorithms) {
|
||||
ServiceDiscoveryManager sdm = ServiceDiscoveryManager.getInstanceFor(connection());
|
||||
for (ALGORITHM algo : algorithms) {
|
||||
sdm.addFeature(asFeature(algo));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an instance of the HashManager for the given connection.
|
||||
* @param connection
|
||||
* @return
|
||||
*/
|
||||
public HashManager getInstanceFor(XMPPConnection connection) {
|
||||
HashManager hashManager = INSTANCES.get(connection);
|
||||
if (hashManager == null) {
|
||||
hashManager = new HashManager(connection);
|
||||
INSTANCES.put(connection, hashManager);
|
||||
}
|
||||
return hashManager;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the feature name of the given algorithm.
|
||||
* @param algorithm eg. 'SHA_1'
|
||||
* @return feature name (eg. urn:xmpp:hash-function-text-names:sha-1')
|
||||
*/
|
||||
public static String asFeature(ALGORITHM algorithm) {
|
||||
return PREFIX_NS_ALGO + algorithm.toString();
|
||||
}
|
||||
|
||||
public enum ALGORITHM { // RECOMMENDATION:
|
||||
MD5 ("md5"), // MUST NOT use this
|
||||
SHA_1 ("sha-1"), // SHOULD NOT use this
|
||||
SHA_224 ("sha-224"),
|
||||
SHA_256 ("sha-256"), // MUST use this
|
||||
SHA_384 ("sha-384"),
|
||||
SHA_512 ("sha-512"), // SHOULD use this
|
||||
SHA3_224 ("sha3-224"),
|
||||
SHA3_256 ("sha3-256"), // MUST use this
|
||||
SHA3_384 ("sha3-384"),
|
||||
SHA3_512 ("sha3-512"), // SHOULD use this
|
||||
BLAKE2B160("id-blake2b160"),
|
||||
BLAKE2B256("id-blake2b256"), // MUST use this
|
||||
BLAKE2B384("id-blake2b384"),
|
||||
BLAKE2B512("id-blake2b512"); // SHOULD use this
|
||||
|
||||
private final String name;
|
||||
|
||||
ALGORITHM(String name) {
|
||||
this.name = name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the name of the algorithm as it is used in the XEP.
|
||||
* @return name.
|
||||
*/
|
||||
@Override
|
||||
public String toString() {
|
||||
return this.name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Compensational method for static 'valueOf' function.
|
||||
* @param s
|
||||
* @return
|
||||
*/
|
||||
public static ALGORITHM valueOfName(String s) {
|
||||
for (ALGORITHM a : ALGORITHM.values()) {
|
||||
if (a.toString().equals(s)) {
|
||||
return a;
|
||||
}
|
||||
}
|
||||
throw new IllegalArgumentException("No ALGORITHM enum with this name (" + s + ") found.");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculate the hash sum of data using algorithm.
|
||||
* @param algorithm
|
||||
* @param data
|
||||
* @return
|
||||
*/
|
||||
public static byte[] hash(ALGORITHM algorithm, byte[] data) {
|
||||
return getMessageDigest(algorithm).digest(data);
|
||||
}
|
||||
|
||||
public static MessageDigest getMessageDigest(ALGORITHM algorithm) {
|
||||
MessageDigest md;
|
||||
try {
|
||||
switch (algorithm) {
|
||||
case MD5:
|
||||
md = MessageDigest.getInstance("MD5", PROVIDER);
|
||||
break;
|
||||
case SHA_1:
|
||||
md = MessageDigest.getInstance("SHA-1", PROVIDER);
|
||||
break;
|
||||
case SHA_224:
|
||||
md = MessageDigest.getInstance("SHA-224", PROVIDER);
|
||||
break;
|
||||
case SHA_256:
|
||||
md = MessageDigest.getInstance("SHA-256", PROVIDER);
|
||||
break;
|
||||
case SHA_384:
|
||||
md = MessageDigest.getInstance("SHA-384", PROVIDER);
|
||||
break;
|
||||
case SHA_512:
|
||||
md = MessageDigest.getInstance("SHA-512", PROVIDER);
|
||||
break;
|
||||
case SHA3_224:
|
||||
md = MessageDigest.getInstance("SHA3-224", PROVIDER);
|
||||
break;
|
||||
case SHA3_256:
|
||||
md = MessageDigest.getInstance("SHA3-256", PROVIDER);
|
||||
break;
|
||||
case SHA3_384:
|
||||
md = MessageDigest.getInstance("SHA3-384", PROVIDER);
|
||||
break;
|
||||
case SHA3_512:
|
||||
md = MessageDigest.getInstance("SHA3-512", PROVIDER);
|
||||
break;
|
||||
case BLAKE2B160:
|
||||
md = MessageDigest.getInstance("BLAKE2b-160", PROVIDER);
|
||||
break;
|
||||
case BLAKE2B256:
|
||||
md = MessageDigest.getInstance("BLAKE2b-256", PROVIDER);
|
||||
break;
|
||||
case BLAKE2B384:
|
||||
md = MessageDigest.getInstance("BLAKE2b-384", PROVIDER);
|
||||
break;
|
||||
case BLAKE2B512:
|
||||
md = MessageDigest.getInstance("BLAKE2b-512", PROVIDER);
|
||||
break;
|
||||
default:
|
||||
throw new AssertionError("Invalid enum value.");
|
||||
}
|
||||
return md;
|
||||
} catch (NoSuchAlgorithmException | NoSuchProviderException e) {
|
||||
throw new AssertionError(e);
|
||||
}
|
||||
}
|
||||
|
||||
public static byte[] md5(byte[] data) {
|
||||
return getMessageDigest(MD5).digest(data);
|
||||
}
|
||||
|
||||
public static byte[] sha_1(byte[] data) {
|
||||
return getMessageDigest(SHA_1).digest(data);
|
||||
}
|
||||
|
||||
public static byte[] sha_224(byte[] data) {
|
||||
return getMessageDigest(SHA_224).digest(data);
|
||||
}
|
||||
|
||||
public static byte[] sha_256(byte[] data) {
|
||||
return getMessageDigest(SHA_256).digest(data);
|
||||
}
|
||||
|
||||
public static byte[] sha_384(byte[] data) {
|
||||
return getMessageDigest(SHA_384).digest(data);
|
||||
}
|
||||
|
||||
public static byte[] sha_512(byte[] data) {
|
||||
return getMessageDigest(SHA_512).digest(data);
|
||||
}
|
||||
|
||||
public static byte[] sha3_224(byte[] data) {
|
||||
return getMessageDigest(SHA3_224).digest(data);
|
||||
}
|
||||
|
||||
public static byte[] sha3_256(byte[] data) {
|
||||
return getMessageDigest(SHA3_256).digest(data);
|
||||
}
|
||||
|
||||
public static byte[] sha3_384(byte[] data) {
|
||||
return getMessageDigest(SHA3_384).digest(data);
|
||||
}
|
||||
|
||||
public static byte[] sha3_512(byte[] data) {
|
||||
return getMessageDigest(SHA3_512).digest(data);
|
||||
}
|
||||
|
||||
public static byte[] blake2b160(byte[] data) {
|
||||
return getMessageDigest(BLAKE2B160).digest(data);
|
||||
}
|
||||
|
||||
public static byte[] blake2b256(byte[] data) {
|
||||
return getMessageDigest(BLAKE2B256).digest(data);
|
||||
}
|
||||
|
||||
public static byte[] blake2b384(byte[] data) {
|
||||
return getMessageDigest(BLAKE2B384).digest(data);
|
||||
}
|
||||
|
||||
public static byte[] blake2b512(byte[] data) {
|
||||
return getMessageDigest(BLAKE2B512).digest(data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode a byte array in HEX.
|
||||
* @param hash
|
||||
* @return
|
||||
*/
|
||||
public static String hex(byte[] hash) {
|
||||
return new BigInteger(1, hash).toString(16);
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,119 @@
|
|||
/**
|
||||
*
|
||||
* Copyright © 2017 Paul Schaub
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.jivesoftware.smackx.hashes.element;
|
||||
|
||||
|
||||
import org.jivesoftware.smack.packet.ExtensionElement;
|
||||
import org.jivesoftware.smack.util.XmlStringBuilder;
|
||||
import org.jivesoftware.smack.util.stringencoder.Base64;
|
||||
import org.jivesoftware.smackx.hashes.HashManager;
|
||||
|
||||
import static org.jivesoftware.smack.util.Objects.requireNonNull;
|
||||
|
||||
/**
|
||||
* Represent a hash element.
|
||||
*
|
||||
* @author Paul Schaub
|
||||
*/
|
||||
public class HashElement implements ExtensionElement {
|
||||
|
||||
public static final String ELEMENT = "hash";
|
||||
public static final String ATTR_ALGO = "algo";
|
||||
|
||||
private final HashManager.ALGORITHM algorithm;
|
||||
private final byte[] hash;
|
||||
private final String hashB64;
|
||||
|
||||
/**
|
||||
* Create a HashElement from pre-calculated values.
|
||||
* @param algorithm The algorithm which was used.
|
||||
* @param hash the checksum as byte array.
|
||||
*/
|
||||
public HashElement(HashManager.ALGORITHM algorithm, byte[] hash) {
|
||||
this.algorithm = requireNonNull(algorithm);
|
||||
this.hash = requireNonNull(hash);
|
||||
hashB64 = Base64.encodeToString(hash);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a HashElement from pre-calculated values.
|
||||
* @param algorithm the algorithm that was used.
|
||||
* @param hashB64 the checksum in base 64.
|
||||
*/
|
||||
public HashElement(HashManager.ALGORITHM algorithm, String hashB64) {
|
||||
this.algorithm = algorithm;
|
||||
this.hash = Base64.decode(hashB64);
|
||||
this.hashB64 = hashB64;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the hash algorithm used in this HashElement.
|
||||
* @return algorithm
|
||||
*/
|
||||
public HashManager.ALGORITHM getAlgorithm() {
|
||||
return algorithm;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the checksum as a byte array.
|
||||
* @return
|
||||
*/
|
||||
public byte[] getHash() {
|
||||
return hash;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the checksum as a base16 (hex) string.
|
||||
* @return
|
||||
*/
|
||||
public String getHashB64() {
|
||||
return hashB64;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getElementName() {
|
||||
return ELEMENT;
|
||||
}
|
||||
|
||||
@Override
|
||||
public CharSequence toXML() {
|
||||
XmlStringBuilder sb = new XmlStringBuilder(this);
|
||||
sb.attribute(ATTR_ALGO, algorithm.toString());
|
||||
sb.rightAngleBracket();
|
||||
sb.append(hashB64);
|
||||
sb.closeElement(this);
|
||||
return sb;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getNamespace() {
|
||||
return HashManager.NAMESPACE.V2.toString();
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(Object other) {
|
||||
if (other == null || !(other instanceof HashElement)) {
|
||||
return false;
|
||||
}
|
||||
return this.hashCode() == other.hashCode();
|
||||
}
|
||||
|
||||
@Override
|
||||
public int hashCode() {
|
||||
return toXML().toString().hashCode();
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
/**
|
||||
*
|
||||
* Copyright © 2017 Paul Schaub
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* XEP-0300 - Use of cryptographic hash functions.
|
||||
* Element classes.
|
||||
*/
|
||||
package org.jivesoftware.smackx.hashes.element;
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
/**
|
||||
*
|
||||
* Copyright © 2017 Paul Schaub
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* XEP-0300 - Use of cryptographic hash functions.
|
||||
*/
|
||||
package org.jivesoftware.smackx.hashes;
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
/**
|
||||
*
|
||||
* Copyright © 2017 Paul Schaub
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.jivesoftware.smackx.hashes.provider;
|
||||
|
||||
import org.jivesoftware.smack.provider.ExtensionElementProvider;
|
||||
import org.jivesoftware.smackx.hashes.HashManager;
|
||||
import org.jivesoftware.smackx.hashes.element.HashElement;
|
||||
import org.xmlpull.v1.XmlPullParser;
|
||||
|
||||
/**
|
||||
* Provider for HashElements.
|
||||
*/
|
||||
public class HashElementProvider extends ExtensionElementProvider<HashElement> {
|
||||
|
||||
@Override
|
||||
public HashElement parse(XmlPullParser parser, int initialDepth) throws Exception {
|
||||
String algo = parser.getAttributeValue(null, HashElement.ATTR_ALGO);
|
||||
String hashB64 = parser.nextText();
|
||||
return new HashElement(HashManager.ALGORITHM.valueOfName(algo), hashB64);
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
/**
|
||||
*
|
||||
* Copyright © 2017 Paul Schaub
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* XEP-0300 - Use of cryptographic hash functions.
|
||||
* Provider classes.
|
||||
*/
|
||||
package org.jivesoftware.smackx.hashes.provider;
|
||||
Loading…
Add table
Add a link
Reference in a new issue