Packages

case class Names(commonName: String, altNames: Array[String] = Array.empty, ipSans: Array[String] = Array.empty, uriSans: Array[String] = Array.empty, otherSans: Array[String] = Array.empty, excludeCnFromSans: Boolean = false) extends Product with Serializable

commonName

the requested CN for the certificate. If the CN is allowed by role policy, it will be issued.

altNames

the requested Subject Alternative Names. These can be host names or email addresses; they will be parsed into their respective fields. If any requested names do not match role policy, the entire request will be denied.

ipSans

the requested IP Subject Alternative Names. Only valid if the role allows IP SANs (which is the default).

uriSans

the requested URI Subject Alternative Names. If any requested URIs do not match role policy, the entire request will be denied.

otherSans

custom OID/UTF8-string SANs. These must match values specified on the role in allowed_other_sans (globbing allowed). The format is the same as OpenSSL: <oid>;<type>:<value> where the only current valid type is UTF8.

excludeCnFromSans

If set, the given commonName will not be included in DNS or Email Subject Alternate Names (as appropriate). Useful if the CN is not a hostname or email address, but is instead some human-readable identifier.

Source
Names.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Names
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Names(commonName: String, altNames: Array[String] = Array.empty, ipSans: Array[String] = Array.empty, uriSans: Array[String] = Array.empty, otherSans: Array[String] = Array.empty, excludeCnFromSans: Boolean = false)

    commonName

    the requested CN for the certificate. If the CN is allowed by role policy, it will be issued.

    altNames

    the requested Subject Alternative Names. These can be host names or email addresses; they will be parsed into their respective fields. If any requested names do not match role policy, the entire request will be denied.

    ipSans

    the requested IP Subject Alternative Names. Only valid if the role allows IP SANs (which is the default).

    uriSans

    the requested URI Subject Alternative Names. If any requested URIs do not match role policy, the entire request will be denied.

    otherSans

    custom OID/UTF8-string SANs. These must match values specified on the role in allowed_other_sans (globbing allowed). The format is the same as OpenSSL: <oid>;<type>:<value> where the only current valid type is UTF8.

    excludeCnFromSans

    If set, the given commonName will not be included in DNS or Email Subject Alternate Names (as appropriate). Useful if the CN is not a hostname or email address, but is instead some human-readable identifier.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (Names, B)
    Implicit
    This member is added by an implicit conversion from Names toArrowAssoc[Names] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. val altNames: Array[String]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val commonName: String
  9. def ensuring(cond: (Names) => Boolean, msg: => Any): Names
    Implicit
    This member is added by an implicit conversion from Names toEnsuring[Names] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (Names) => Boolean): Names
    Implicit
    This member is added by an implicit conversion from Names toEnsuring[Names] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): Names
    Implicit
    This member is added by an implicit conversion from Names toEnsuring[Names] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): Names
    Implicit
    This member is added by an implicit conversion from Names toEnsuring[Names] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. val excludeCnFromSans: Boolean
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Names toStringFormat[Names] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. val ipSans: Array[String]
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. val otherSans: Array[String]
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. val uriSans: Array[String]
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def [B](y: B): (Names, B)
    Implicit
    This member is added by an implicit conversion from Names toArrowAssoc[Names] 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 StringFormat fromNames to StringFormat[Names]

Inherited by implicit conversion Ensuring fromNames to Ensuring[Names]

Inherited by implicit conversion ArrowAssoc fromNames to ArrowAssoc[Names]

Ungrouped