jose-swift

1.2.2

A comprehensive Swift library for JOSE standards implementation, supporting JWA, JWK, JWE, JWS and JWT with robust encryption and signing functionalities.
beatt83/jose-swift

What's New

1.2.2

2024-02-21T16:39:20Z

What's Changed

  • fix: secp256k1 was creating compressed keys and should be uncompressed by @beatt83 in #7

Full Changelog: 1.2.1...1.2.2

Screenshot

Jose Swift Library

Swift iOS MacOS WatchOS TvOS

This library provides comprehensive support for the Jose suite of standards, including JWA (JSON Web Algorithms), JWK (JSON Web Key), JWE (JSON Web Encryption), JWS (JSON Web Signature), and JWT (JSON Web Token). These standards are integral to modern security protocols on the web, offering methods for secure key management, data encryption, signing, and representation of claims among different parties.

Table of Contents

  1. Available Features and Algorithms
  2. Requirements
  3. Swift Package Manager (SPM)
  4. Documentation
  5. Modules
  6. Contributing
  7. References
  8. Acknowledgments
  9. License

Available Features and Algorithms

JWT

JWT supported algorithmsJWT supported typesJWT supported claims validations
Algorithms Supported
All JWE algorithms
All JWS algorithms
Types Supported
Signed
Encrypted
Nested Signed
Nested Encrypted
Claims Supported
iss
sub
aud
nbf
exp
iat
typ
cty

JWE

JWE Supported TypesJWE Supported AlgorithmsJWE Supported Encodings
Type Supported
Compact String
JSON
JSON Flattened
Algorithm Supported
RSA1_5
RSA-OAEP
RSA-OAEP-256
A128KW
A192KW
A256KW
DIRECT
ECDH-ES
ECDH-ES+A128KW
ECDH-ES+A192KW
ECDH-ES+A256KW
A128GCMKW
A192GCMKW
A256GCMKW
PBES2-HS256+A128KW
PBES2-HS384+A192KW
PBES2-HS512+A256KW
Encoding Algorithm Supported
A128CBC-HS256
A128CBC-HS384
A128CBC-HS512
A128GCMKW
A192GCMKW
A256GCMKW

JWS

JWS Supported TypesJWS Supported Algorithms
Type Supported
Compact String
JSON
JSON Flattened
Algorithm Supported
HS256
HS384
HS512
RS256
RS384
RS512
ES256
ES384
ES512
PS256
PS384
PS512
EdDSA

JWK

JWK Supported Key Types
Key Type Supported
EC
RSA
OKT
OCK

Requirements

  • Swift 5.7.1 or later
  • iOS 15.0 or later
  • macOS 12.0 or later
  • Mac Catalyst 15.0 or later
  • tvOS 15.0 or later
  • watchOS 8.0 or later
  • Dependencies:

Swift Package Manager (SPM)

To use the jose-swift package in your project, you need to add it as a dependency in your Package.swift file.

Step 1: Add the Dependency

Open your Package.swift file and add the jose-swift package to your dependencies array. Make sure to specify the version you want to use:

dependencies: [
    .package(url: "https://github.com/your-username/jose-swift.git", .upToNextMinor(from: "1.0.0")),
    // ... other dependencies ...
]

Step 2: Add the Target Dependency

In the same Package.swift file, add jose-swift to the dependencies of your target:

targets: [
    .target(
        name: "YourTargetName",
        dependencies: [
            "jose-swift",
            // ... other dependencies ...
        ]
    ),
    // ... other targets ...
]

Step 3: Import and Use in Your Project

Once you've added the package as a dependency, you can import JSONWebEncryption, JWS, JWA, or JWK in your Swift files depending on what functionality you need:

import JSONWebEncryption
// or
import JSONWebSignature
// or
import JSONWebAlgorithms
// or
import JSONWebKey
// or
import JSONWebToken

Documentation

You can access here to the documentation.

Modules

JWK (JSON Web Key)

