sealed trait Jwk extends AnyRef

A public JSON Web Key as defined by RFC 7517.

Only the public parameters of RSA, EC and OKP keys are modelled. Private members such as d, p, q, dp, dq, qi or oth are ignored: they are never read when parsing and never written by toJson.

The certificate members x5c, x5t, x5t#S256 and x5u are ignored too: no certificate chain is read, validated or checked against the key, and they are never written by toJson.

Keys are immutable values. Use the companion factories to construct them, named accessors to inspect them and withKeyId, withUse, withAlgorithm or withKeyOperations to update their metadata. They deliberately do not expose case-class copy, extractors or Product APIs, so that the model can evolve without changing those public signatures.

Linear Supertypes
AnyRef, Any
Known Subclasses
EcJwk, OkpJwk, RsaJwk
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Jwk
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def algorithm: Option[String]

    The raw alg member, which may name a non-signature algorithm.

  2. abstract def keyId: Option[String]

    The kid member.

  3. abstract def keyOperations: Option[Set[String]]

    The key_ops member, None when absent.

  4. abstract def publicKey: PublicKey

    Exceptions thrown

    java.security.NoSuchAlgorithmException if the JDK has no key factory for this type of key

    java.security.spec.InvalidKeySpecException if the JDK refuses the parameters as a key

  5. abstract def use: Option[JwkUse]

    The use member.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def thumbprint: JwkThumbprint

    The SHA-256 thumbprint of this key, see JwkThumbprint.

  16. def toJson: String
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped