PSForever/PSF-BotServer
1
0
Fork 0
mirror of https://github.com/2revoemag/PSF-BotServer.git synced 2026-07-14 07:55:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Bugfix: prevent CryptoPP from entering an infinite loop

Browse source 
See code comment for more details.
This commit is contained in:
Chord 2017-03-02 00:16:00 -05:00
parent 0ff5958651
commit e705576b37
1 changed files with 39 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

51
common/src/main/scala/net/psforever/crypto/CryptoInterface.scala
View file

@ -13,6 +13,20 @@ object CryptoInterface {
final val PSCRYPTO_VERSION_MAJOR = 1 final val PSCRYPTO_VERSION_MAJOR = 1
final val PSCRYPTO_VERSION_MINOR = 1 final val PSCRYPTO_VERSION_MINOR = 1
/**
NOTE: this is a single, global shared library for the entire server's crypto needs
Unfortunately, access to this object didn't used to be synchronized. I noticed that
tests for this module were hanging ("arrive at a shared secret" & "must fail to agree on
a secret..."). This heisenbug was responsible for failed Travis test runs and developer
issues as well. Using Windows minidumps, I tracked the issue to a single thread deep in
pscrypto.dll. It appeared to be executing an EB FE instruction (on Intel x86 this is
`jmp $-2` or jump to self), which is an infinite loop. The stack trace made little to no
sense and after banging my head on the wall for many hours, I assumed that something deep
in CryptoPP, the libgcc libraries, or MSVC++ was the cause (or myself). Now all access to
pscrypto functions that allocate and deallocate memory (DH_Start, RC5_Init) are synchronized.
This *appears* to have fixed the problem.
*/
final val psLib = new Library(libName) final val psLib = new Library(libName)
final val RC5_BLOCK_SIZE = 8 final val RC5_BLOCK_SIZE = 8
@ -48,7 +62,7 @@ object CryptoInterface {
if(!psLib.PSCrypto_Init(PSCRYPTO_VERSION_MAJOR, PSCRYPTO_VERSION_MINOR)[Boolean]) { if(!psLib.PSCrypto_Init(PSCRYPTO_VERSION_MAJOR, PSCRYPTO_VERSION_MINOR)[Boolean]) {
throw new IllegalArgumentException(s"Invalid PSCrypto library version ${libraryMajor.getValue}.${libraryMinor.getValue}. Expected " + throw new IllegalArgumentException(s"Invalid PSCrypto library version ${libraryMajor.getValue}.${libraryMinor.getValue}. Expected " +
s"${PSCRYPTO_VERSION_MAJOR}.${PSCRYPTO_VERSION_MINOR}") s"$PSCRYPTO_VERSION_MAJOR.$PSCRYPTO_VERSION_MINOR")
} }
} }
@ -121,7 +135,9 @@ object CryptoInterface {
if(started) if(started)
throw new IllegalStateException("DH state has already been started") throw new IllegalStateException("DH state has already been started")
dhHandle = psLib.DH_Start(modulus.toArray, generator.toArray, privateKey, publicKey)[Pointer] psLib.synchronized {
dhHandle = psLib.DH_Start(modulus.toArray, generator.toArray, privateKey, publicKey)[Pointer]
}
if(dhHandle == Pointer.NULL) if(dhHandle == Pointer.NULL)
throw new Exception("DH initialization failed!") throw new Exception("DH initialization failed!")
@ -138,7 +154,9 @@ object CryptoInterface {
if(started) if(started)
throw new IllegalStateException("DH state has already been started") throw new IllegalStateException("DH state has already been started")
dhHandle = psLib.DH_Start_Generate(privateKey, publicKey, p, g)[Pointer] psLib.synchronized {
dhHandle = psLib.DH_Start_Generate(privateKey, publicKey, p, g)[Pointer]
}
if(dhHandle == Pointer.NULL) if(dhHandle == Pointer.NULL)
throw new Exception("DH initialization failed!") throw new Exception("DH initialization failed!")
@ -185,7 +203,9 @@ object CryptoInterface {
override def close = { override def close = {
if(started) { if(started) {
// TODO: zero private key material // TODO: zero private key material
psLib.Free_DH(dhHandle)[Unit] psLib.synchronized {
psLib.Free_DH(dhHandle)[Unit]
}
started = false started = false
} }
@ -196,8 +216,13 @@ object CryptoInterface {
class CryptoState(val decryptionKey : ByteVector, class CryptoState(val decryptionKey : ByteVector,
val encryptionKey : ByteVector) extends IFinalizable { val encryptionKey : ByteVector) extends IFinalizable {
// Note that the keys must be returned as primitive Arrays for JNA to work // Note that the keys must be returned as primitive Arrays for JNA to work
val encCryptoHandle = psLib.RC5_Init(encryptionKey.toArray, encryptionKey.length, true)[Pointer] var encCryptoHandle : Pointer = Pointer.NULL
val decCryptoHandle = psLib.RC5_Init(decryptionKey.toArray, decryptionKey.length, false)[Pointer] var decCryptoHandle : Pointer = Pointer.NULL
psLib.synchronized {
encCryptoHandle = psLib.RC5_Init(encryptionKey.toArray, encryptionKey.length, true)[Pointer]
decCryptoHandle = psLib.RC5_Init(decryptionKey.toArray, decryptionKey.length, false)[Pointer]
}
if(encCryptoHandle == Pointer.NULL) if(encCryptoHandle == Pointer.NULL)
throw new Exception("Encryption initialization failed!") throw new Exception("Encryption initialization failed!")
@ -234,8 +259,10 @@ object CryptoInterface {
} }
override def close = { override def close = {
psLib.Free_RC5(encCryptoHandle)[Unit] psLib.synchronized {
psLib.Free_RC5(decCryptoHandle)[Unit] psLib.Free_RC5(encCryptoHandle)[Unit]
psLib.Free_RC5(decCryptoHandle)[Unit]
}
super.close super.close
} }
} }
@ -246,8 +273,8 @@ object CryptoInterface {
val encryptionMACKey : ByteVector) extends CryptoState(decryptionKey, encryptionKey) { val encryptionMACKey : ByteVector) extends CryptoState(decryptionKey, encryptionKey) {
/** /**
* Performs a MAC operation over the message. Used when encrypting packets * Performs a MAC operation over the message. Used when encrypting packets
* *
* @param message * @param message the input message
* @return ByteVector * @return ByteVector
*/ */
def macForEncrypt(message : ByteVector) : ByteVector = { def macForEncrypt(message : ByteVector) : ByteVector = {
@ -256,8 +283,8 @@ object CryptoInterface {
/** /**
* Performs a MAC operation over the message. Used when verifying decrypted packets * Performs a MAC operation over the message. Used when verifying decrypted packets
* *
* @param message * @param message the input message
* @return ByteVector * @return ByteVector
*/ */
def macForDecrypt(message : ByteVector) : ByteVector = { def macForDecrypt(message : ByteVector) : ByteVector = {