JWK is a standard way to represent cryptographic keys in a JSON format, as defined in RFC 7517. This module provides functionalities for generating, parsing, and managing JWKs, which are essential for encryption, decryption, and signing processes.

JWS (JSON Web Signature)

JWS is a standard for digitally signing arbitrary content, as detailed in RFC 7515. This module supports creating and verifying digital signatures, ensuring the integrity and authenticity of signed data.

#### Supported Algorithms:

  • RS256 (RSA Signature with SHA-256)
  • RS384 (RSA Signature with SHA-384)
  • RS512 (RSA Signature with SHA-512)
  • HS256 (HMAC with SHA-256)
  • HS384 (HMAC with SHA-384)
  • HS512 (HMAC with SHA-512)
  • ES256 (ECDSA using P-256 and SHA-256)
  • ES384 (ECDSA using P-384 and SHA-384)
  • ES512 (ECDSA using P-521 and SHA-512)
  • ES256K (ECDSA using secp256k1 and SHA-256)
  • PS256 (RSA PSS with SHA-256)
  • PS384 (RSA PSS with SHA-384)
  • PS512 (RSA PSS with SHA-512)
  • EdDSA (EdDSA using Ed25519) - RFC 8037

Example:

let payload = "Hello world".data(using: .utf8)!
let keyJWK = ... //JWK key

let jws = try JWS(payload: payload, key: keyJWK)

let jwsString = jws.compactSerialization

try JWS(jwsString: jwsString).verify(key: keyJWK)

JWE (JSON Web Encryption)

JWE represents encrypted content using JSON-based data structures, following the guidelines of RFC 7516. This module includes functionalities for encrypting and decrypting data, managing encryption keys, and handling various encryption algorithms and methods.

Supported Algorithms:

  1. Key Management Algorithms:

    • RSA1_5 (RSAES-PKCS1-v1_5)
    • RSA-OAEP (RSAES OAEP using default parameters)
    • RSA-OAEP-256 (RSAES OAEP using SHA-256 and MGF1 with SHA-256)
    • A128KW (AES Key Wrap with default 128-bit key)
    • A192KW (AES Key Wrap with 192-bit key)
    • A256KW (AES Key Wrap with 256-bit key)
    • dir (Direct use of a shared symmetric key)
    • ECDH-ES (Elliptic Curve Diffie-Hellman Ephemeral Static key agreement)
    • ECDH-ES+A128KW (ECDH-ES using Concat KDF and A128KW wrapping)
    • ECDH-ES+A192KW (ECDH-ES using Concat KDF and A192KW wrapping)
    • ECDH-ES+A256KW (ECDH-ES using Concat KDF and A256KW wrapping)
    • ECDH-1PU (Elliptic Curve Diffie-Hellman One-Pass Unified Model)
    • ECDH-1PU+A128KW (ECDH-1PU using Concat KDF and A128KW wrapping)
    • ECDH-1PU+A192KW (ECDH-1PU using Concat KDF and A192KW wrapping)
    • ECDH-1PU+A256KW (ECDH-1PU using Concat KDF and A256KW wrapping)
    • A128GCMKW (Key wrapping with AES GCM using 128-bit key)
    • A192GCMKW (Key wrapping with AES GCM using 192-bit key)
    • A256GCMKW (Key wrapping with AES GCM using 256-bit key)
    • PBES2-HS256+A128KW (PBES2 with HMAC SHA-256 and "A128KW" wrapping)
    • PBES2-HS384+A192KW (PBES2 with HMAC SHA-384 and "A192KW" wrapping)
    • PBES2-HS512+A256KW (PBES2 with HMAC SHA-512 and "A256KW" wrapping)
    • Note: ECDH-1PU is specified in draft-ietf-jose-cfrg-curves-10
  2. Content Encryption Algorithms:

    • A128CBC-HS256 (AES CBC using 128-bit key with HMAC SHA-256)
    • A192CBC-HS384 (AES CBC using 192-bit key with HMAC SHA-384)
    • A256CBC-HS512 (AES CBC using 256-bit key with HMAC SHA-512)
    • A128GCM (AES GCM using 128-bit key)
    • A192GCM (AES GCM using 192-bit key)
    • A256GCM (AES GCM using 256-bit key)

