CryptographicMaterialRole extension type

Known values for CryptographicMaterial.role — the mechanical role a key material plays, independent of the algorithm family (see CryptographicMaterialAlgorithm).

An open String with the same forward-compatibility contract as CryptographicMaterialAlgorithm. Roles describe what the mathematics does; whether an algorithm is classical, post-quantum or hybrid is a property of the CryptographicMaterialAlgorithm token, and deployment purpose belongs in the keyId and CryptographicMaterial.operations.

Do not change any existing value below — same rationale as CryptographicMaterialAlgorithm: these strings are already persisted on disk and on the wire, so renaming one orphans existing key material. See test/atkey_material_test.dart for the tripwire test that pins these.

on
Implemented types
Available extensions

Constructors

CryptographicMaterialRole.of(String value)
A role token read from a keyfile, whatever it says.
const

Properties

codeUnits → List<int>
An unmodifiable list of the UTF-16 code units of this string.
no setterinherited
hashCode → int
A hash code derived from the code units of the string.
no setterinherited
isEmpty → bool
Whether this string is empty.
no setterinherited
isNotEmpty → bool
Whether this string is not empty.
no setterinherited
length → int
The length of the string.
no setterinherited
runes → Runes
An Iterable of Unicode code-points of this string.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
toJS → JSString

Available on String, provided by the StringToJSString extension

Converts this String to a JSString.
no setter
value → String
final

Methods

allMatches(String string, [int start = 0]) → Iterable<Match>
Matches this pattern against the string repeatedly.
inherited
codeUnitAt(int index) → int
Returns the 16-bit UTF-16 code unit at the given index.
inherited
compareTo(String other) → int
Compares this string to other.
inherited
contains(Pattern other, [int startIndex = 0]) → bool
Whether this string contains a match of other.
inherited
endsWith(String other) → bool
Whether this string ends with other.
inherited
indexOf(Pattern pattern, [int start = 0]) → int
Returns the position of the first match of pattern in this string, starting at start, inclusive:
inherited
lastIndexOf(Pattern pattern, [int? start]) → int
The starting position of the last match pattern in this string.
inherited
matchAsPrefix(String string, [int start = 0]) → Match?
Matches this pattern against the start of string.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
padLeft(int width, [String padding = ' ']) → String
Pads this string on the left if it is shorter than width.
inherited
padRight(int width, [String padding = ' ']) → String
Pads this string on the right if it is shorter than width.
inherited
replaceAll(Pattern from, String replace) → String
Replaces all substrings that match from with replace.
inherited
replaceAllMapped(Pattern from, String replace(Match match)) → String
Replace all substrings that match from by a computed string.
inherited
replaceFirst(Pattern from, String to, [int startIndex = 0]) → String
Creates a new string with the first occurrence of from replaced by to.
inherited
replaceFirstMapped(Pattern from, String replace(Match match), [int startIndex = 0]) → String
Replace the first occurrence of from in this string.
inherited
replaceRange(int start, int? end, String replacement) → String
Replaces the substring from start to end with replacement.
inherited
split(Pattern pattern) → List<String>
Splits the string at matches of pattern and returns a list of substrings.
inherited
splitMapJoin(Pattern pattern, {String onMatch(Match)?, String onNonMatch(String)?}) → String
Splits the string, converts its parts, and combines them into a new string.
inherited
startsWith(Pattern pattern, [int index = 0]) → bool
Whether this string starts with a match of pattern.
inherited
substring(int start, [int? end]) → String
The substring of this string from start, inclusive, to end, exclusive.
inherited
toLowerCase() → String
Converts all characters in this string to lower case.
inherited
toString() → String
A string representation of this object.
inherited
toUpperCase() → String
Converts all characters in this string to upper case.
inherited
trim() → String
The string without any leading and trailing whitespace.
inherited
trimLeft() → String
The string without any leading whitespace.
inherited
trimRight() → String
The string without any trailing whitespace.
inherited

Operators

operator *(int times) → String
Creates a new string by concatenating this string with itself a number of times.
inherited
operator +(String other) → String
Creates a new string by concatenating this string with other.
inherited
operator ==(Object other) → bool
Whether other is a String with the same sequence of code units.
inherited
operator [](int index) → String
The character (as a single-code-unit String) at the given index.
inherited

Constants

known → const Set<CryptographicMaterialRole>
The tokens this version knows about. For warn-level tooling only — never reject a value for not being in this set.
privateAuthentication → const CryptographicMaterialRole
The APKAM keypair an enrollment authenticates with, and nothing else — the key PKAM proves possession of.
privateDecapsulation → const CryptographicMaterialRole
privateDecryption → const CryptographicMaterialRole
privateKeyAgreement → const CryptographicMaterialRole
privateSigning → const CryptographicMaterialRole
publicAuthentication → const CryptographicMaterialRole
publicEncapsulation → const CryptographicMaterialRole
publicEncryption → const CryptographicMaterialRole
publicKeyAgreement → const CryptographicMaterialRole
publicVerification → const CryptographicMaterialRole
symmetricAuthentication → const CryptographicMaterialRole
symmetricEncryption → const CryptographicMaterialRole