io.jenkins.plugins.huaweicloud.util

Class KeyFingerprinter

java.lang.Object

io.jenkins.plugins.huaweicloud.util.KeyFingerprinter

public final class KeyFingerprinter
extends Object

Utiility class for calculating and verifying SSH key fingerprints as defined by OpenSSH.

Method Summary

Modifier and Type	Method and Description
static String	md5Fingerprint(KeyPair keyPair) Prior to version 6.7 used an a hex encoded MD5 of the serialized public key as a fingerprint.
static String	sha256Fingerprint(KeyPair keyPair) Starting with version 6.8 OpenSSH used the base64 encoded SHA256 of the serialized public key as a fingerprint.
static boolean	verifyFingerprint(KeyPair keyPair, String fingerprint) Verifies that the given fingerprint matches the key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

md5Fingerprint

public static String md5Fingerprint(KeyPair keyPair)
                             throws org.bouncycastle.crypto.CryptoException

Prior to version 6.7 used an a hex encoded MD5 of the serialized public key as a fingerprint. This representation is still the one used by Triton and Manta as the key id.

Parameters:

keyPair - The KeyPair to calculate the fingerprint of

Returns:

The MD5 fingerprint (ex: 9f:0b:50:ae:e3:da:f6:eb:b5:71:9a:69:ee:79:9e:c2)

Throws:

org.bouncycastle.crypto.CryptoException

sha256Fingerprint

public static String sha256Fingerprint(KeyPair keyPair)
                                throws org.bouncycastle.crypto.CryptoException

Starting with version 6.8 OpenSSH used the base64 encoded SHA256 of the serialized public key as a fingerprint.

Parameters:

keyPair - The KeyPair to calculate the fingerprint of

Returns:

The SHA fingerprint (ex: LP3pWCEhg6rdmE05GhUKbZ7uOZqsJd0sK0AR3sVoMq4)

Throws:

org.bouncycastle.crypto.CryptoException

verifyFingerprint

public static boolean verifyFingerprint(KeyPair keyPair,
                                        String fingerprint)
                                 throws org.bouncycastle.crypto.CryptoException

Verifies that the given fingerprint matches the key. The fingerprint can be in any of the formats used by OpenSSH including the pre-6.7 format (9f:0b:50:ae:e3:da:f6:eb:b5:71:9a:69:ee:79:9e:c2), or 6.8 format prefixed with the algorithm name (MD5:9f:0b:50:ae:e3:da:f6:eb:b5:71:9a:69:ee:79:9e:c2 or SHA256:LP3pWCEhg6rdmE05GhUKbZ7uOZqsJd0sK0AR3sVoMq4).

Parameters:

keyPair - The KeyPair to calculate the fingerprint of

fingerprint - The expected fingerprint

Returns:

true of the fingerprint matches

Throws:

org.bouncycastle.crypto.CryptoException