Skip to content

CHANGELOG

0.4.0 – Secret derivation, more algorithms, kotlinx-io

Published 12 Oct 2024

Features

  • Ecliptic curves improvements:
    • Implement ECDH via a new shared secret derivation API
    • Support ECDSA in Apple provider
    • Support both ECDSA signature formats for all providers
    • Added RAW private key encoding (encoding secret value)
    • Added SEC1/RFC5915 private key encoding
  • New algorithms:
    • Support for PBKDF2 and HKDF via a new secret derivation API
    • Legacy algorithms supported. Make sure you really need them before use:
      • AES-ECB – JDK name AES/ECB/PKCS1Padding or AES/ECB/NoPadding
      • RSA-PKCS1 (encryption) – JDK name RSA/ECB/PKCS1Padding
      • RSA (encryption) – JDK name RSA/ECB/NoPadding
  • IO improvements and kotlinx-io integration:
    • Support ByteString in places where ByteArray is used
    • Incremental hashing and signature generation/verification via HashFunction, SignFunction and VerifyFunction
    • Support hash/sign/verify over kotlinx-io Sink and Source
    • Support for streaming encryption/decryption over kotlinx-io Sink and Source
  • Add the ability to use custom IV in AES-GCM (#38)
  • Allow arbitrary key sizes in HMAC

Breaking changes

  • Drop default signature format parameter for ECDSA
  • Rename some parameters in algorithms/operations to have better clarity and less noise
  • Rename PEM and DER to Pem and Der respectively
  • Move operations from subpackages to operations package
    • dev.whyoleg.cryptography.operations.hash.Hasher was moved to dev.whyoleg.cryptography.operations.Hasher
    • dev.whyoleg.cryptography.operations.cipher.* was moved to dev.whyoleg.cryptography.operations.*
    • dev.whyoleg.cryptography.operations.signature.* was moved to dev.whyoleg.cryptography.operations.*
    • Old declarations are deprecated for removal with ReplaceWith
  • Move algorithms from subpackages to algorithms package
    • dev.whyoleg.cryptography.algorithms.digest.* was moved to dev.whyoleg.cryptography.algorithms.*
    • dev.whyoleg.cryptography.algorithms.symmetric.* was moved to dev.whyoleg.cryptography.algorithms.*
    • dev.whyoleg.cryptography.algorithms.asymmetric.* was moved to dev.whyoleg.cryptography.algorithms.*
    • Old declarations are deprecated for removal with ReplaceWith
  • SymmetricKeySize was deprecated in favor of AES.Key.Size properties
  • SignatureVerifier.verifySignature now throws on invalid signature instead of returning Boolean
    • SignatureVerifier.tryVerifySignature is introduced for rare cases when graceful handling is needed
  • Renamed AES methods with explicitly provided IV from encrypt(iv)/decrypt(iv) to encryptWithIv(iv)/decryptWithIv(iv) to be more explicit and better distinguish implcit and explict cases
  • CryptographyException is no longer used: IllegalStateException is thrown instead

Other improvements

  • Kotlin 2.0.20
  • Update the prebuilt OpenSSL version to 3.3.2
  • Improve ASN.1/DER encoding feature coverage:
    • support Context specific tags, both implicit and explicit
    • fully support optional and default properties
    • support Kotlin inline classes
    • add more ASN.1 modules for RSA and EC
  • Make ServiceLoader usage to be optimized by Android R8

0.3.1

Published 21 May 2024

  • Fix concurrency issue in jdk provider (#26)

0.3.0 - Support for ALL targets, new experimental modules

Published 21 Feb 2024

New Kotlin targets

  • cryptography-core and cryptography-random modules are now supported for ALL Kotlin targets!
  • CryptographyRandom implementation for WasmJs and WasmWasi
  • WebCrypto provider for WasmJs
  • OpenSSL provider now supports ALL K/N targets (#10)
    • new targets: linuxArm64, tvOS, watchOS, androidNative*

New features

  • RSA (PSS, OAEP, PKCS1) support in Apple provider (#12)
  • RSA PKCS#1 key encoding support
  • New algorithm support: AES-CTR
  • Support for explicitly provided IV in AES-CTR and AES-CBC
    • Note: these APIs are marked as DelicateCryptographyApi, and so should be used only when it’s really required as they are easy to misuse

Bug fixes

  • Fix mingw linking because of zlib (#13)

Breaking changes

  • Replace InsecureAlgorithm annotation with DelicateCryptographyApi - API breaking change
  • publicExponent parameter in RSA keyPairGenerator is now of type BigInt - both API and ABI breaking change
  • RSA key formats are now implemented via sealed class instead of enum - ABI breaking change

General improvements

  • Kotlin 1.9.22
  • Update the prebuilt OpenSSL version to 3.2.0
  • Test OpenSSL provider over 3.0, 3.1, 3.2
  • A lot of changes and improvements to build, tests and CI configuration

Experimental features

  • Introduce support for BigInt
    • use platform specifics where possible
    • RSA public exponent now works in the same way for all providers
    • all Kotlin targets supported
  • Introduce support for PEM encoding/decoding
    • fully common implementation
  • Introduce support for ASN.1/DER serialization

0.2.0 - New algorithms, Android integration testing

Published 5 Sep 2023

New algorithms

  • RSA.PKCS1 (RSAES-PKCS1-v1_5) - supported by JDK, WebCrypto and OpenSSL3 providers #5
  • SHA224 - supported by JDK, OpenSSL3 and Apple providers
  • SHA3 family - supported by JDK and OpenSSL3 providers

Testing improvements

  • Support running tests with BouncyCastle in addition to default JDK provider
  • Support running JDK provider tests on Android emulator with API level 21, 27 and 30
  • Add ECDSA with secp256k1 curve testing (supported by JDK BouncyCastle and OpenSSL3 providers) #4

General improvements

  • Kotlin 1.9.10
  • a lot of under the hood changes to improve test coverage and test correctness

Breaking changes

  • providers artifacts and package name changes. F.e. for JDK provider:
    • maven artifact name changed from cryptography-jdk to cryptography-provider-jdk
    • package name changed from dev.whyoleg.cryptography.jdk to dev.whyoleg.cryptography.providers.jdk
  • several classes and annotation changed package name to dev.whyoleg.cryptography to simplify hierarchy:
    • CryptographyAlgorithm
    • CryptographyAlgorithmNotFoundException
    • CryptographyProvider
    • CryptographyProviderApi
    • InsecureAlgorithm
  • simplified JDK provider with custom provider creation
    • JdkProvider class removed
    • java.security.Provider or it’s name can be now directly provided in constructor function
      • before: CryptographyProvider.JDK(JdkProvider.Instance(BouncyCastleProvider())) or CryptographyProvider.JDK(JdkProvider.Name("BC"))
      • now: CryptographyProvider.JDK(BouncyCastleProvider()) or CryptographyProvider.JDK("BC")

0.1.0 - First release

Published 23 Mar 2023