Packages

final case class SshUserCertificate(id: String, uri: URI, createdAt: OffsetDateTime, description: String, metadata: String, publicKey: String, keyType: String, sshCertificateAuthorityId: String, principals: List[String], criticalOptions: Map[String, String], extensions: Map[String, String], validAfter: OffsetDateTime, validUntil: OffsetDateTime, certificate: String) extends Product with Serializable

A class encapsulating the SshUserCertificate resource.

id

unique identifier for this SSH User Certificate

uri

URI of the SSH User Certificate API resource

createdAt

timestamp when the SSH User Certificate API resource was created, RFC 3339 format

description

human-readable description of this SSH User Certificate. optional, max 255 bytes.

metadata

arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.

publicKey

a public key in OpenSSH Authorized Keys format that this certificate signs

keyType

the key type of the public_key, one of rsa, ecdsa or ed25519

sshCertificateAuthorityId

the ssh certificate authority that is used to sign this ssh user certificate

principals

the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizing the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.

criticalOptions

A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.

extensions

A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.

validAfter

the time when the ssh host certificate becomes valid, in RFC 3339 format.

validUntil

the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.

certificate

the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SshUserCertificate
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SshUserCertificate(id: String, uri: URI, createdAt: OffsetDateTime, description: String, metadata: String, publicKey: String, keyType: String, sshCertificateAuthorityId: String, principals: List[String], criticalOptions: Map[String, String], extensions: Map[String, String], validAfter: OffsetDateTime, validUntil: OffsetDateTime, certificate: String)

    create a new SshUserCertificate.

    create a new SshUserCertificate.

    id

    unique identifier for this SSH User Certificate

    uri

    URI of the SSH User Certificate API resource

    createdAt

    timestamp when the SSH User Certificate API resource was created, RFC 3339 format

    description

    human-readable description of this SSH User Certificate. optional, max 255 bytes.

    metadata

    arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.

    publicKey

    a public key in OpenSSH Authorized Keys format that this certificate signs

    keyType

    the key type of the public_key, one of rsa, ecdsa or ed25519

    sshCertificateAuthorityId

    the ssh certificate authority that is used to sign this ssh user certificate

    principals

    the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizing the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.

    criticalOptions

    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.

    extensions

    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.

    validAfter

    the time when the ssh host certificate becomes valid, in RFC 3339 format.

    validUntil

    the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.

    certificate

    the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from SshUserCertificate toany2stringadd[SshUserCertificate] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SshUserCertificate, B)
    Implicit
    This member is added by an implicit conversion from SshUserCertificate toArrowAssoc[SshUserCertificate] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val certificate: String
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. val createdAt: OffsetDateTime
  10. val criticalOptions: Map[String, String]
  11. val description: String
  12. def ensuring(cond: (SshUserCertificate) => Boolean, msg: => Any): SshUserCertificate
    Implicit
    This member is added by an implicit conversion from SshUserCertificate toEnsuring[SshUserCertificate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (SshUserCertificate) => Boolean): SshUserCertificate
    Implicit
    This member is added by an implicit conversion from SshUserCertificate toEnsuring[SshUserCertificate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): SshUserCertificate
    Implicit
    This member is added by an implicit conversion from SshUserCertificate toEnsuring[SshUserCertificate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): SshUserCertificate
    Implicit
    This member is added by an implicit conversion from SshUserCertificate toEnsuring[SshUserCertificate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. val extensions: Map[String, String]
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. val id: String
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val keyType: String
  23. val metadata: String
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. val principals: List[String]
  28. def productElementNames: Iterator[String]
    Definition Classes
    Product
  29. val publicKey: String
  30. val sshCertificateAuthorityId: String
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. val uri: URI
  33. val validAfter: OffsetDateTime
  34. val validUntil: OffsetDateTime
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from SshUserCertificate toStringFormat[SshUserCertificate] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def [B](y: B): (SshUserCertificate, B)
    Implicit
    This member is added by an implicit conversion from SshUserCertificate toArrowAssoc[SshUserCertificate] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromSshUserCertificate to any2stringadd[SshUserCertificate]

Inherited by implicit conversion StringFormat fromSshUserCertificate to StringFormat[SshUserCertificate]

Inherited by implicit conversion Ensuring fromSshUserCertificate to Ensuring[SshUserCertificate]

Inherited by implicit conversion ArrowAssoc fromSshUserCertificate to ArrowAssoc[SshUserCertificate]

Ungrouped