Skip to content

Commit

Permalink
Merge pull request #15 from OSGP/feature/FDP-1897-no-state
Browse files Browse the repository at this point in the history 
FDP-1897: Remove state from MessageSigner service
  • Loading branch information
@sanderv
sanderv authored Feb 26, 2024
2 parents 739be13 + fd1614b commit eca1e5f
Showing 1 changed file with 30 additions and 56 deletions.
86 changes: 30 additions & 56 deletions ...-message-signing/src/main/kotlin/com/gxf/utilities/kafka/message/signing/MessageSigner.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,23 +31,20 @@ class MessageSigner(properties: MessageSigningProperties) {
private val stripAvroHeader: Boolean = properties.stripAvroHeader

private val signatureAlgorithm: String = properties.signatureAlgorithm
private val signatureProvider: String? = determineProvider(properties)
private val signatureProvider: String? = properties.signatureProvider
private val keyAlgorithm: String = properties.keyAlgorithm

private var signingKey: PrivateKey? = readPrivateKey(properties.privateKeyFile)
private var verificationKey: PublicKey? = readPublicKey(keyAlgorithm, properties.publicKeyFile)

private val signingSignature: Signature? = signatureInstance(signatureAlgorithm, signatureProvider, signingKey)
private val verificationSignature: Signature? = signatureInstance(signatureAlgorithm, signatureProvider, verificationKey)

init {
if (properties.signingEnabled) {
require(!(signingKey == null && verificationKey == null)) { "A signing key (PrivateKey) or verification key (PublicKey) must be provided" }
}
}

fun canSignMessages(): Boolean {
return this.signingEnabled && this.signingSignature != null
return this.signingEnabled && this.signingKey != null
}

/**
Expand Down Expand Up @@ -106,15 +103,14 @@ class MessageSigner(properties: MessageSigningProperties) {
val oldSignature = message.getSignature()
try {
message.setSignature(null)
synchronized(signingSignature!!) {
val messageBytes: ByteArray = if (this.stripAvroHeader) {
this.stripAvroHeader(this.toByteBuffer(message))
} else {
this.toByteBuffer(message)!!.array()
}
signingSignature.update(messageBytes)
return signingSignature.sign()
val messageBytes: ByteArray = if (this.stripAvroHeader) {
this.stripAvroHeader(this.toByteBuffer(message))
} else {
this.toByteBuffer(message)!!.array()
}
val signingSignature = signatureInstance(signatureAlgorithm, signatureProvider, signingKey!!)
signingSignature.update(messageBytes)
return signingSignature.sign()
} catch (e: SignatureException) {
throw UncheckedSecurityException("Unable to sign message", e)
} finally {
Expand All @@ -141,16 +137,15 @@ class MessageSigner(properties: MessageSigningProperties) {
val oldSignatureHeader = producerRecord.headers().lastHeader(RECORD_HEADER_KEY_SIGNATURE)
try {
producerRecord.headers().remove(RECORD_HEADER_KEY_SIGNATURE)
synchronized(signingSignature!!) {
val specificRecordBase = producerRecord.value()
val messageBytes: ByteArray = if (this.stripAvroHeader) {
this.stripAvroHeader(this.toByteBuffer(specificRecordBase))
} else {
this.toByteBuffer(specificRecordBase).array()
}
signingSignature.update(messageBytes)
return signingSignature.sign()
val specificRecordBase = producerRecord.value()
val messageBytes: ByteArray = if (this.stripAvroHeader) {
this.stripAvroHeader(this.toByteBuffer(specificRecordBase))
} else {
this.toByteBuffer(specificRecordBase).array()
}
val signingSignature = signatureInstance(signatureAlgorithm, signatureProvider, signingKey!!)
signingSignature.update(messageBytes)
return signingSignature.sign()
} catch (e: SignatureException) {
throw UncheckedSecurityException("Unable to sign message", e)
} finally {
Expand All @@ -161,7 +156,7 @@ class MessageSigner(properties: MessageSigningProperties) {
}

fun canVerifyMessageSignatures(): Boolean {
return this.signingEnabled && this.verificationSignature != null
return this.signingEnabled && this.verificationKey != null
}

/**
Expand All @@ -186,9 +181,7 @@ class MessageSigner(properties: MessageSigningProperties) {

try {
message.setSignature(null)
synchronized((verificationSignature)!!) {
return this.verifySignatureBytes(signatureBytes, this.toByteBuffer(message))
}
return this.verifySignatureBytes(signatureBytes, this.toByteBuffer(message))
} catch (e: SignatureException) {
throw UncheckedSecurityException("Unable to verify message signature", e)
} finally {
Expand Down Expand Up @@ -223,13 +216,11 @@ class MessageSigner(properties: MessageSigningProperties) {

try {
consumerRecord.headers().remove(RECORD_HEADER_KEY_SIGNATURE)
synchronized(verificationSignature!!) {
val specificRecordBase: SpecificRecordBase = consumerRecord.value()
return this.verifySignatureBytes(
signatureBytes,
this.toByteBuffer(specificRecordBase)
)
}
val specificRecordBase: SpecificRecordBase = consumerRecord.value()
return this.verifySignatureBytes(
signatureBytes,
this.toByteBuffer(specificRecordBase)
)
} catch (e: SignatureException) {
throw UncheckedSecurityException("Unable to verify message signature", e)
}
Expand All @@ -242,7 +233,8 @@ class MessageSigner(properties: MessageSigningProperties) {
} else {
messageByteBuffer!!.array()
}
verificationSignature!!.update(messageBytes)
val verificationSignature = signatureInstance(signatureAlgorithm, signatureProvider, verificationKey!!)
verificationSignature.update(messageBytes)
return verificationSignature.verify(signatureBytes)
}

Expand Down Expand Up @@ -277,16 +269,6 @@ class MessageSigner(properties: MessageSigningProperties) {
}
}

private fun determineProvider(properties: MessageSigningProperties): String? {
return when {
properties.signatureProvider != null -> properties.signatureProvider
this.signingSignature != null -> signingSignature.getProvider()?.name
this.verificationSignature != null -> verificationSignature.getProvider()?.name
// Should not happen, set to null and ignore.
else -> null
}
}

override fun toString(): String {
return String.format(
"MessageSigner[algorithm=\"%s\"-\"%s\", provider=\"%s\", sign=%b, verify=%b]",
Expand Down Expand Up @@ -314,12 +296,8 @@ class MessageSigner(properties: MessageSigningProperties) {
private fun signatureInstance(
signatureAlgorithm: String,
signatureProvider: String?,
signingKey: PrivateKey?
): Signature? {
if (signingKey == null) {
return null
}

signingKey: PrivateKey
): Signature {
val signature = signatureInstance(signatureAlgorithm, signatureProvider)
try {
signature.initSign(signingKey)
Expand All @@ -333,12 +311,8 @@ class MessageSigner(properties: MessageSigningProperties) {
private fun signatureInstance(
signatureAlgorithm: String,
signatureProvider: String?,
verificationKey: PublicKey?
): Signature? {
if (verificationKey == null) {
return null
}

verificationKey: PublicKey
): Signature {
val signature = signatureInstance(signatureAlgorithm, signatureProvider)
try {
signature.initVerify(verificationKey)
Expand Down

0 comments on commit eca1e5f

Please sign in to comment.