Example:

let payload = "Hello world".data(using: .utf8)!
let keyJWK = ... //JWK key


let serialization = try JWE(
    payload: payload,
    keyManagementAlg: .a256KW,
    encryptionAlgorithm: .a256GCM,
    recipientKey: keyJWK
)

let compact = serialization.compactSerialization()

let jwe = try JWE(compactString: compact)
let decrypted = try jwe.decrypt(recipientKey: recipientJWK)

JWT (JSON Web Token)

JWT is a compact, URL-safe means of representing claims to be transferred between two parties. This module offers tools for creating, parsing, validating, and manipulating JWTs, with support for various signing and encryption methods, as specified in RFC 7519.

Features:

  1. Signed JWTs:

    • Supports digital signatures to verify the authenticity and integrity of the token.
    • Utilizes JWS (JSON Web Signature) standards.
    • Supports all JWS algorithms previously mentioned.
  2. Encrypted JWTs:

    • Facilitates encryption of token content for confidentiality.
    • Uses JWE (JSON Web Encryption) for robust encryption standards.
    • Supports all JWE algorithms previously mentioned.
  3. Nested JWT (JWS + JWE):

    • Implements Nested JWTs where a JWT is signed and then encrypted, providing both the benefits of JWS and JWE.
    • Ensures that a token is first authenticated (JWS) and then secured for privacy (JWE).
  4. Claim Validation:

    • Offers extensive capabilities to validate JWT claims.
    • Includes standard claims like issuer (iss), subject (sub), audience (aud), expiration (exp), not before (nbf), and issued at (iat).
    • Custom claim validation to meet specific security requirements.

Example:

  • Signed JWT
let keyJWK = ... //JWK key
let mockClaims = DefaultJWTClaims(
    issuer: "testAlice",
    subject: "Alice",
    expirationTime: expiredAt
)

let jwt = try JWT.signed(
    payload: mockClaims,
    protectedHeader: DefaultJWSHeaderImpl(algorithm: .ES256),
    key: key
)

let jwtString = jwt.jwtString

let verifiedJWT = try JWT<DefaultJWTClaims>.verify(jwtString: jwtString, senderKey: key)
let verifiedPayload = verifiedJWT.payload
  • Encrypted JWT
let keyJWK = ... //JWK key
let mockClaims = DefaultJWTClaims(
    issuer: "testAlice",
    subject: "Alice",
    expirationTime: expiredAt
)

let jwt = try JWT.encrypt(
    payload: payload,
    protectedHeader: DefaultJWSHeaderImpl(keyManagementAlgorithm: .a128KW, encodingAlgorithm: .a128CBCHS256),
    recipientKey: keyJWK
)

let jwtString = jwt.jwtString

let verifiedJWT = try JWT<DefaultJWTClaims>.verify(jwtString: jwtString, recipientKey: key)
let verifiedPayload = verifiedJWT.payload

JWA (JSON Web Algorithms)

JWA specifies cryptographic algorithms used in the context of Jose to perform digital signing and content encryption, as detailed in RFC 7518. It includes standards for various types of algorithms like RSA, AES, HMAC, and more.

Contributing

Contributions to the library are welcome. Please ensure that your contributions adhere to the Jose standards and add value to the existing functionalities.

References

Acknowledgments

Special thanks to the swift-jose repository by Zsombor Szabo for serving as an inspiration for this project. I have adopted parts of the JWK implementation and several test vectors from their work, which have been instrumental in shaping aspects of this library. Their contributions to the open-source community are sincerely appreciated.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

Description

  • Swift Tools 5.8.0
View More Packages from this Author

Dependencies

Last updated: Sun Feb 25 2024 21:22:10 GMT-1000 (Hawaii-Aleutian Standard Time)