README.md

JWT Kotlin Multiplatform - HMAC

Sign and verify JWTs using HMAC algorithm.

Supported Algorithms

• HS256
• HS384
• HS512

Usage

Installation

Gradle:

commonMain.dependencies {
    implementation("com.appstractive:jwt-kt:1.0.3")
    implementation("com.appstractive:jwt-hmac-kt:1.0.3")
}

Sign JWT

val jwt: UnsignedJWT = jwt {
    claims { issuer = "example.com" }
}
val mySecret = CryptographyRandom.nextBytes(64)

val signedJWT = jwt.sign {
    hs256 { secret = mySecret }
    // or with different hashing
    // hs384 { secret = mySecret }
    // hs512 { secret = mySecret }
}

Verify JWT

val jwt = JWT.from("eyJraWQiOiJzLWRmZmZkMDJlLTlhNDItNDQzMC1hNT...")
val mySecret = CryptographyRandom.nextBytes(64)

val isValid = jwt.verify {
    hs256 { secret = mySecret }
    // or with different hashing
    // hs384 { secret = mySecret }
    // hs512 { secret = mySecret }
    
    // verify issuer
    issuer("example.com")
    // verify audience
    audience("api.example.com")
    // verify expiration
    expiresAt()
    // verify not before time
    notBefore()
}

License

Copyright 2024 Andreas Schulz.

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.