Struct ethers::signers::yubihsm::capability::Capability [−][src]
pub struct Capability { /* fields omitted */ }
Expand description
Object attributes specifying which operations are allowed to be performed
https://developers.yubico.com/YubiHSM2/Concepts/Capability.html
Implementations
derive-ecdh
: perform ECDH operation
decrypt-oaep
: perform RSA-OAEP decryption
decrypt-pkcs
: perform RSA-PKCS1v1.5 decryption
generate-asymmetric-key
: generate asymmetric objects
sign-ecdsa
: compute ECDSA digital signature
sign-eddsa
: compute EdDSA (i.e. Ed25519) digital signature
sign-pkcs
: compute RSA-PKCS1v1.5 digital signature
sign-pss
: compute RSA-PSS digital signature
sign-attestation-certificate
: create attestation (i.e. X.509 certificate)
about an asymmetric object
get-log-entries
: read the log store
delete-asymmetric-key
: delete asymmetric key objects
delete-authentication-key
: delete authentication::Key objects
delete-hmac-key
: delete HMACKey objects
delete-opaque
: delete opaque objects
delete-otp-aead-key
: delete Yubic OTP AEAD key objects
delete-template
: delete template objects
delete-wrap-key
: delete WrapKey objects
exportable-under-wrap
: mark an object as exportable under keywrap
export-wrapped
: export objects under keywrap
generate-otp-aead-key
: generate Yubico OTP AEAD objects
generate-wrap-key
: generate wrapkey objects
get-opaque
: read opaque objects
get-option
: read device-global options
get-pseudo-random
: extract random bytes
get-template
: read SSH template objects
generate-hmac-key
: generate HMAC key objects
sign-hmac
: compute HMAC for data
verify-hmac
: verify HMAC for data
import-wrapped
: import keywrapped objects
create-otp-aead
: create an OTP AEAD
randomize-otp-aead
: create an OTP AEAD from random data
rewrap-from-otp-aead-key
: rewrap AEADs from an OTP AEAD key object to another
rewrap-to-otp-aead-key
: rewrap AEADs to an OTP AEAD key object from another
decrypt-otp
: decrypt OTP
put-asymmetric-key
: write asymmetric objects
put-authentication-key
: write authentication key objects
put-hmac-key
: write HMAC key objects
put-opaque
: Write Opaque Objects
set-option
: write device-global options
put-otp-aead-key
: write OTP AEAD key objects
put-template
: write template objects
put-wrap-key
: write WrapKey objects
reset-device
: factory reset the device
sign-ssh-certificate
: sign SSH certificates
unwrap-data
: unwrap user-provided data
wrap-data
: wrap user-provided data
change-authentication-key
: overwrite existing authentication key with new one
unknown capability: bit 47
unknown capability: bit 48
unknown capability: bit 49
unknown capability: bit 50
unknown capability: bit 51
unknown capability: bit 52
unknown capability: bit 53
unknown capability: bit 54
unknown capability: bit 55
unknown capability: bit 56
unknown capability: bit 57
unknown capability: bit 58
unknown capability: bit 59
unknown capability: bit 60
unknown capability: bit 61
unknown capability: bit 62
unknown capability: bit 63
Returns an empty set of flags.
Returns the set containing all flags.
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
Returns true
if there are flags common to both self
and other
.
Returns true
if all of the flags in other
are contained within self
.
Inserts the specified flags in-place.
Removes the specified flags in-place.
Toggles the specified flags in-place.
Inserts or removes the specified flags depending on the passed value.
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations
Returns the intersection between the two sets of flags.
type Output = Capability
type Output = Capability
The resulting type after applying the &
operator.
Disables all flags disabled in the set.
Returns the union of the two sets of flags.
type Output = Capability
type Output = Capability
The resulting type after applying the |
operator.
Adds the set of flags.
Returns the left flags, but with all the right flags toggled.
type Output = Capability
type Output = Capability
The resulting type after applying the ^
operator.
Toggles the set of flags.
Returns the “default value” for a type. Read more
pub fn deserialize<D>(
deserializer: D
) -> Result<Capability, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
pub fn deserialize<D>(
deserializer: D
) -> Result<Capability, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Extends a collection with the contents of an iterator. Read more
extend_one
)Extends a collection with exactly one element.
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
Creates a value from an iterator. Read more
Returns the complement of this set of flags.
type Output = Capability
type Output = Capability
The resulting type after applying the !
operator.
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
Serialize this value into the given Serde serializer. Read more
Returns the set difference of the two sets of flags.
type Output = Capability
type Output = Capability
The resulting type after applying the -
operator.
Disables all flags enabled in the set.
Auto Trait Implementations
impl RefUnwindSafe for Capability
impl Send for Capability
impl Sync for Capability
impl Unpin for Capability
impl UnwindSafe for Capability
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more