return the X9ECParameters object for the named curve represented by
the passed in object identifier. Null if the curve isn't present.
@param oid an object identifier representing a named curve, if present.
return the object identifier signified by the passed in name. Null
if there is no object identifier associated with name.
@return the object identifier associated with name, if present.
return the named curve name represented by the given object identifier.
returns an enumeration containing the name strings for curves
contained in this structure.
Return the DER encoding of the object, null if the DER encoding can not be made.
@return a DER byte array, null otherwise.
Mutable class for building ASN.1 constructed objects such as SETs or SEQUENCEs.
a general purpose ASN.1 decoder - note: this class differs from the
others in that it returns null after it has read the last object in
the stream. If an ASN.1 Null is encountered a Der/BER Null object is
returned.
Create an ASN1InputStream where no DER object will be longer than limit.
@param input stream containing ASN.1 encoded data.
@param limit maximum size of a DER encoded object.
Create an ASN1InputStream based on the input byte array. The length of DER objects in
the stream is automatically limited to the length of the input array.
@param input array containing ASN.1 encoded data.
build an object given its tag and the number of bytes to construct it from.
A Null object.
Create a base ASN.1 object from a byte array.
The byte array to parse.
The base ASN.1 object represented by the byte array.
If there is a problem parsing the data.
Read a base ASN.1 object from a stream.
The stream to parse.
The base ASN.1 object represented by the byte array.
If there is a problem parsing the data.
return an Octet string from a tagged object.
@param obj the tagged object holding the object we want.
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
return an Octet string from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
@param string the octets making up the octet string.
return an Asn1Sequence from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
Return an ASN1 sequence from a tagged object. There is a special
case here, if an object appears to have been explicitly tagged on
reading but we were expecting it to be implicitly tagged in the
normal course of events it indicates that we lost the surrounding
sequence - so we need to add it back (this will happen if the tagged
object is a sequence that contains other sequences). If you are
dealing with implicitly tagged sequences you really should
be using this method.
@param obj the tagged object.
@param explicitly true if the object is meant to be explicitly tagged,
false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
return the object at the sequence position indicated by index.
@param index the sequence number (starting at zero) of the object
@return the object at the sequence position indicated by index.
return an ASN1Set from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
Return an ASN1 set from a tagged object. There is a special
case here, if an object appears to have been explicitly tagged on
reading but we were expecting it to be implicitly tagged in the
normal course of events it indicates that we lost the surrounding
set - so we need to add it back (this will happen if the tagged
object is a sequence that contains other sequences). If you are
dealing with implicitly tagged sets you really should
be using this method.
@param obj the tagged object.
@param explicitly true if the object is meant to be explicitly tagged
false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
return the object at the set position indicated by index.
@param index the set number (starting at zero) of the object
@return the object at the set position indicated by index.
ASN.1 TaggedObject - in ASN.1 notation this is any object preceded by
a [n] where n is some number - these are assumed to follow the construction
rules (as with sequences).
@param tagNo the tag number for this object.
@param obj the tagged object.
@param explicitly true if the object is explicitly tagged.
@param tagNo the tag number for this object.
@param obj the tagged object.
return whether or not the object may be explicitly tagged.
Note: if the object has been read from an input stream, the only
time you can be sure if isExplicit is returning the true state of
affairs is if it returns false. An implicitly tagged object may appear
to be explicitly tagged, so you need to understand the context under
which the reading was done as well, see GetObject below.
return whatever was following the tag.
Note: tagged objects are generally context dependent if you're
trying to extract a tagged object you should be going via the
appropriate GetInstance method.
Return the object held in this tagged object as a parser assuming it has
the type of the passed in tag. If the object doesn't have a parser
associated with it, the base object is returned.
iso.org.dod.internet.private.enterprise.legion-of-the-bouncy-castle
1.3.6.1.4.1.22554
pbe(1) algorithms
1.3.6.1.4.1.22554.1
SHA-1(1)
1.3.6.1.4.1.22554.1.1
SHA-2.SHA-256; 1.3.6.1.4.1.22554.1.2.1
SHA-2.SHA-384; 1.3.6.1.4.1.22554.1.2.2
SHA-2.SHA-512; 1.3.6.1.4.1.22554.1.2.3
SHA-2.SHA-224; 1.3.6.1.4.1.22554.1.2.4
PKCS-5(1)|PKCS-12(2)
SHA-1.PKCS5; 1.3.6.1.4.1.22554.1.1.1
SHA-1.PKCS12; 1.3.6.1.4.1.22554.1.1.2
SHA-256.PKCS12; 1.3.6.1.4.1.22554.1.2.1.1
SHA-256.PKCS12; 1.3.6.1.4.1.22554.1.2.1.2
AES(1) . (CBC-128(2)|CBC-192(22)|CBC-256(42))
1.3.6.1.4.1.22554.1.1.2.1.2
1.3.6.1.4.1.22554.1.1.2.1.22
1.3.6.1.4.1.22554.1.1.2.1.42
1.3.6.1.4.1.22554.1.1.2.2.2
1.3.6.1.4.1.22554.1.1.2.2.22
1.3.6.1.4.1.22554.1.1.2.2.42
signature(2) algorithms
Sphincs-256
key_exchange(3) algorithms
NewHope
A BER Null object.
convert a vector of octet strings into a single byte string
The octets making up the octet string.
return the DER octets that make up this string.
create an empty sequence
create a sequence containing one object
create a sequence containing a vector of objects.
create an empty sequence
create a set containing one object
create a set containing a vector of objects.
BER TaggedObject - in ASN.1 notation this is any object preceded by
a [n] where n is some number - these are assumed to follow the construction
rules (as with sequences).
@param tagNo the tag number for this object.
@param obj the tagged object.
@param explicitly true if an explicitly tagged object.
@param tagNo the tag number for this object.
@param obj the tagged object.
create an implicitly tagged object that contains a zero
length sequence.
CAKeyUpdAnnContent ::= SEQUENCE {
oldWithNew CmpCertificate, -- old pub signed with new priv
newWithOld CmpCertificate, -- new pub signed with old priv
newWithNew CmpCertificate -- new pub signed with new priv
}
@return a basic ASN.1 object representation.
CertConfirmContent ::= SEQUENCE OF CertStatus
@return a basic ASN.1 object representation.
CertifiedKeyPair ::= SEQUENCE {
certOrEncCert CertOrEncCert,
privateKey [0] EncryptedValue OPTIONAL,
-- see [CRMF] for comment on encoding
publicationInfo [1] PKIPublicationInfo OPTIONAL
}
@return a basic ASN.1 object representation.
CertOrEncCert ::= CHOICE {
certificate [0] CMPCertificate,
encryptedCert [1] EncryptedValue
}
@return a basic ASN.1 object representation.
CertRepMessage ::= SEQUENCE {
caPubs [1] SEQUENCE SIZE (1..MAX) OF CMPCertificate
OPTIONAL,
response SEQUENCE OF CertResponse
}
@return a basic ASN.1 object representation.
CertResponse ::= SEQUENCE {
certReqId INTEGER,
-- to match this response with corresponding request (a value
-- of -1 is to be used if certReqId is not specified in the
-- corresponding request)
status PKIStatusInfo,
certifiedKeyPair CertifiedKeyPair OPTIONAL,
rspInfo OCTET STRING OPTIONAL
-- analogous to the id-regInfo-utf8Pairs string defined
-- for regInfo in CertReqMsg [CRMF]
}
@return a basic ASN.1 object representation.
CertStatus ::= SEQUENCE {
certHash OCTET STRING,
-- the hash of the certificate, using the same hash algorithm
-- as is used to create and verify the certificate signature
certReqId INTEGER,
-- to match this confirmation with the corresponding req/rep
statusInfo PKIStatusInfo OPTIONAL
}
@return a basic ASN.1 object representation.
Challenge ::= SEQUENCE {
owf AlgorithmIdentifier OPTIONAL,
-- MUST be present in the first Challenge; MAY be omitted in
-- any subsequent Challenge in POPODecKeyChallContent (if
-- omitted, then the owf used in the immediately preceding
-- Challenge is to be used).
witness OCTET STRING,
-- the result of applying the one-way function (owf) to a
-- randomly-generated INTEGER, A. [Note that a different
-- INTEGER MUST be used for each Challenge.]
challenge OCTET STRING
-- the encryption (under the public key for which the cert.
-- request is being made) of Rand, where Rand is specified as
-- Rand ::= SEQUENCE {
-- int INTEGER,
-- - the randomly-generated INTEGER A (above)
-- sender GeneralName
-- - the sender's name (as included in PKIHeader)
-- }
}
@return a basic ASN.1 object representation.
Note: the addition of attribute certificates is a BC extension.
CMPCertificate ::= CHOICE {
x509v3PKCert Certificate
x509v2AttrCert [1] AttributeCertificate
}
Note: the addition of attribute certificates is a BC extension.
@return a basic ASN.1 object representation.
CrlAnnContent ::= SEQUENCE OF CertificateList
@return a basic ASN.1 object representation.
ErrorMsgContent ::= SEQUENCE {
pKIStatusInfo PKIStatusInfo,
errorCode INTEGER OPTIONAL,
-- implementation-specific error codes
errorDetails PKIFreeText OPTIONAL
-- implementation-specific error details
}
@return a basic ASN.1 object representation.
GenMsgContent ::= SEQUENCE OF InfoTypeAndValue
@return a basic ASN.1 object representation.
GenRepContent ::= SEQUENCE OF InfoTypeAndValue
@return a basic ASN.1 object representation.
Example InfoTypeAndValue contents include, but are not limited
to, the following (un-comment in this ASN.1 module and use as
appropriate for a given environment):
id-it-caProtEncCert OBJECT IDENTIFIER ::= {id-it 1}
CAProtEncCertValue ::= CMPCertificate
id-it-signKeyPairTypes OBJECT IDENTIFIER ::= {id-it 2}
SignKeyPairTypesValue ::= SEQUENCE OF AlgorithmIdentifier
id-it-encKeyPairTypes OBJECT IDENTIFIER ::= {id-it 3}
EncKeyPairTypesValue ::= SEQUENCE OF AlgorithmIdentifier
id-it-preferredSymmAlg OBJECT IDENTIFIER ::= {id-it 4}
PreferredSymmAlgValue ::= AlgorithmIdentifier
id-it-caKeyUpdateInfo OBJECT IDENTIFIER ::= {id-it 5}
CAKeyUpdateInfoValue ::= CAKeyUpdAnnContent
id-it-currentCRL OBJECT IDENTIFIER ::= {id-it 6}
CurrentCRLValue ::= CertificateList
id-it-unsupportedOIDs OBJECT IDENTIFIER ::= {id-it 7}
UnsupportedOIDsValue ::= SEQUENCE OF OBJECT IDENTIFIER
id-it-keyPairParamReq OBJECT IDENTIFIER ::= {id-it 10}
KeyPairParamReqValue ::= OBJECT IDENTIFIER
id-it-keyPairParamRep OBJECT IDENTIFIER ::= {id-it 11}
KeyPairParamRepValue ::= AlgorithmIdentifer
id-it-revPassphrase OBJECT IDENTIFIER ::= {id-it 12}
RevPassphraseValue ::= EncryptedValue
id-it-implicitConfirm OBJECT IDENTIFIER ::= {id-it 13}
ImplicitConfirmValue ::= NULL
id-it-confirmWaitTime OBJECT IDENTIFIER ::= {id-it 14}
ConfirmWaitTimeValue ::= GeneralizedTime
id-it-origPKIMessage OBJECT IDENTIFIER ::= {id-it 15}
OrigPKIMessageValue ::= PKIMessages
id-it-suppLangTags OBJECT IDENTIFIER ::= {id-it 16}
SuppLangTagsValue ::= SEQUENCE OF UTF8String
where
id-pkix OBJECT IDENTIFIER ::= {
iso(1) identified-organization(3)
dod(6) internet(1) security(5) mechanisms(5) pkix(7)}
and
id-it OBJECT IDENTIFIER ::= {id-pkix 4}
InfoTypeAndValue ::= SEQUENCE {
infoType OBJECT IDENTIFIER,
infoValue ANY DEFINED BY infoType OPTIONAL
}
@return a basic ASN.1 object representation.
KeyRecRepContent ::= SEQUENCE {
status PKIStatusInfo,
newSigCert [0] CMPCertificate OPTIONAL,
caCerts [1] SEQUENCE SIZE (1..MAX) OF
CMPCertificate OPTIONAL,
keyPairHist [2] SEQUENCE SIZE (1..MAX) OF
CertifiedKeyPair OPTIONAL
}
@return a basic ASN.1 object representation.
OobCertHash ::= SEQUENCE {
hashAlg [0] AlgorithmIdentifier OPTIONAL,
certId [1] CertId OPTIONAL,
hashVal BIT STRING
-- hashVal is calculated over the Der encoding of the
-- self-signed certificate with the identifier certID.
}
@return a basic ASN.1 object representation.
PbmParameter ::= SEQUENCE {
salt OCTET STRING,
-- note: implementations MAY wish to limit acceptable sizes
-- of this string to values appropriate for their environment
-- in order to reduce the risk of denial-of-service attacks
owf AlgorithmIdentifier,
-- AlgId for a One-Way Function (SHA-1 recommended)
iterationCount INTEGER,
-- number of times the OWF is applied
-- note: implementations MAY wish to limit acceptable sizes
-- of this integer to values appropriate for their environment
-- in order to reduce the risk of denial-of-service attacks
mac AlgorithmIdentifier
-- the MAC AlgId (e.g., DES-MAC, Triple-DES-MAC [PKCS11],
} -- or HMAC [RFC2104, RFC2202])
@return a basic ASN.1 object representation.
Creates a new PkiBody.
@param type one of the TYPE_* constants
@param content message content
PkiBody ::= CHOICE { -- message-specific body elements
ir [0] CertReqMessages, --Initialization Request
ip [1] CertRepMessage, --Initialization Response
cr [2] CertReqMessages, --Certification Request
cp [3] CertRepMessage, --Certification Response
p10cr [4] CertificationRequest, --imported from [PKCS10]
popdecc [5] POPODecKeyChallContent, --pop Challenge
popdecr [6] POPODecKeyRespContent, --pop Response
kur [7] CertReqMessages, --Key Update Request
kup [8] CertRepMessage, --Key Update Response
krr [9] CertReqMessages, --Key Recovery Request
krp [10] KeyRecRepContent, --Key Recovery Response
rr [11] RevReqContent, --Revocation Request
rp [12] RevRepContent, --Revocation Response
ccr [13] CertReqMessages, --Cross-Cert. Request
ccp [14] CertRepMessage, --Cross-Cert. Response
ckuann [15] CAKeyUpdAnnContent, --CA Key Update Ann.
cann [16] CertAnnContent, --Certificate Ann.
rann [17] RevAnnContent, --Revocation Ann.
crlann [18] CRLAnnContent, --CRL Announcement
pkiconf [19] PKIConfirmContent, --Confirmation
nested [20] NestedMessageContent, --Nested Message
genm [21] GenMsgContent, --General Message
genp [22] GenRepContent, --General Response
error [23] ErrorMsgContent, --Error Message
certConf [24] CertConfirmContent, --Certificate confirm
pollReq [25] PollReqContent, --Polling request
pollRep [26] PollRepContent --Polling response
}
@return a basic ASN.1 object representation.
PkiConfirmContent ::= NULL
@return a basic ASN.1 object representation.
PKIFailureInfo ::= BIT STRING {
badAlg (0),
-- unrecognized or unsupported Algorithm Identifier
badMessageCheck (1), -- integrity check failed (e.g., signature did not verify)
badRequest (2),
-- transaction not permitted or supported
badTime (3), -- messageTime was not sufficiently close to the system time, as defined by local policy
badCertId (4), -- no certificate could be found matching the provided criteria
badDataFormat (5),
-- the data submitted has the wrong format
wrongAuthority (6), -- the authority indicated in the request is different from the one creating the response token
incorrectData (7), -- the requester's data is incorrect (for notary services)
missingTimeStamp (8), -- when the timestamp is missing but should be there (by policy)
badPOP (9) -- the proof-of-possession failed
certRevoked (10),
certConfirmed (11),
wrongIntegrity (12),
badRecipientNonce (13),
timeNotAvailable (14),
-- the TSA's time source is not available
unacceptedPolicy (15),
-- the requested TSA policy is not supported by the TSA
unacceptedExtension (16),
-- the requested extension is not supported by the TSA
addInfoNotAvailable (17)
-- the additional information requested could not be understood
-- or is not available
badSenderNonce (18),
badCertTemplate (19),
signerNotTrusted (20),
transactionIdInUse (21),
unsupportedVersion (22),
notAuthorized (23),
systemUnavail (24),
systemFailure (25),
-- the request cannot be handled due to system failure
duplicateCertReq (26)
Basic constructor.
Return the number of string elements present
Return the UTF8STRING at index.
@param index index of the string of interest
@return the string at index.
PkiFreeText ::= SEQUENCE SIZE (1..MAX) OF UTF8String
Value for a "null" recipient or sender.
PkiHeader ::= SEQUENCE {
pvno INTEGER { cmp1999(1), cmp2000(2) },
sender GeneralName,
-- identifies the sender
recipient GeneralName,
-- identifies the intended recipient
messageTime [0] GeneralizedTime OPTIONAL,
-- time of production of this message (used when sender
-- believes that the transport will be "suitable"; i.e.,
-- that the time will still be meaningful upon receipt)
protectionAlg [1] AlgorithmIdentifier OPTIONAL,
-- algorithm used for calculation of protection bits
senderKID [2] KeyIdentifier OPTIONAL,
recipKID [3] KeyIdentifier OPTIONAL,
-- to identify specific keys used for protection
transactionID [4] OCTET STRING OPTIONAL,
-- identifies the transaction; i.e., this will be the same in
-- corresponding request, response, certConf, and PKIConf
-- messages
senderNonce [5] OCTET STRING OPTIONAL,
recipNonce [6] OCTET STRING OPTIONAL,
-- nonces used to provide replay protection, senderNonce
-- is inserted by the creator of this message; recipNonce
-- is a nonce previously inserted in a related message by
-- the intended recipient of this message
freeText [7] PKIFreeText OPTIONAL,
-- this may be used to indicate context-specific instructions
-- (this field is intended for human consumption)
generalInfo [8] SEQUENCE SIZE (1..MAX) OF
InfoTypeAndValue OPTIONAL
-- this may be used to convey context-specific information
-- (this field not primarily intended for human consumption)
}
@return a basic ASN.1 object representation.
PKIHeader ::= SEQUENCE {
pvno INTEGER { cmp1999(1), cmp2000(2) },
sender GeneralName,
-- identifies the sender
recipient GeneralName,
-- identifies the intended recipient
messageTime [0] GeneralizedTime OPTIONAL,
-- time of production of this message (used when sender
-- believes that the transport will be "suitable"; i.e.,
-- that the time will still be meaningful upon receipt)
protectionAlg [1] AlgorithmIdentifier OPTIONAL,
-- algorithm used for calculation of protection bits
senderKID [2] KeyIdentifier OPTIONAL,
recipKID [3] KeyIdentifier OPTIONAL,
-- to identify specific keys used for protection
transactionID [4] OCTET STRING OPTIONAL,
-- identifies the transaction; i.e., this will be the same in
-- corresponding request, response, certConf, and PKIConf
-- messages
senderNonce [5] OCTET STRING OPTIONAL,
recipNonce [6] OCTET STRING OPTIONAL,
-- nonces used to provide replay protection, senderNonce
-- is inserted by the creator of this message; recipNonce
-- is a nonce previously inserted in a related message by
-- the intended recipient of this message
freeText [7] PKIFreeText OPTIONAL,
-- this may be used to indicate context-specific instructions
-- (this field is intended for human consumption)
generalInfo [8] SEQUENCE SIZE (1..MAX) OF
InfoTypeAndValue OPTIONAL
-- this may be used to convey context-specific information
-- (this field not primarily intended for human consumption)
}
@return a basic ASN.1 object representation.
Creates a new PkiMessage.
@param header message header
@param body message body
@param protection message protection (may be null)
@param extraCerts extra certificates (may be null)
PkiMessage ::= SEQUENCE {
header PKIHeader,
body PKIBody,
protection [0] PKIProtection OPTIONAL,
extraCerts [1] SEQUENCE SIZE (1..MAX) OF CMPCertificate
OPTIONAL
}
@return a basic ASN.1 object representation.
PkiMessages ::= SEQUENCE SIZE (1..MAX) OF PkiMessage
@return a basic ASN.1 object representation.
@param status
@param status
@param statusString
PkiStatusInfo ::= SEQUENCE {
status PKIStatus, (INTEGER)
statusString PkiFreeText OPTIONAL,
failInfo PkiFailureInfo OPTIONAL (BIT STRING)
}
PKIStatus:
granted (0), -- you got exactly what you asked for
grantedWithMods (1), -- you got something like what you asked for
rejection (2), -- you don't get it, more information elsewhere in the message
waiting (3), -- the request body part has not yet been processed, expect to hear more later
revocationWarning (4), -- this message contains a warning that a revocation is imminent
revocationNotification (5), -- notification that a revocation has occurred
keyUpdateWarning (6) -- update already done for the oldCertId specified in CertReqMsg
PkiFailureInfo:
badAlg (0), -- unrecognized or unsupported Algorithm Identifier
badMessageCheck (1), -- integrity check failed (e.g., signature did not verify)
badRequest (2), -- transaction not permitted or supported
badTime (3), -- messageTime was not sufficiently close to the system time, as defined by local policy
badCertId (4), -- no certificate could be found matching the provided criteria
badDataFormat (5), -- the data submitted has the wrong format
wrongAuthority (6), -- the authority indicated in the request is different from the one creating the response token
incorrectData (7), -- the requester's data is incorrect (for notary services)
missingTimeStamp (8), -- when the timestamp is missing but should be there (by policy)
badPOP (9) -- the proof-of-possession failed
PollRepContent ::= SEQUENCE OF SEQUENCE {
certReqId INTEGER,
checkAfter INTEGER, -- time in seconds
reason PKIFreeText OPTIONAL
}
@return a basic ASN.1 object representation.
PollReqContent ::= SEQUENCE OF SEQUENCE {
certReqId INTEGER
}
@return a basic ASN.1 object representation.
PopoDecKeyChallContent ::= SEQUENCE OF Challenge
@return a basic ASN.1 object representation.
PopoDecKeyRespContent ::= SEQUENCE OF INTEGER
@return a basic ASN.1 object representation.
ProtectedPart ::= SEQUENCE {
header PKIHeader,
body PKIBody
}
@return a basic ASN.1 object representation.
RevAnnContent ::= SEQUENCE {
status PKIStatus,
certId CertId,
willBeRevokedAt GeneralizedTime,
badSinceDate GeneralizedTime,
crlDetails Extensions OPTIONAL
-- extra CRL details (e.g., crl number, reason, location, etc.)
}
@return a basic ASN.1 object representation.
RevDetails ::= SEQUENCE {
certDetails CertTemplate,
-- allows requester to specify as much as they can about
-- the cert. for which revocation is requested
-- (e.g., for cases in which serialNumber is not available)
crlEntryDetails Extensions OPTIONAL
-- requested crlEntryExtensions
}
@return a basic ASN.1 object representation.
RevRepContent ::= SEQUENCE {
status SEQUENCE SIZE (1..MAX) OF PKIStatusInfo,
-- in same order as was sent in RevReqContent
revCerts [0] SEQUENCE SIZE (1..MAX) OF CertId OPTIONAL,
-- IDs for which revocation was requested
-- (same order as status)
crls [1] SEQUENCE SIZE (1..MAX) OF CertificateList OPTIONAL
-- the resulting CRLs (there may be more than one)
}
@return a basic ASN.1 object representation.
RevReqContent ::= SEQUENCE OF RevDetails
@return a basic ASN.1 object representation.
return an Attribute object from the given object.
@param o the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
Attribute ::= SEQUENCE {
attrType OBJECT IDENTIFIER,
attrValues SET OF AttributeValue
}
Attributes ::=
SET SIZE(1..MAX) OF Attribute -- according to RFC 5652
@return
Return the first attribute matching the given OBJECT IDENTIFIER
Return all the attributes matching the OBJECT IDENTIFIER oid. The vector will be
empty if there are no attributes of the required type present.
@param oid type of attribute required.
@return a vector of all the attributes found of type oid.
Return a new table with the passed in attribute added.
@param attrType
@param attrValue
@return
return an AuthenticatedData object from a tagged object.
@param obj the tagged object holding the object we want.
@param isExplicit true if the object is meant to be explicitly
tagged false otherwise.
@throws ArgumentException if the object held by the
tagged object cannot be converted.
return an AuthenticatedData object from the given object.
@param obj the object we want converted.
@throws ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
AuthenticatedData ::= SEQUENCE {
version CMSVersion,
originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
recipientInfos RecipientInfos,
macAlgorithm MessageAuthenticationCodeAlgorithm,
digestAlgorithm [1] DigestAlgorithmIdentifier OPTIONAL,
encapContentInfo EncapsulatedContentInfo,
authAttrs [2] IMPLICIT AuthAttributes OPTIONAL,
mac MessageAuthenticationCode,
unauthAttrs [3] IMPLICIT UnauthAttributes OPTIONAL }
AuthAttributes ::= SET SIZE (1..MAX) OF Attribute
UnauthAttributes ::= SET SIZE (1..MAX) OF Attribute
MessageAuthenticationCode ::= OCTET STRING
Produce an object suitable for an Asn1OutputStream.
AuthenticatedData ::= SEQUENCE {
version CMSVersion,
originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
recipientInfos RecipientInfos,
macAlgorithm MessageAuthenticationCodeAlgorithm,
digestAlgorithm [1] DigestAlgorithmIdentifier OPTIONAL,
encapContentInfo EncapsulatedContentInfo,
authAttrs [2] IMPLICIT AuthAttributes OPTIONAL,
mac MessageAuthenticationCode,
unauthAttrs [3] IMPLICIT UnauthAttributes OPTIONAL }
AuthAttributes ::= SET SIZE (1..MAX) OF Attribute
UnauthAttributes ::= SET SIZE (1..MAX) OF Attribute
MessageAuthenticationCode ::= OCTET STRING
return an AuthEnvelopedData object from a tagged object.
@param obj the tagged object holding the object we want.
@param isExplicit true if the object is meant to be explicitly
tagged false otherwise.
@throws ArgumentException if the object held by the
tagged object cannot be converted.
return an AuthEnvelopedData object from the given object.
@param obj the object we want converted.
@throws ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
AuthEnvelopedData ::= SEQUENCE {
version CMSVersion,
originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
recipientInfos RecipientInfos,
authEncryptedContentInfo EncryptedContentInfo,
authAttrs [1] IMPLICIT AuthAttributes OPTIONAL,
mac MessageAuthenticationCode,
unauthAttrs [2] IMPLICIT UnauthAttributes OPTIONAL }
Produce an object suitable for an Asn1OutputStream.
AuthEnvelopedData ::= SEQUENCE {
version CMSVersion,
originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
recipientInfos RecipientInfos,
authEncryptedContentInfo EncryptedContentInfo,
authAttrs [1] IMPLICIT AuthAttributes OPTIONAL,
mac MessageAuthenticationCode,
unauthAttrs [2] IMPLICIT UnauthAttributes OPTIONAL }
From RFC 6211
CMSAlgorithmProtection ::= SEQUENCE {
digestAlgorithm DigestAlgorithmIdentifier,
signatureAlgorithm [1] SignatureAlgorithmIdentifier OPTIONAL,
macAlgorithm [2] MessageAuthenticationCodeAlgorithm
OPTIONAL
}
(WITH COMPONENTS { signatureAlgorithm PRESENT,
macAlgorithm ABSENT } |
WITH COMPONENTS { signatureAlgorithm ABSENT,
macAlgorithm PRESENT })
The other Revocation Info arc
id-ri OBJECT IDENTIFIER ::= { iso(1) identified-organization(3)
dod(6) internet(1) security(5) mechanisms(5) pkix(7) ri(16) }
RFC 3274 - CMS Compressed Data.
CompressedData ::= Sequence {
version CMSVersion,
compressionAlgorithm CompressionAlgorithmIdentifier,
encapContentInfo EncapsulatedContentInfo
}
return a CompressedData object from a tagged object.
@param ato the tagged object holding the object we want.
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the object held by the
tagged object cannot be converted.
return a CompressedData object from the given object.
@param _obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
RFC 3274 - CMS Compressed Data.
CompressedData ::= SEQUENCE {
version CMSVersion,
compressionAlgorithm CompressionAlgorithmIdentifier,
encapContentInfo EncapsulatedContentInfo
}
Produce an object suitable for an Asn1OutputStream.
ContentInfo ::= Sequence {
contentType ContentType,
content
[0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
Produce an object suitable for an Asn1OutputStream.
ContentInfo ::= SEQUENCE {
contentType ContentType,
content
[0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
return an AuthEnvelopedData object from a tagged object.
@param obj the tagged object holding the object we want.
@param isExplicit true if the object is meant to be explicitly
tagged false otherwise.
@throws ArgumentException if the object held by the
tagged object cannot be converted.
return an AuthEnvelopedData object from the given object.
@param obj the object we want converted.
@throws ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
MQVuserKeyingMaterial ::= SEQUENCE {
ephemeralPublicKey OriginatorPublicKey,
addedukm [0] EXPLICIT UserKeyingMaterial OPTIONAL }
return an EncryptedContentInfo object from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
EncryptedContentInfo ::= Sequence {
contentType ContentType,
contentEncryptionAlgorithm ContentEncryptionAlgorithmIdentifier,
encryptedContent [0] IMPLICIT EncryptedContent OPTIONAL
}
EncryptedContentInfo ::= SEQUENCE {
contentType ContentType,
contentEncryptionAlgorithm ContentEncryptionAlgorithmIdentifier,
encryptedContent [0] IMPLICIT EncryptedContent OPTIONAL
}
EncryptedData ::= SEQUENCE {
version CMSVersion,
encryptedContentInfo EncryptedContentInfo,
unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL }
@return a basic ASN.1 object representation.
return an EnvelopedData object from a tagged object.
@param obj the tagged object holding the object we want.
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the object held by the
tagged object cannot be converted.
return an EnvelopedData object from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
EnvelopedData ::= Sequence {
version CMSVersion,
originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
recipientInfos RecipientInfos,
encryptedContentInfo EncryptedContentInfo,
unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL
}
Produce an object suitable for an Asn1OutputStream.
EnvelopedData ::= SEQUENCE {
version CMSVersion,
originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
recipientInfos RecipientInfos,
encryptedContentInfo EncryptedContentInfo,
unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL
}
return a KekIdentifier object from a tagged object.
@param obj the tagged object holding the object we want.
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the object held by the
tagged object cannot be converted.
return a KekIdentifier object from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
KekIdentifier ::= Sequence {
keyIdentifier OCTET STRING,
date GeneralizedTime OPTIONAL,
other OtherKeyAttribute OPTIONAL
}
return a KekRecipientInfo object from a tagged object.
@param obj the tagged object holding the object we want.
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the object held by the
tagged object cannot be converted.
return a KekRecipientInfo object from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
KekRecipientInfo ::= Sequence {
version CMSVersion, -- always set to 4
kekID KekIdentifier,
keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
encryptedKey EncryptedKey
}
return an KeyAgreeRecipientIdentifier object from a tagged object.
@param obj the tagged object holding the object we want.
@param isExplicit true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the object held by the
tagged object cannot be converted.
return an KeyAgreeRecipientIdentifier object from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
KeyAgreeRecipientIdentifier ::= CHOICE {
issuerAndSerialNumber IssuerAndSerialNumber,
rKeyId [0] IMPLICIT RecipientKeyIdentifier
}
return a KeyAgreeRecipientInfo object from a tagged object.
@param obj the tagged object holding the object we want.
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the object held by the
tagged object cannot be converted.
return a KeyAgreeRecipientInfo object from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
* Produce an object suitable for an Asn1OutputStream.
*
* KeyAgreeRecipientInfo ::= Sequence {
* version CMSVersion, -- always set to 3
* originator [0] EXPLICIT OriginatorIdentifierOrKey,
* ukm [1] EXPLICIT UserKeyingMaterial OPTIONAL,
* keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
* recipientEncryptedKeys RecipientEncryptedKeys
* }
*
* UserKeyingMaterial ::= OCTET STRING
*
return a KeyTransRecipientInfo object from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
KeyTransRecipientInfo ::= Sequence {
version CMSVersion, -- always set to 0 or 2
rid RecipientIdentifier,
keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
encryptedKey EncryptedKey
}
MetaData ::= SEQUENCE {
hashProtected BOOLEAN,
fileName UTF8String OPTIONAL,
mediaType IA5String OPTIONAL,
otherMetaData Attributes OPTIONAL
}
@return
return an OriginatorIdentifierOrKey object from a tagged object.
@param o the tagged object holding the object we want.
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the object held by the
tagged object cannot be converted.
return an OriginatorIdentifierOrKey object from the given object.
@param o the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
OriginatorIdentifierOrKey ::= CHOICE {
issuerAndSerialNumber IssuerAndSerialNumber,
subjectKeyIdentifier [0] SubjectKeyIdentifier,
originatorKey [1] OriginatorPublicKey
}
SubjectKeyIdentifier ::= OCTET STRING
return an OriginatorInfo object from a tagged object.
@param obj the tagged object holding the object we want.
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the object held by the
tagged object cannot be converted.
return an OriginatorInfo object from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
OriginatorInfo ::= Sequence {
certs [0] IMPLICIT CertificateSet OPTIONAL,
crls [1] IMPLICIT CertificateRevocationLists OPTIONAL
}
return an OriginatorPublicKey object from a tagged object.
@param obj the tagged object holding the object we want.
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the object held by the
tagged object cannot be converted.
return an OriginatorPublicKey object from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
OriginatorPublicKey ::= Sequence {
algorithm AlgorithmIdentifier,
publicKey BIT STRING
}
return an OtherKeyAttribute object from the given object.
@param o the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
OtherKeyAttribute ::= Sequence {
keyAttrId OBJECT IDENTIFIER,
keyAttr ANY DEFINED BY keyAttrId OPTIONAL
}
return a OtherRecipientInfo object from a tagged object.
@param obj the tagged object holding the object we want.
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the object held by the
tagged object cannot be converted.
return a OtherRecipientInfo object from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
OtherRecipientInfo ::= Sequence {
oriType OBJECT IDENTIFIER,
oriValue ANY DEFINED BY oriType }
return a OtherRevocationInfoFormat object from a tagged object.
@param obj the tagged object holding the object we want.
@param explicit true if the object is meant to be explicitly
tagged false otherwise.
@exception IllegalArgumentException if the object held by the
tagged object cannot be converted.
return a OtherRevocationInfoFormat object from the given object.
@param obj the object we want converted.
@exception IllegalArgumentException if the object cannot be converted.
Produce an object suitable for an ASN1OutputStream.
OtherRevocationInfoFormat ::= SEQUENCE {
otherRevInfoFormat OBJECT IDENTIFIER,
otherRevInfo ANY DEFINED BY otherRevInfoFormat }
return a PasswordRecipientInfo object from a tagged object.
@param obj the tagged object holding the object we want.
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the object held by the
tagged object cannot be converted.
return a PasswordRecipientInfo object from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
PasswordRecipientInfo ::= Sequence {
version CMSVersion, -- Always set to 0
keyDerivationAlgorithm [0] KeyDerivationAlgorithmIdentifier
OPTIONAL,
keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
encryptedKey EncryptedKey }
return an RecipientEncryptedKey object from a tagged object.
@param obj the tagged object holding the object we want.
@param isExplicit true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the object held by the
tagged object cannot be converted.
return a RecipientEncryptedKey object from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
RecipientEncryptedKey ::= SEQUENCE {
rid KeyAgreeRecipientIdentifier,
encryptedKey EncryptedKey
}
return a RecipientIdentifier object from the given object.
@param o the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
RecipientIdentifier ::= CHOICE {
issuerAndSerialNumber IssuerAndSerialNumber,
subjectKeyIdentifier [0] SubjectKeyIdentifier
}
SubjectKeyIdentifier ::= OCTET STRING
Produce an object suitable for an Asn1OutputStream.
RecipientInfo ::= CHOICE {
ktri KeyTransRecipientInfo,
kari [1] KeyAgreeRecipientInfo,
kekri [2] KekRecipientInfo,
pwri [3] PasswordRecipientInfo,
ori [4] OtherRecipientInfo }
return a RecipientKeyIdentifier object from a tagged object.
@param _ato the tagged object holding the object we want.
@param _explicit true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the object held by the
tagged object cannot be converted.
return a RecipientKeyIdentifier object from the given object.
@param _obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
RecipientKeyIdentifier ::= Sequence {
subjectKeyIdentifier SubjectKeyIdentifier,
date GeneralizedTime OPTIONAL,
other OtherKeyAttribute OPTIONAL
}
SubjectKeyIdentifier ::= OCTET STRING
ScvpReqRes ::= SEQUENCE {
request [0] EXPLICIT ContentInfo OPTIONAL,
response ContentInfo }
@return the ASN.1 primitive representation.
a signed data object.
Produce an object suitable for an Asn1OutputStream.
SignedData ::= Sequence {
version CMSVersion,
digestAlgorithms DigestAlgorithmIdentifiers,
encapContentInfo EncapsulatedContentInfo,
certificates [0] IMPLICIT CertificateSet OPTIONAL,
crls [1] IMPLICIT CertificateRevocationLists OPTIONAL,
signerInfos SignerInfos
}
SignedData ::= SEQUENCE {
version CMSVersion,
digestAlgorithms DigestAlgorithmIdentifiers,
encapContentInfo EncapsulatedContentInfo,
certificates [0] IMPLICIT CertificateSet OPTIONAL,
crls [1] IMPLICIT CertificateRevocationLists OPTIONAL,
signerInfos SignerInfos
}
return a SignerIdentifier object from the given object.
@param o the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
SignerIdentifier ::= CHOICE {
issuerAndSerialNumber IssuerAndSerialNumber,
subjectKeyIdentifier [0] SubjectKeyIdentifier
}
SubjectKeyIdentifier ::= OCTET STRING
Produce an object suitable for an Asn1OutputStream.
SignerInfo ::= Sequence {
version Version,
SignerIdentifier sid,
digestAlgorithm DigestAlgorithmIdentifier,
authenticatedAttributes [0] IMPLICIT Attributes OPTIONAL,
digestEncryptionAlgorithm DigestEncryptionAlgorithmIdentifier,
encryptedDigest EncryptedDigest,
unauthenticatedAttributes [1] IMPLICIT Attributes OPTIONAL
}
EncryptedDigest ::= OCTET STRING
DigestAlgorithmIdentifier ::= AlgorithmIdentifier
DigestEncryptionAlgorithmIdentifier ::= AlgorithmIdentifier
creates a time object from a given date - if the date is between 1950
and 2049 a UTCTime object is Generated, otherwise a GeneralizedTime
is used.
Produce an object suitable for an Asn1OutputStream.
Time ::= CHOICE {
utcTime UTCTime,
generalTime GeneralizedTime }
TimeStampAndCRL ::= SEQUENCE {
timeStamp TimeStampToken, -- according to RFC 3161
crl CertificateList OPTIONAL -- according to RFC 5280
}
@return
TimeStampedData ::= SEQUENCE {
version INTEGER { v1(1) },
dataUri IA5String OPTIONAL,
metaData MetaData OPTIONAL,
content OCTET STRING OPTIONAL,
temporalEvidence Evidence
}
@return
TimeStampTokenEvidence ::=
SEQUENCE SIZE(1..MAX) OF TimeStampAndCrl
@return
AttributeTypeAndValue ::= SEQUENCE {
type OBJECT IDENTIFIER,
value ANY DEFINED BY type }
@return a basic ASN.1 object representation.
CertId ::= SEQUENCE {
issuer GeneralName,
serialNumber INTEGER }
@return a basic ASN.1 object representation.
CertReqMessages ::= SEQUENCE SIZE (1..MAX) OF CertReqMsg
@return a basic ASN.1 object representation.
Creates a new CertReqMsg.
@param certReq CertRequest
@param popo may be null
@param regInfo may be null
CertReqMsg ::= SEQUENCE {
certReq CertRequest,
pop ProofOfPossession OPTIONAL,
-- content depends upon key type
regInfo SEQUENCE SIZE(1..MAX) OF AttributeTypeAndValue OPTIONAL }
@return a basic ASN.1 object representation.
CertRequest ::= SEQUENCE {
certReqId INTEGER, -- ID for matching request and reply
certTemplate CertTemplate, -- Selected fields of cert to be issued
controls Controls OPTIONAL } -- Attributes affecting issuance
@return a basic ASN.1 object representation.
CertTemplate ::= SEQUENCE {
version [0] Version OPTIONAL,
serialNumber [1] INTEGER OPTIONAL,
signingAlg [2] AlgorithmIdentifier OPTIONAL,
issuer [3] Name OPTIONAL,
validity [4] OptionalValidity OPTIONAL,
subject [5] Name OPTIONAL,
publicKey [6] SubjectPublicKeyInfo OPTIONAL,
issuerUID [7] UniqueIdentifier OPTIONAL,
subjectUID [8] UniqueIdentifier OPTIONAL,
extensions [9] Extensions OPTIONAL }
@return a basic ASN.1 object representation.
Sets the X.509 version. Note: for X509v3, use 2 here.
Sets the issuer unique ID (deprecated in X.509v3)
Sets the subject unique ID (deprecated in X.509v3)
CertTemplate ::= SEQUENCE {
version [0] Version OPTIONAL,
serialNumber [1] INTEGER OPTIONAL,
signingAlg [2] AlgorithmIdentifier OPTIONAL,
issuer [3] Name OPTIONAL,
validity [4] OptionalValidity OPTIONAL,
subject [5] Name OPTIONAL,
publicKey [6] SubjectPublicKeyInfo OPTIONAL,
issuerUID [7] UniqueIdentifier OPTIONAL,
subjectUID [8] UniqueIdentifier OPTIONAL,
extensions [9] Extensions OPTIONAL }
@return a basic ASN.1 object representation.
Controls ::= SEQUENCE SIZE(1..MAX) OF AttributeTypeAndValue
@return a basic ASN.1 object representation.
EncKeyWithID ::= SEQUENCE {
privateKey PrivateKeyInfo,
identifier CHOICE {
string UTF8String,
generalName GeneralName
} OPTIONAL
}
@return
EncryptedKey ::= CHOICE {
encryptedValue EncryptedValue, -- deprecated
envelopedData [0] EnvelopedData }
-- The encrypted private key MUST be placed in the envelopedData
-- encryptedContentInfo encryptedContent OCTET STRING.
EncryptedValue ::= SEQUENCE {
intendedAlg [0] AlgorithmIdentifier OPTIONAL,
-- the intended algorithm for which the value will be used
symmAlg [1] AlgorithmIdentifier OPTIONAL,
-- the symmetric algorithm used to encrypt the value
encSymmKey [2] BIT STRING OPTIONAL,
-- the (encrypted) symmetric key used to encrypt the value
keyAlg [3] AlgorithmIdentifier OPTIONAL,
-- algorithm used to encrypt the symmetric key
valueHint [4] OCTET STRING OPTIONAL,
-- a brief description or identifier of the encValue content
-- (may be meaningful only to the sending entity, and used only
-- if EncryptedValue might be re-examined by the sending entity
-- in the future)
encValue BIT STRING }
-- the encrypted value itself
@return a basic ASN.1 object representation.
OptionalValidity ::= SEQUENCE {
notBefore [0] Time OPTIONAL,
notAfter [1] Time OPTIONAL } --at least one MUST be present
@return a basic ASN.1 object representation.
PkiArchiveOptions ::= CHOICE {
encryptedPrivKey [0] EncryptedKey,
-- the actual value of the private key
keyGenParameters [1] KeyGenParameters,
-- parameters which allow the private key to be re-generated
archiveRemGenPrivKey [2] BOOLEAN }
-- set to TRUE if sender wishes receiver to archive the private
-- key of a key pair that the receiver generates in response to
-- this request; set to FALSE if no archival is desired.
PkiPublicationInfo ::= SEQUENCE {
action INTEGER {
dontPublish (0),
pleasePublish (1) },
pubInfos SEQUENCE SIZE (1..MAX) OF SinglePubInfo OPTIONAL }
-- pubInfos MUST NOT be present if action is "dontPublish"
-- (if action is "pleasePublish" and pubInfos is omitted,
-- "dontCare" is assumed)
@return a basic ASN.1 object representation.
Password-based MAC value for use with POPOSigningKeyInput.
Creates a new PKMACValue.
@param params parameters for password-based MAC
@param value MAC of the DER-encoded SubjectPublicKeyInfo
Creates a new PKMACValue.
@param aid CMPObjectIdentifiers.passwordBasedMAC, with PBMParameter
@param value MAC of the DER-encoded SubjectPublicKeyInfo
PKMACValue ::= SEQUENCE {
algId AlgorithmIdentifier,
-- algorithm value shall be PasswordBasedMac 1.2.840.113533.7.66.13
-- parameter value is PBMParameter
value BIT STRING }
@return a basic ASN.1 object representation.
PopoPrivKey ::= CHOICE {
thisMessage [0] BIT STRING, -- Deprecated
-- possession is proven in this message (which contains the private
-- key itself (encrypted for the CA))
subsequentMessage [1] SubsequentMessage,
-- possession will be proven in a subsequent message
dhMAC [2] BIT STRING, -- Deprecated
agreeMAC [3] PKMACValue,
encryptedKey [4] EnvelopedData }
Creates a new Proof of Possession object for a signing key.
@param poposkIn the PopoSigningKeyInput structure, or null if the
CertTemplate includes both subject and publicKey values.
@param aid the AlgorithmIdentifier used to sign the proof of possession.
@param signature a signature over the DER-encoded value of poposkIn,
or the DER-encoded value of certReq if poposkIn is null.
PopoSigningKey ::= SEQUENCE {
poposkInput [0] PopoSigningKeyInput OPTIONAL,
algorithmIdentifier AlgorithmIdentifier,
signature BIT STRING }
-- The signature (using "algorithmIdentifier") is on the
-- DER-encoded value of poposkInput. NOTE: If the CertReqMsg
-- certReq CertTemplate contains the subject and publicKey values,
-- then poposkInput MUST be omitted and the signature MUST be
-- computed on the DER-encoded value of CertReqMsg certReq. If
-- the CertReqMsg certReq CertTemplate does not contain the public
-- key and subject values, then poposkInput MUST be present and
-- MUST be signed. This strategy ensures that the public key is
-- not present in both the poposkInput and CertReqMsg certReq
-- CertTemplate fields.
@return a basic ASN.1 object representation.
Creates a new PopoSigningKeyInput with sender name as authInfo.
Creates a new PopoSigningKeyInput using password-based MAC.
Returns the sender field, or null if authInfo is publicKeyMac
Returns the publicKeyMac field, or null if authInfo is sender
PopoSigningKeyInput ::= SEQUENCE {
authInfo CHOICE {
sender [0] GeneralName,
-- used only if an authenticated identity has been
-- established for the sender (e.g., a DN from a
-- previously-issued and currently-valid certificate
publicKeyMac PKMacValue },
-- used if no authenticated GeneralName currently exists for
-- the sender; publicKeyMac contains a password-based MAC
-- on the DER-encoded value of publicKey
publicKey SubjectPublicKeyInfo } -- from CertTemplate
@return a basic ASN.1 object representation.
Creates a ProofOfPossession with type raVerified.
Creates a ProofOfPossession for a signing key.
Creates a ProofOfPossession for key encipherment or agreement.
@param type one of TYPE_KEY_ENCIPHERMENT or TYPE_KEY_AGREEMENT
ProofOfPossession ::= CHOICE {
raVerified [0] NULL,
-- used if the RA has already verified that the requester is in
-- possession of the private key
signature [1] PopoSigningKey,
keyEncipherment [2] PopoPrivKey,
keyAgreement [3] PopoPrivKey }
@return a basic ASN.1 object representation.
SinglePubInfo ::= SEQUENCE {
pubMethod INTEGER {
dontCare (0),
x500 (1),
web (2),
ldap (3) },
pubLocation GeneralName OPTIONAL }
@return a basic ASN.1 object representation.
Table of the available named parameters for GOST 3410-2001 / 2012.
return the ECDomainParameters object for the given OID, null if it
isn't present.
@param oid an object identifier representing a named parameters, if present.
returns an enumeration containing the name strings for curves
contained in this structure.
return the named curve name represented by the given object identifier.
Gost28147-89-Parameters ::=
SEQUENCE {
iv Gost28147-89-IV,
encryptionParamSet OBJECT IDENTIFIER
}
Gost28147-89-IV ::= OCTET STRING (SIZE (8))
table of the available named parameters for GOST 3410-94.
return the GOST3410ParamSetParameters object for the given OID, null if it
isn't present.
@param oid an object identifier representing a named parameters, if present.
returns an enumeration containing the name strings for parameters
contained in this structure.
Base class for an application specific object
Return the enclosed object assuming explicit tagging.
@return the resulting object
@throws IOException if reconstruction fails.
Return the enclosed object assuming implicit tagging.
@param derTagNo the type tag that should be applied to the object's contents.
@return the resulting object
@throws IOException if reconstruction fails.
return a Bit string from the passed in object
@exception ArgumentException if the object cannot be converted.
return a Bit string from a tagged object.
@param obj the tagged object holding the object we want
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
@param data the octets making up the bit string.
@param padBits the number of extra bits at the end of the string.
Return the octets contained in this BIT STRING, checking that this BIT STRING really
does represent an octet aligned string. Only use this method when the standard you are
following dictates that the BIT STRING will be octet aligned.
@return a copy of the octet aligned data.
@return the value of the bit string as an int (truncating if necessary)
Der BMPString object.
return a BMP string from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
return a BMP string from a tagged object.
@param obj the tagged object holding the object we want
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
basic constructor - byte encoded string.
basic constructor
return a bool from the passed in object.
@exception ArgumentException if the object cannot be converted.
return a DerBoolean from the passed in bool.
return a Boolean from a tagged object.
@param obj the tagged object holding the object we want
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
return an integer from the passed in object
@exception ArgumentException if the object cannot be converted.
return an Enumerated from a tagged object.
@param obj the tagged object holding the object we want
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
Class representing the DER-type External
Creates a new instance of DerExternal
See X.690 for more informations about the meaning of these parameters
@param directReference The direct reference or null if not set.
@param indirectReference The indirect reference or null if not set.
@param dataValueDescriptor The data value descriptor or null if not set.
@param externalData The external data in its encoded form.
Creates a new instance of DerExternal.
See X.690 for more informations about the meaning of these parameters
@param directReference The direct reference or null if not set.
@param indirectReference The indirect reference or null if not set.
@param dataValueDescriptor The data value descriptor or null if not set.
@param encoding The encoding to be used for the external data
@param externalData The external data
The encoding of the content. Valid values are
0 single-ASN1-type1 OCTET STRING2 BIT STRING
Generalized time object.
return a generalized time from the passed in object
@exception ArgumentException if the object cannot be converted.
return a Generalized Time object from a tagged object.
@param obj the tagged object holding the object we want
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
The correct format for this is YYYYMMDDHHMMSS[.f]Z, or without the Z
for local time, or Z+-HHMM on the end, for difference between local
time and UTC time. The fractional second amount f must consist of at
least one number with trailing zeroes removed.
@param time the time string.
@exception ArgumentException if string is an illegal format.
base constructor from a local time object
Return the time.
@return The time string as it appeared in the encoded object.
return the time - always in the form of
YYYYMMDDhhmmssGMT(+hh:mm|-hh:mm).
Normally in a certificate we would expect "Z" rather than "GMT",
however adding the "GMT" means we can just use:
dateF = new SimpleDateFormat("yyyyMMddHHmmssz");
To read in the time and Get a date which is compatible with our local
time zone.
return a Graphic String from the passed in object
@param obj a DerGraphicString or an object that can be converted into one.
@exception IllegalArgumentException if the object cannot be converted.
@return a DerGraphicString instance, or null.
return a Graphic String from a tagged object.
@param obj the tagged object holding the object we want
@param explicit true if the object is meant to be explicitly
tagged false otherwise.
@exception IllegalArgumentException if the tagged object cannot
be converted.
@return a DerGraphicString instance, or null.
basic constructor - with bytes.
@param string the byte encoding of the characters making up the string.
Der IA5String object - this is an ascii string.
return a IA5 string from the passed in object
@exception ArgumentException if the object cannot be converted.
return an IA5 string from a tagged object.
@param obj the tagged object holding the object we want
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
basic constructor - with bytes.
basic constructor - without validation.
Constructor with optional validation.
@param string the base string to wrap.
@param validate whether or not to check the string.
@throws ArgumentException if validate is true and the string
contains characters that should not be in an IA5String.
return true if the passed in String can be represented without
loss as an IA5String, false otherwise.
@return true if in printable set, false otherwise.
return an integer from the passed in object
@exception ArgumentException if the object cannot be converted.
return an Integer from a tagged object.
@param obj the tagged object holding the object we want
@param isExplicit true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
in some cases positive values Get crammed into a space,
that's not quite big enough...
Apply the correct validation for an INTEGER primitive following the BER rules.
@param bytes The raw encoding of the integer.
@return true if the (in)put fails this validation.
A Null object.
Der NumericString object - this is an ascii string of characters {0,1,2,3,4,5,6,7,8,9, }.
return a Numeric string from the passed in object
@exception ArgumentException if the object cannot be converted.
return an Numeric string from a tagged object.
@param obj the tagged object holding the object we want
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
basic constructor - with bytes.
basic constructor - without validation..
Constructor with optional validation.
@param string the base string to wrap.
@param validate whether or not to check the string.
@throws ArgumentException if validate is true and the string
contains characters that should not be in a NumericString.
Return true if the string can be represented as a NumericString ('0'..'9', ' ')
@param str string to validate.
@return true if numeric, fale otherwise.
return an Oid from the passed in object
@exception ArgumentException if the object cannot be converted.
return an object Identifier from a tagged object.
@param obj the tagged object holding the object we want
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
Return true if this oid is an extension of the passed in branch, stem.
@param stem the arc or branch that is a possible parent.
@return true if the branch is on the passed in stem, false otherwise.
Intern will return a reference to a pooled version of this object, unless it
is not present in which case intern will add it.
The pool is also used by the ASN.1 parsers to limit the number of duplicated OID
objects in circulation.
@return a reference to the identifier in the pool.
The octets making up the octet string.
Der PrintableString object.
return a printable string from the passed in object.
@exception ArgumentException if the object cannot be converted.
return a Printable string from a tagged object.
@param obj the tagged object holding the object we want
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
basic constructor - byte encoded string.
basic constructor - this does not validate the string
Constructor with optional validation.
@param string the base string to wrap.
@param validate whether or not to check the string.
@throws ArgumentException if validate is true and the string
contains characters that should not be in a PrintableString.
return true if the passed in String can be represented without
loss as a PrintableString, false otherwise.
@return true if in printable set, false otherwise.
create an empty sequence
create a sequence containing one object
create a sequence containing a vector of objects.
A Der encoded set object
create an empty set
@param obj - a single object that makes up the set.
@param v - a vector of objects making up the set.
Der T61String (also the teletex string) - 8-bit characters
return a T61 string from the passed in object.
@exception ArgumentException if the object cannot be converted.
return an T61 string from a tagged object.
@param obj the tagged object holding the object we want
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
basic constructor - with bytes.
basic constructor - with string.
DER TaggedObject - in ASN.1 notation this is any object preceded by
a [n] where n is some number - these are assumed to follow the construction
rules (as with sequences).
@param tagNo the tag number for this object.
@param obj the tagged object.
@param explicitly true if an explicitly tagged object.
@param tagNo the tag number for this object.
@param obj the tagged object.
create an implicitly tagged object that contains a zero
length sequence.
Der UniversalString object.
return a Universal string from the passed in object.
@exception ArgumentException if the object cannot be converted.
return a Universal string from a tagged object.
@param obj the tagged object holding the object we want
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
basic constructor - byte encoded string.
UTC time object.
return an UTC Time from the passed in object.
@exception ArgumentException if the object cannot be converted.
return an UTC Time from a tagged object.
@param obj the tagged object holding the object we want
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
The correct format for this is YYMMDDHHMMSSZ (it used to be that seconds were
never encoded. When you're creating one of these objects from scratch, that's
what you want to use, otherwise we'll try to deal with whatever Gets read from
the input stream... (this is why the input format is different from the GetTime()
method output).
@param time the time string.
base constructor from a DateTime object
return the time as a date based on whatever a 2 digit year will return. For
standardised processing use ToAdjustedDateTime().
@return the resulting date
@exception ParseException if the date string cannot be parsed.
return the time as an adjusted date
in the range of 1950 - 2049.
@return a date in the range of 1950 to 2049.
@exception ParseException if the date string cannot be parsed.
return the time - always in the form of
YYMMDDhhmmssGMT(+hh:mm|-hh:mm).
Normally in a certificate we would expect "Z" rather than "GMT",
however adding the "GMT" means we can just use:
dateF = new SimpleDateFormat("yyMMddHHmmssz");
To read in the time and Get a date which is compatible with our local
time zone.
Note: In some cases, due to the local date processing, this
may lead to unexpected results. If you want to stick the normal
convention of 1950 to 2049 use the GetAdjustedTime() method.
Return a time string as an adjusted date with a 4 digit year.
This goes in the range of 1950 - 2049.
Der UTF8String object.
return an UTF8 string from the passed in object.
@exception ArgumentException if the object cannot be converted.
return an UTF8 string from a tagged object.
@param obj the tagged object holding the object we want
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
basic constructor - byte encoded string.
basic constructor
return a Videotex String from the passed in object
@param obj a DERVideotexString or an object that can be converted into one.
@exception IllegalArgumentException if the object cannot be converted.
@return a DERVideotexString instance, or null.
return a Videotex String from a tagged object.
@param obj the tagged object holding the object we want
@param explicit true if the object is meant to be explicitly
tagged false otherwise.
@exception IllegalArgumentException if the tagged object cannot
be converted.
@return a DERVideotexString instance, or null.
basic constructor - with bytes.
@param string the byte encoding of the characters making up the string.
Der VisibleString object.
return a Visible string from the passed in object.
@exception ArgumentException if the object cannot be converted.
return a Visible string from a tagged object.
@param obj the tagged object holding the object we want
@param explicitly true if the object is meant to be explicitly
tagged false otherwise.
@exception ArgumentException if the tagged object cannot
be converted.
basic constructor - byte encoded string.
basic constructor
Edwards Elliptic Curve Object Identifiers (RFC 8410)
RFC 3126: 4.3.1 Certificate Values Attribute Definition
CertificateValues ::= SEQUENCE OF Certificate
CommitmentTypeIndication ::= SEQUENCE {
commitmentTypeId CommitmentTypeIdentifier,
commitmentTypeQualifier SEQUENCE SIZE (1..MAX) OF
CommitmentTypeQualifier OPTIONAL }
Commitment type qualifiers, used in the Commitment-Type-Indication attribute (RFC3126).
CommitmentTypeQualifier ::= SEQUENCE {
commitmentTypeIdentifier CommitmentTypeIdentifier,
qualifier ANY DEFINED BY commitmentTypeIdentifier OPTIONAL }
Creates a new CommitmentTypeQualifier instance.
@param commitmentTypeIdentifier a CommitmentTypeIdentifier value
Creates a new CommitmentTypeQualifier instance.
@param commitmentTypeIdentifier a CommitmentTypeIdentifier value
@param qualifier the qualifier, defined by the above field.
Creates a new CommitmentTypeQualifier instance.
@param as CommitmentTypeQualifier structure
encoded as an Asn1Sequence.
Returns a DER-encodable representation of this instance.
@return a Asn1Object value
RFC 3126: 4.2.1 Complete Certificate Refs Attribute Definition
CompleteCertificateRefs ::= SEQUENCE OF OtherCertID
RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition
CompleteRevocationRefs ::= SEQUENCE OF CrlOcspRef
RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition
CrlIdentifier ::= SEQUENCE
{
crlissuer Name,
crlIssuedTime UTCTime,
crlNumber INTEGER OPTIONAL
}
RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition
CRLListID ::= SEQUENCE
{
crls SEQUENCE OF CrlValidatedID
}
RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition
CrlOcspRef ::= SEQUENCE {
crlids [0] CRLListID OPTIONAL,
ocspids [1] OcspListID OPTIONAL,
otherRev [2] OtherRevRefs OPTIONAL
}
RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition
CrlValidatedID ::= SEQUENCE {
crlHash OtherHash,
crlIdentifier CrlIdentifier OPTIONAL}
RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition
OcspIdentifier ::= SEQUENCE {
ocspResponderID ResponderID,
-- As in OCSP response data
producedAt GeneralizedTime
-- As in OCSP response data
}
RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition
OcspListID ::= SEQUENCE {
ocspResponses SEQUENCE OF OcspResponsesID
}
RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition
OcspResponsesID ::= SEQUENCE {
ocspIdentifier OcspIdentifier,
ocspRepHash OtherHash OPTIONAL
}
OtherCertID ::= SEQUENCE {
otherCertHash OtherHash,
issuerSerial IssuerSerial OPTIONAL
}
OtherHash ::= CHOICE {
sha1Hash OtherHashValue, -- This contains a SHA-1 hash
otherHash OtherHashAlgAndValue
}
OtherHashValue ::= OCTET STRING
Summary description for OtherHashAlgAndValue.
OtherHashAlgAndValue ::= SEQUENCE {
hashAlgorithm AlgorithmIdentifier,
hashValue OtherHashValue
}
OtherHashValue ::= OCTET STRING
RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition
OtherRevRefs ::= SEQUENCE
{
otherRevRefType OtherRevRefType,
otherRevRefs ANY DEFINED BY otherRevRefType
}
OtherRevRefType ::= OBJECT IDENTIFIER
RFC 3126: 4.3.2 Revocation Values Attribute Definition
OtherRevVals ::= SEQUENCE
{
otherRevValType OtherRevValType,
otherRevVals ANY DEFINED BY otherRevValType
}
OtherRevValType ::= OBJECT IDENTIFIER
OtherSigningCertificate ::= SEQUENCE {
certs SEQUENCE OF OtherCertID,
policies SEQUENCE OF PolicyInformation OPTIONAL
}
RFC 5126: 6.3.4. revocation-values Attribute Definition
RevocationValues ::= SEQUENCE {
crlVals [0] SEQUENCE OF CertificateList OPTIONAL,
ocspVals [1] SEQUENCE OF BasicOCSPResponse OPTIONAL,
otherRevVals [2] OtherRevVals OPTIONAL
}
SignaturePolicyId ::= SEQUENCE {
sigPolicyIdentifier SigPolicyId,
sigPolicyHash SigPolicyHash,
sigPolicyQualifiers SEQUENCE SIZE (1..MAX) OF SigPolicyQualifierInfo OPTIONAL
}
SigPolicyId ::= OBJECT IDENTIFIER
SigPolicyHash ::= OtherHashAlgAndValue
SignaturePolicyIdentifier ::= CHOICE {
SignaturePolicyId SignaturePolicyId,
SignaturePolicyImplied SignaturePolicyImplied
}
SignaturePolicyImplied ::= NULL
SignerAttribute ::= SEQUENCE OF CHOICE {
claimedAttributes [0] ClaimedAttributes,
certifiedAttributes [1] CertifiedAttributes }
ClaimedAttributes ::= SEQUENCE OF Attribute
CertifiedAttributes ::= AttributeCertificate -- as defined in RFC 3281: see clause 4.1.
Signer-Location attribute (RFC3126).
SignerLocation ::= SEQUENCE {
countryName [0] DirectoryString OPTIONAL,
localityName [1] DirectoryString OPTIONAL,
postalAddress [2] PostalAddress OPTIONAL }
PostalAddress ::= SEQUENCE SIZE(1..6) OF DirectoryString
SignerLocation ::= SEQUENCE {
countryName [0] DirectoryString OPTIONAL,
localityName [1] DirectoryString OPTIONAL,
postalAddress [2] PostalAddress OPTIONAL }
PostalAddress ::= SEQUENCE SIZE(1..6) OF DirectoryString
DirectoryString ::= CHOICE {
teletexString TeletexString (SIZE (1..MAX)),
printableString PrintableString (SIZE (1..MAX)),
universalString UniversalString (SIZE (1..MAX)),
utf8String UTF8String (SIZE (1.. MAX)),
bmpString BMPString (SIZE (1..MAX)) }
SigPolicyQualifierInfo ::= SEQUENCE {
sigPolicyQualifierId SigPolicyQualifierId,
sigQualifier ANY DEFINED BY sigPolicyQualifierId
}
SigPolicyQualifierId ::= OBJECT IDENTIFIER
constructor
ContentHints ::= SEQUENCE {
contentDescription UTF8String (SIZE (1..MAX)) OPTIONAL,
contentType ContentType }
Create from OCTET STRING whose octets represent the identifier.
Create from byte array representing the identifier.
The definition of ContentIdentifier is
ContentIdentifier ::= OCTET STRING
id-aa-contentIdentifier OBJECT IDENTIFIER ::= { iso(1)
member-body(2) us(840) rsadsi(113549) pkcs(1) pkcs9(9)
smime(16) id-aa(2) 7 }
constructor
EssCertID ::= SEQUENCE {
certHash Hash,
issuerSerial IssuerSerial OPTIONAL }
EssCertIDv2 ::= SEQUENCE {
hashAlgorithm AlgorithmIdentifier
DEFAULT {algorithm id-sha256},
certHash Hash,
issuerSerial IssuerSerial OPTIONAL
}
Hash ::= OCTET STRING
IssuerSerial ::= SEQUENCE {
issuer GeneralNames,
serialNumber CertificateSerialNumber
}
constructors
The definition of SigningCertificate is
SigningCertificate ::= SEQUENCE {
certs SEQUENCE OF EssCertID,
policies SEQUENCE OF PolicyInformation OPTIONAL
}
id-aa-signingCertificate OBJECT IDENTIFIER ::= { iso(1)
member-body(2) us(840) rsadsi(113549) pkcs(1) pkcs9(9)
smime(16) id-aa(2) 12 }
The definition of SigningCertificateV2 is
SigningCertificateV2 ::= SEQUENCE {
certs SEQUENCE OF EssCertIDv2,
policies SEQUENCE OF PolicyInformation OPTIONAL
}
id-aa-signingCertificateV2 OBJECT IDENTIFIER ::= { iso(1)
member-body(2) us(840) rsadsi(113549) pkcs(1) pkcs9(9)
smime(16) id-aa(2) 47 }
return the X9ECParameters object for the named curve represented by
the passed in object identifier. Null if the curve isn't present.
@param oid an object identifier representing a named curve, if present.
return the object identifier signified by the passed in name. Null
if there is no object identifier associated with name.
@return the object identifier associated with name, if present.
return the named curve name represented by the given object identifier.
returns an enumeration containing the name strings for curves
contained in this structure.
Marker interface for CHOICE objects - if you implement this in a roll-your-own
object, any attempt to tag the object implicitly will convert the tag to an
explicit one as the encoding rules require.
If you use this interface your class should also implement the getInstance
pattern which takes a tag object and the tagging mode used.
basic interface for Der string objects.
The CscaMasterList object. This object can be wrapped in a
CMSSignedData to be published in LDAP.
CscaMasterList ::= SEQUENCE {
version CscaMasterListVersion,
certList SET OF Certificate }
CscaMasterListVersion :: INTEGER {v0(0)}
The DataGroupHash object.
DataGroupHash ::= SEQUENCE {
dataGroupNumber DataGroupNumber,
dataGroupHashValue OCTET STRING }
DataGroupNumber ::= INTEGER {
dataGroup1 (1),
dataGroup1 (2),
dataGroup1 (3),
dataGroup1 (4),
dataGroup1 (5),
dataGroup1 (6),
dataGroup1 (7),
dataGroup1 (8),
dataGroup1 (9),
dataGroup1 (10),
dataGroup1 (11),
dataGroup1 (12),
dataGroup1 (13),
dataGroup1 (14),
dataGroup1 (15),
dataGroup1 (16) }
The LDSSecurityObject object (V1.8).
LDSSecurityObject ::= SEQUENCE {
version LDSSecurityObjectVersion,
hashAlgorithm DigestAlgorithmIdentifier,
dataGroupHashValues SEQUENCE SIZE (2..ub-DataGroups) OF DataHashGroup,
ldsVersionInfo LDSVersionInfo OPTIONAL
-- if present, version MUST be v1 }
DigestAlgorithmIdentifier ::= AlgorithmIdentifier,
LDSSecurityObjectVersion :: INTEGER {V0(0)}
LDSVersionInfo ::= SEQUENCE {
ldsVersion PRINTABLE STRING
unicodeVersion PRINTABLE STRING
}
@return
The id-isismtt-cp-accredited OID indicates that the certificate is a
qualified certificate according to Directive 1999/93/EC of the European
Parliament and of the Council of 13 December 1999 on a Community
Framework for Electronic Signatures, which additionally conforms the
special requirements of the SigG and has been issued by an accredited CA.
Certificate extensionDate of certificate generation
DateOfCertGenSyntax ::= GeneralizedTime
Attribute to indicate that the certificate holder may sign in the name of
a third person. May also be used as extension in a certificate.
Attribute to indicate admissions to certain professions. May be used as
attribute in attribute certificate or as extension in a certificate
Monetary limit for transactions. The QcEuMonetaryLimit QC statement MUST
be used in new certificates in place of the extension/attribute
MonetaryLimit since January 1, 2004. For the sake of backward
compatibility with certificates already in use, SigG conforming
components MUST support MonetaryLimit (as well as QcEuLimitValue).
A declaration of majority. May be used as attribute in attribute
certificate or as extension in a certificate
Serial number of the smart card containing the corresponding private key
ICCSNSyntax ::= OCTET STRING (SIZE(8..20))
Reference for a file of a smartcard that stores the public key of this
certificate and that is used as �security anchor�.
PKReferenceSyntax ::= OCTET STRING (SIZE(20))
Some other restriction regarding the usage of this certificate. May be
used as attribute in attribute certificate or as extension in a
certificate.
RestrictionSyntax ::= DirectoryString (SIZE(1..1024))
@see Org.BouncyCastle.Asn1.IsisMtt.X509.Restriction
(Single)Request extension: Clients may include this extension in a
(single) Request to request the responder to send the certificate in the
response message along with the status information. Besides the LDAP
service, this extension provides another mechanism for the distribution
of certificates, which MAY optionally be provided by certificate
repositories.
RetrieveIfAllowed ::= BOOLEAN
SingleOCSPResponse extension: The certificate requested by the client by
inserting the RetrieveIfAllowed extension in the request, will be
returned in this extension.
@see Org.BouncyCastle.Asn1.IsisMtt.Ocsp.RequestedCertificate
Base ObjectIdentifier for naming authorities
SingleOCSPResponse extension: Date, when certificate has been published
in the directory and status information has become available. Currently,
accrediting authorities enforce that SigG-conforming OCSP servers include
this extension in the responses.
CertInDirSince ::= GeneralizedTime
Hash of a certificate in OCSP.
@see Org.BouncyCastle.Asn1.IsisMtt.Ocsp.CertHash
NameAtBirth ::= DirectoryString(SIZE(1..64)
Used in
{@link Org.BouncyCastle.Asn1.X509.SubjectDirectoryAttributes SubjectDirectoryAttributes}
Some other information of non-restrictive nature regarding the usage of
this certificate. May be used as attribute in atribute certificate or as
extension in a certificate.
AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048))
@see Org.BouncyCastle.Asn1.IsisMtt.X509.AdditionalInformationSyntax
Indicates that an attribute certificate exists, which limits the
usability of this public key certificate. Whenever verifying a signature
with the help of this certificate, the content of the corresponding
attribute certificate should be concerned. This extension MUST be
included in a PKC, if a corresponding attribute certificate (having the
PKC as base certificate) contains some attribute that restricts the
usability of the PKC too. Attribute certificates with restricting content
MUST always be included in the signed document.
LiabilityLimitationFlagSyntax ::= BOOLEAN
ISIS-MTT PROFILE: The responder may include this extension in a response to
send the hash of the requested certificate to the responder. This hash is
cryptographically bound to the certificate and serves as evidence that the
certificate is known to the responder (i.e. it has been issued and is present
in the directory). Hence, this extension is a means to provide a positive
statement of availability as described in T8.[8]. As explained in T13.[1],
clients may rely on this information to be able to validate signatures after
the expiry of the corresponding certificate. Hence, clients MUST support this
extension. If a positive statement of availability is to be delivered, this
extension syntax and OID MUST be used.
CertHash ::= SEQUENCE {
hashAlgorithm AlgorithmIdentifier,
certificateHash OCTET STRING
}
Constructor from Asn1Sequence.
The sequence is of type CertHash:
CertHash ::= SEQUENCE {
hashAlgorithm AlgorithmIdentifier,
certificateHash OCTET STRING
}
@param seq The ASN.1 sequence.
Constructor from a given details.
@param hashAlgorithm The hash algorithm identifier.
@param certificateHash The hash of the whole DER encoding of the certificate.
Produce an object suitable for an Asn1OutputStream.
Returns:
CertHash ::= SEQUENCE {
hashAlgorithm AlgorithmIdentifier,
certificateHash OCTET STRING
}
@return an Asn1Object
ISIS-MTT-Optional: The certificate requested by the client by inserting the
RetrieveIfAllowed extension in the request, will be returned in this
extension.
ISIS-MTT-SigG: The signature act allows publishing certificates only then,
when the certificate owner gives his isExplicit permission. Accordingly, there
may be �nondownloadable� certificates, about which the responder must provide
status information, but MUST NOT include them in the response. Clients may
get therefore the following three kind of answers on a single request
including the RetrieveIfAllowed extension:
- a) the responder supports the extension and is allowed to publish the
certificate: RequestedCertificate returned including the requested
certificate
- b) the responder supports the extension but is NOT allowed to publish
the certificate: RequestedCertificate returned including an empty OCTET
STRING
- c) the responder does not support the extension: RequestedCertificate is
not included in the response
Clients requesting RetrieveIfAllowed MUST be able to handle these cases. If
any of the OCTET STRING options is used, it MUST contain the DER encoding of
the requested certificate.
RequestedCertificate ::= CHOICE {
Certificate Certificate,
publicKeyCertificate [0] EXPLICIT OCTET STRING,
attributeCertificate [1] EXPLICIT OCTET STRING
}
Constructor from a given details.
Only one parameter can be given. All other must be null.
@param certificate Given as Certificate
Produce an object suitable for an Asn1OutputStream.
Returns:
RequestedCertificate ::= CHOICE {
Certificate Certificate,
publicKeyCertificate [0] EXPLICIT OCTET STRING,
attributeCertificate [1] EXPLICIT OCTET STRING
}
@return an Asn1Object
Some other information of non-restrictive nature regarding the usage of this
certificate.
AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048))
Constructor from a given details.
@param information The describtion of the information.
Produce an object suitable for an Asn1OutputStream.
Returns:
AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048))
@return an Asn1Object
An Admissions structure.
Admissions ::= SEQUENCE
{
admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
professionInfos SEQUENCE OF ProfessionInfo
}
@see Org.BouncyCastle.Asn1.IsisMtt.X509.AdmissionSyntax
@see Org.BouncyCastle.Asn1.IsisMtt.X509.ProfessionInfo
@see Org.BouncyCastle.Asn1.IsisMtt.X509.NamingAuthority
Constructor from Asn1Sequence.
The sequence is of type ProcurationSyntax:
Admissions ::= SEQUENCE
{
admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
professionInfos SEQUENCE OF ProfessionInfo
}
@param seq The ASN.1 sequence.
Constructor from a given details.
Parameter professionInfos is mandatory.
@param admissionAuthority The admission authority.
@param namingAuthority The naming authority.
@param professionInfos The profession infos.
Produce an object suitable for an Asn1OutputStream.
Returns:
Admissions ::= SEQUENCE
{
admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
professionInfos SEQUENCE OF ProfessionInfo
}
@return an Asn1Object
Attribute to indicate admissions to certain professions.
AdmissionSyntax ::= SEQUENCE
{
admissionAuthority GeneralName OPTIONAL,
contentsOfAdmissions SEQUENCE OF Admissions
}
Admissions ::= SEQUENCE
{
admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
professionInfos SEQUENCE OF ProfessionInfo
}
NamingAuthority ::= SEQUENCE
{
namingAuthorityId OBJECT IDENTIFIER OPTIONAL,
namingAuthorityUrl IA5String OPTIONAL,
namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
}
ProfessionInfo ::= SEQUENCE
{
namingAuthority [0] EXPLICIT NamingAuthority OPTIONAL,
professionItems SEQUENCE OF DirectoryString (SIZE(1..128)),
professionOIDs SEQUENCE OF OBJECT IDENTIFIER OPTIONAL,
registrationNumber PrintableString(SIZE(1..128)) OPTIONAL,
addProfessionInfo OCTET STRING OPTIONAL
}
ISIS-MTT PROFILE: The relatively complex structure of AdmissionSyntax
supports the following concepts and requirements:
- External institutions (e.g. professional associations, chambers, unions,
administrative bodies, companies, etc.), which are responsible for granting
and verifying professional admissions, are indicated by means of the data
field admissionAuthority. An admission authority is indicated by a
GeneralName object. Here an X.501 directory name (distinguished name) can be
indicated in the field directoryName, a URL address can be indicated in the
field uniformResourceIdentifier, and an object identifier can be indicated in
the field registeredId.
- The names of authorities which are responsible for the administration of
title registers are indicated in the data field namingAuthority. The name of
the authority can be identified by an object identifier in the field
namingAuthorityId, by means of a text string in the field
namingAuthorityText, by means of a URL address in the field
namingAuthorityUrl, or by a combination of them. For example, the text string
can contain the name of the authority, the country and the name of the title
register. The URL-option refers to a web page which contains lists with
officially registered professions (text and possibly OID) as well as
further information on these professions. Object identifiers for the
component namingAuthorityId are grouped under the OID-branch
id-isis-at-namingAuthorities and must be applied for.
- See http://www.teletrust.de/anwend.asp?Id=30200&Sprache=E_&HomePG=0
for an application form and http://www.teletrust.de/links.asp?id=30220,11
for an overview of registered naming authorities.
- By means of the data type ProfessionInfo certain professions,
specializations, disciplines, fields of activity, etc. are identified. A
profession is represented by one or more text strings, resp. profession OIDs
in the fields professionItems and professionOIDs and by a registration number
in the field registrationNumber. An indication in text form must always be
present, whereas the other indications are optional. The component
addProfessionInfo may contain additional applicationspecific information in
DER-encoded form.
By means of different namingAuthority-OIDs or profession OIDs hierarchies of
professions, specializations, disciplines, fields of activity, etc. can be
expressed. The issuing admission authority should always be indicated (field
admissionAuthority), whenever a registration number is presented. Still,
information on admissions can be given without indicating an admission or a
naming authority by the exclusive use of the component professionItems. In
this case the certification authority is responsible for the verification of
the admission information.
This attribute is single-valued. Still, several admissions can be captured in
the sequence structure of the component contentsOfAdmissions of
AdmissionSyntax or in the component professionInfos of Admissions. The
component admissionAuthority of AdmissionSyntax serves as default value for
the component admissionAuthority of Admissions. Within the latter component
the default value can be overwritten, in case that another authority is
responsible. The component namingAuthority of Admissions serves as a default
value for the component namingAuthority of ProfessionInfo. Within the latter
component the default value can be overwritten, in case that another naming
authority needs to be recorded.
The length of the string objects is limited to 128 characters. It is
recommended to indicate a namingAuthorityURL in all issued attribute
certificates. If a namingAuthorityURL is indicated, the field professionItems
of ProfessionInfo should contain only registered titles. If the field
professionOIDs exists, it has to contain the OIDs of the professions listed
in professionItems in the same order. In general, the field professionInfos
should contain only one entry, unless the admissions that are to be listed
are logically connected (e.g. they have been issued under the same admission
number).
@see Org.BouncyCastle.Asn1.IsisMtt.X509.Admissions
@see Org.BouncyCastle.Asn1.IsisMtt.X509.ProfessionInfo
@see Org.BouncyCastle.Asn1.IsisMtt.X509.NamingAuthority
Constructor from Asn1Sequence.
The sequence is of type ProcurationSyntax:
AdmissionSyntax ::= SEQUENCE
{
admissionAuthority GeneralName OPTIONAL,
contentsOfAdmissions SEQUENCE OF Admissions
}
Admissions ::= SEQUENCE
{
admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
professionInfos SEQUENCE OF ProfessionInfo
}
NamingAuthority ::= SEQUENCE
{
namingAuthorityId OBJECT IDENTIFIER OPTIONAL,
namingAuthorityUrl IA5String OPTIONAL,
namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
}
ProfessionInfo ::= SEQUENCE
{
namingAuthority [0] EXPLICIT NamingAuthority OPTIONAL,
professionItems SEQUENCE OF DirectoryString (SIZE(1..128)),
professionOIDs SEQUENCE OF OBJECT IDENTIFIER OPTIONAL,
registrationNumber PrintableString(SIZE(1..128)) OPTIONAL,
addProfessionInfo OCTET STRING OPTIONAL
}
@param seq The ASN.1 sequence.
Constructor from given details.
@param admissionAuthority The admission authority.
@param contentsOfAdmissions The admissions.
Produce an object suitable for an Asn1OutputStream.
Returns:
AdmissionSyntax ::= SEQUENCE
{
admissionAuthority GeneralName OPTIONAL,
contentsOfAdmissions SEQUENCE OF Admissions
}
Admissions ::= SEQUENCE
{
admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
professionInfos SEQUENCE OF ProfessionInfo
}
NamingAuthority ::= SEQUENCE
{
namingAuthorityId OBJECT IDENTIFIER OPTIONAL,
namingAuthorityUrl IA5String OPTIONAL,
namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
}
ProfessionInfo ::= SEQUENCE
{
namingAuthority [0] EXPLICIT NamingAuthority OPTIONAL,
professionItems SEQUENCE OF DirectoryString (SIZE(1..128)),
professionOIDs SEQUENCE OF OBJECT IDENTIFIER OPTIONAL,
registrationNumber PrintableString(SIZE(1..128)) OPTIONAL,
addProfessionInfo OCTET STRING OPTIONAL
}
@return an Asn1Object
@return Returns the admissionAuthority if present, null otherwise.
@return Returns the contentsOfAdmissions.
A declaration of majority.
DeclarationOfMajoritySyntax ::= CHOICE
{
notYoungerThan [0] IMPLICIT INTEGER,
fullAgeAtCountry [1] IMPLICIT SEQUENCE
{
fullAge BOOLEAN DEFAULT TRUE,
country PrintableString (SIZE(2))
}
dateOfBirth [2] IMPLICIT GeneralizedTime
}
fullAgeAtCountry indicates the majority of the owner with respect to the laws
of a specific country.
Produce an object suitable for an Asn1OutputStream.
Returns:
DeclarationOfMajoritySyntax ::= CHOICE
{
notYoungerThan [0] IMPLICIT INTEGER,
fullAgeAtCountry [1] IMPLICIT SEQUENCE
{
fullAge BOOLEAN DEFAULT TRUE,
country PrintableString (SIZE(2))
}
dateOfBirth [2] IMPLICIT GeneralizedTime
}
@return an Asn1Object
@return notYoungerThan if that's what we are, -1 otherwise
Monetary limit for transactions. The QcEuMonetaryLimit QC statement MUST be
used in new certificates in place of the extension/attribute MonetaryLimit
since January 1, 2004. For the sake of backward compatibility with
certificates already in use, components SHOULD support MonetaryLimit (as well
as QcEuLimitValue).
Indicates a monetary limit within which the certificate holder is authorized
to act. (This value DOES NOT express a limit on the liability of the
certification authority).
MonetaryLimitSyntax ::= SEQUENCE
{
currency PrintableString (SIZE(3)),
amount INTEGER,
exponent INTEGER
}
currency must be the ISO code.
value = amount�10*exponent
Constructor from a given details.
value = amount�10^exponent
@param currency The currency. Must be the ISO code.
@param amount The amount
@param exponent The exponent
Produce an object suitable for an Asn1OutputStream.
Returns:
MonetaryLimitSyntax ::= SEQUENCE
{
currency PrintableString (SIZE(3)),
amount INTEGER,
exponent INTEGER
}
@return an Asn1Object
Names of authorities which are responsible for the administration of title
registers.
NamingAuthority ::= SEQUENCE
{
namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
namingAuthorityUrl IA5String OPTIONAL,
namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
}
@see Org.BouncyCastle.Asn1.IsisMtt.X509.AdmissionSyntax
Profession OIDs should always be defined under the OID branch of the
responsible naming authority. At the time of this writing, the work group
�Recht, Wirtschaft, Steuern� (�Law, Economy, Taxes�) is registered as the
first naming authority under the OID id-isismtt-at-namingAuthorities.
Constructor from Asn1Sequence.
NamingAuthority ::= SEQUENCE
{
namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
namingAuthorityUrl IA5String OPTIONAL,
namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
}
@param seq The ASN.1 sequence.
@return Returns the namingAuthorityID.
@return Returns the namingAuthorityText.
@return Returns the namingAuthorityUrl.
Constructor from given details.
All parameters can be combined.
@param namingAuthorityID ObjectIdentifier for naming authority.
@param namingAuthorityUrl URL for naming authority.
@param namingAuthorityText Textual representation of naming authority.
Produce an object suitable for an Asn1OutputStream.
Returns:
NamingAuthority ::= SEQUENCE
{
namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
namingAuthorityUrl IA5String OPTIONAL,
namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
}
@return an Asn1Object
Attribute to indicate that the certificate holder may sign in the name of a
third person.
ISIS-MTT PROFILE: The corresponding ProcurationSyntax contains either the
name of the person who is represented (subcomponent thirdPerson) or a
reference to his/her base certificate (in the component signingFor,
subcomponent certRef), furthermore the optional components country and
typeSubstitution to indicate the country whose laws apply, and respectively
the type of procuration (e.g. manager, procuration, custody).
ISIS-MTT PROFILE: The GeneralName MUST be of type directoryName and MAY only
contain: - RFC3039 attributes, except pseudonym (countryName, commonName,
surname, givenName, serialNumber, organizationName, organizationalUnitName,
stateOrProvincename, localityName, postalAddress) and - SubjectDirectoryName
attributes (title, dateOfBirth, placeOfBirth, gender, countryOfCitizenship,
countryOfResidence and NameAtBirth).
ProcurationSyntax ::= SEQUENCE {
country [1] EXPLICIT PrintableString(SIZE(2)) OPTIONAL,
typeOfSubstitution [2] EXPLICIT DirectoryString (SIZE(1..128)) OPTIONAL,
signingFor [3] EXPLICIT SigningFor
}
SigningFor ::= CHOICE
{
thirdPerson GeneralName,
certRef IssuerSerial
}
Constructor from Asn1Sequence.
The sequence is of type ProcurationSyntax:
ProcurationSyntax ::= SEQUENCE {
country [1] EXPLICIT PrintableString(SIZE(2)) OPTIONAL,
typeOfSubstitution [2] EXPLICIT DirectoryString (SIZE(1..128)) OPTIONAL,
signingFor [3] EXPLICIT SigningFor
}
SigningFor ::= CHOICE
{
thirdPerson GeneralName,
certRef IssuerSerial
}
@param seq The ASN.1 sequence.
Constructor from a given details.
Either generalName or certRef MUST be
null.
@param country The country code whose laws apply.
@param typeOfSubstitution The type of procuration.
@param certRef Reference to certificate of the person who is represented.
Constructor from a given details.
Either generalName or certRef MUST be
null.
@param country The country code whose laws apply.
@param typeOfSubstitution The type of procuration.
@param thirdPerson The GeneralName of the person who is represented.
Produce an object suitable for an Asn1OutputStream.
Returns:
ProcurationSyntax ::= SEQUENCE {
country [1] EXPLICIT PrintableString(SIZE(2)) OPTIONAL,
typeOfSubstitution [2] EXPLICIT DirectoryString (SIZE(1..128)) OPTIONAL,
signingFor [3] EXPLICIT SigningFor
}
SigningFor ::= CHOICE
{
thirdPerson GeneralName,
certRef IssuerSerial
}
@return an Asn1Object
Professions, specializations, disciplines, fields of activity, etc.
ProfessionInfo ::= SEQUENCE
{
namingAuthority [0] EXPLICIT NamingAuthority OPTIONAL,
professionItems SEQUENCE OF DirectoryString (SIZE(1..128)),
professionOids SEQUENCE OF OBJECT IDENTIFIER OPTIONAL,
registrationNumber PrintableString(SIZE(1..128)) OPTIONAL,
addProfessionInfo OCTET STRING OPTIONAL
}
@see Org.BouncyCastle.Asn1.IsisMtt.X509.AdmissionSyntax
Rechtsanw�ltin
Rechtsanwalt
Rechtsbeistand
Steuerberaterin
Steuerberater
Steuerbevollm�chtigte
Steuerbevollm�chtigter
Notarin
Notar
Notarvertreterin
Notarvertreter
Notariatsverwalterin
Notariatsverwalter
Wirtschaftspr�ferin
Wirtschaftspr�fer
Vereidigte Buchpr�ferin
Vereidigter Buchpr�fer
Patentanw�ltin
Patentanwalt
Constructor from Asn1Sequence.
ProfessionInfo ::= SEQUENCE
{
namingAuthority [0] EXPLICIT NamingAuthority OPTIONAL,
professionItems SEQUENCE OF DirectoryString (SIZE(1..128)),
professionOids SEQUENCE OF OBJECT IDENTIFIER OPTIONAL,
registrationNumber PrintableString(SIZE(1..128)) OPTIONAL,
addProfessionInfo OCTET STRING OPTIONAL
}
@param seq The ASN.1 sequence.
Constructor from given details.
professionItems is mandatory, all other parameters are
optional.
@param namingAuthority The naming authority.
@param professionItems Directory strings of the profession.
@param professionOids DERObjectIdentfier objects for the
profession.
@param registrationNumber Registration number.
@param addProfessionInfo Additional infos in encoded form.
Produce an object suitable for an Asn1OutputStream.
Returns:
ProfessionInfo ::= SEQUENCE
{
namingAuthority [0] EXPLICIT NamingAuthority OPTIONAL,
professionItems SEQUENCE OF DirectoryString (SIZE(1..128)),
professionOids SEQUENCE OF OBJECT IDENTIFIER OPTIONAL,
registrationNumber PrintableString(SIZE(1..128)) OPTIONAL,
addProfessionInfo OCTET STRING OPTIONAL
}
@return an Asn1Object
@return Returns the addProfessionInfo.
@return Returns the namingAuthority.
@return Returns the professionItems.
@return Returns the professionOids.
@return Returns the registrationNumber.
Some other restriction regarding the usage of this certificate.
RestrictionSyntax ::= DirectoryString (SIZE(1..1024))
Constructor from DirectoryString.
The DirectoryString is of type RestrictionSyntax:
RestrictionSyntax ::= DirectoryString (SIZE(1..1024))
@param restriction A IAsn1String.
Constructor from a given details.
@param restriction The description of the restriction.
Produce an object suitable for an Asn1OutputStream.
Returns:
RestrictionSyntax ::= DirectoryString (SIZE(1..1024))
@return an Asn1Object
Produce an object suitable for an Asn1OutputStream.
cast5CBCParameters ::= Sequence {
iv OCTET STRING DEFAULT 0,
-- Initialization vector
keyLength Integer
-- Key length, in bits
}
Produce an object suitable for an Asn1OutputStream.
IDEA-CBCPar ::= Sequence {
iv OCTET STRING OPTIONAL -- exactly 8 octets
}
The NetscapeCertType object.
NetscapeCertType ::= BIT STRING {
SSLClient (0),
SSLServer (1),
S/MIME (2),
Object Signing (3),
Reserved (4),
SSL CA (5),
S/MIME CA (6),
Object Signing CA (7) }
Basic constructor.
@param usage - the bitwise OR of the Key Usage flags giving the
allowed uses for the key.
e.g. (X509NetscapeCertType.sslCA | X509NetscapeCertType.smimeCA)
This is designed to parse
the PublicKeyAndChallenge created by the KEYGEN tag included by
Mozilla based browsers.
PublicKeyAndChallenge ::= SEQUENCE {
spki SubjectPublicKeyInfo,
challenge IA5STRING
}
Utility class for fetching curves using their NIST names as published in FIPS-PUB 186-3
return the X9ECParameters object for the named curve represented by
the passed in object identifier. Null if the curve isn't present.
@param oid an object identifier representing a named curve, if present.
return the object identifier signified by the passed in name. Null
if there is no object identifier associated with name.
@return the object identifier associated with name, if present.
return the named curve name represented by the given object identifier.
returns an enumeration containing the name strings for curves
contained in this structure.
2.16.840.1.101.3.4.3.5
2.16.840.1.101.3.4.3.6
2.16.840.1.101.3.4.3.7
2.16.840.1.101.3.4.3.8
2.16.840.1.101.3.4.3.9
2.16.840.1.101.3.4.3.10
2.16.840.1.101.3.4.3.11
2.16.840.1.101.3.4.3.12
2.16.840.1.101.3.4.3.9
2.16.840.1.101.3.4.3.10
2.16.840.1.101.3.4.3.11
2.16.840.1.101.3.4.3.12
From RFC 3657
Produce an object suitable for an Asn1OutputStream.
BasicOcspResponse ::= Sequence {
tbsResponseData ResponseData,
signatureAlgorithm AlgorithmIdentifier,
signature BIT STRING,
certs [0] EXPLICIT Sequence OF Certificate OPTIONAL }
Produce an object suitable for an Asn1OutputStream.
CertID ::= Sequence {
hashAlgorithm AlgorithmIdentifier,
issuerNameHash OCTET STRING, -- Hash of Issuer's DN
issuerKeyHash OCTET STRING, -- Hash of Issuers public key
serialNumber CertificateSerialNumber }
create a CertStatus object with a tag of zero.
Produce an object suitable for an Asn1OutputStream.
CertStatus ::= CHOICE {
good [0] IMPLICIT Null,
revoked [1] IMPLICIT RevokedInfo,
unknown [2] IMPLICIT UnknownInfo }
Produce an object suitable for an Asn1OutputStream.
CrlID ::= Sequence {
crlUrl [0] EXPLICIT IA5String OPTIONAL,
crlNum [1] EXPLICIT Integer OPTIONAL,
crlTime [2] EXPLICIT GeneralizedTime OPTIONAL }
Produce an object suitable for an Asn1OutputStream.
OcspRequest ::= Sequence {
tbsRequest TBSRequest,
optionalSignature [0] EXPLICIT Signature OPTIONAL }
Produce an object suitable for an Asn1OutputStream.
OcspResponse ::= Sequence {
responseStatus OcspResponseStatus,
responseBytes [0] EXPLICIT ResponseBytes OPTIONAL }
The OcspResponseStatus enumeration.
OcspResponseStatus ::= Enumerated {
successful (0), --Response has valid confirmations
malformedRequest (1), --Illegal confirmation request
internalError (2), --Internal error in issuer
tryLater (3), --Try again later
--(4) is not used
sigRequired (5), --Must sign the request
unauthorized (6) --Request unauthorized
}
Produce an object suitable for an Asn1OutputStream.
Request ::= Sequence {
reqCert CertID,
singleRequestExtensions [0] EXPLICIT Extensions OPTIONAL }
Produce an object suitable for an Asn1OutputStream.
ResponderID ::= CHOICE {
byName [1] Name,
byKey [2] KeyHash }
Produce an object suitable for an Asn1OutputStream.
ResponseBytes ::= Sequence {
responseType OBJECT IDENTIFIER,
response OCTET STRING }
Produce an object suitable for an Asn1OutputStream.
ResponseData ::= Sequence {
version [0] EXPLICIT Version DEFAULT v1,
responderID ResponderID,
producedAt GeneralizedTime,
responses Sequence OF SingleResponse,
responseExtensions [1] EXPLICIT Extensions OPTIONAL }
Produce an object suitable for an Asn1OutputStream.
RevokedInfo ::= Sequence {
revocationTime GeneralizedTime,
revocationReason [0] EXPLICIT CRLReason OPTIONAL }
Produce an object suitable for an Asn1OutputStream.
ServiceLocator ::= Sequence {
issuer Name,
locator AuthorityInfoAccessSyntax OPTIONAL }
Produce an object suitable for an Asn1OutputStream.
Signature ::= Sequence {
signatureAlgorithm AlgorithmIdentifier,
signature BIT STRING,
certs [0] EXPLICIT Sequence OF Certificate OPTIONAL}
Produce an object suitable for an Asn1OutputStream.
SingleResponse ::= Sequence {
certID CertID,
certStatus CertStatus,
thisUpdate GeneralizedTime,
nextUpdate [0] EXPLICIT GeneralizedTime OPTIONAL,
singleExtensions [1] EXPLICIT Extensions OPTIONAL }
Produce an object suitable for an Asn1OutputStream.
TBSRequest ::= Sequence {
version [0] EXPLICIT Version DEFAULT v1,
requestorName [1] EXPLICIT GeneralName OPTIONAL,
requestList Sequence OF Request,
requestExtensions [2] EXPLICIT Extensions OPTIONAL }
class for breaking up an Oid into it's component tokens, ala
java.util.StringTokenizer. We need this class as some of the
lightweight Java environment don't support classes like
StringTokenizer.
return an Attribute object from the given object.
@param o the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
Attr ::= Sequence {
attrType OBJECT IDENTIFIER,
attrValues Set OF AttributeValue
}
Pkcs10 Certfication request object.
CertificationRequest ::= Sequence {
certificationRequestInfo CertificationRequestInfo,
signatureAlgorithm AlgorithmIdentifier{{ SignatureAlgorithms }},
signature BIT STRING
}
Pkcs10 CertificationRequestInfo object.
CertificationRequestInfo ::= Sequence {
version Integer { v1(0) } (v1,...),
subject Name,
subjectPKInfo SubjectPublicKeyInfo{{ PKInfoAlgorithms }},
attributes [0] Attributes{{ CRIAttributes }}
}
Attributes { ATTRIBUTE:IOSet } ::= Set OF Attr{{ IOSet }}
Attr { ATTRIBUTE:IOSet } ::= Sequence {
type ATTRIBUTE.&id({IOSet}),
values Set SIZE(1..MAX) OF ATTRIBUTE.&Type({IOSet}{\@type})
}
Produce an object suitable for an Asn1OutputStream.
ContentInfo ::= Sequence {
contentType ContentType,
content
[0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
The EncryptedData object.
EncryptedData ::= Sequence {
version Version,
encryptedContentInfo EncryptedContentInfo
}
EncryptedContentInfo ::= Sequence {
contentType ContentType,
contentEncryptionAlgorithm ContentEncryptionAlgorithmIdentifier,
encryptedContent [0] IMPLICIT EncryptedContent OPTIONAL
}
EncryptedContent ::= OCTET STRING
Produce an object suitable for an Asn1OutputStream.
EncryptedPrivateKeyInfo ::= Sequence {
encryptionAlgorithm AlgorithmIdentifier {{KeyEncryptionAlgorithms}},
encryptedData EncryptedData
}
EncryptedData ::= OCTET STRING
KeyEncryptionAlgorithms ALGORITHM-IDENTIFIER ::= {
... -- For local profiles
}
MacData ::= SEQUENCE {
mac DigestInfo,
macSalt OCTET STRING,
iterations INTEGER DEFAULT 1
-- Note: The default is for historic reasons and its use is deprecated. A
-- higher value, like 1024 is recommended.
@return the basic DERObject construction.
the infamous Pfx from Pkcs12
RFC 6211 - id-aa-cmsAlgorithmProtect OBJECT IDENTIFIER ::= {
iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1)
pkcs9(9) 52 }
RFC 5958
[IMPLICIT TAGS]
OneAsymmetricKey ::= SEQUENCE {
version Version,
privateKeyAlgorithm PrivateKeyAlgorithmIdentifier,
privateKey PrivateKey,
attributes [0] Attributes OPTIONAL,
...,
[[2: publicKey [1] PublicKey OPTIONAL ]],
...
}
PrivateKeyInfo ::= OneAsymmetricKey
Version ::= INTEGER { v1(0), v2(1) } (v1, ..., v2)
PrivateKeyAlgorithmIdentifier ::= AlgorithmIdentifier
{ PUBLIC-KEY,
{ PrivateKeyAlgorithms } }
PrivateKey ::= OCTET STRING
-- Content varies based on type of key. The
-- algorithm identifier dictates the format of
-- the key.
PublicKey ::= BIT STRING
-- Content varies based on type of key. The
-- algorithm identifier dictates the format of
-- the key.
Attributes ::= SET OF Attribute { { OneAsymmetricKeyAttributes } }
Return true if a public key is present, false otherwise.
For when the public key is an ASN.1 encoding.
Return the public key as a raw bit string.
The default version
RSAES-OAEP-params ::= SEQUENCE {
hashAlgorithm [0] OAEP-PSSDigestAlgorithms DEFAULT sha1,
maskGenAlgorithm [1] PKCS1MGFAlgorithms DEFAULT mgf1SHA1,
pSourceAlgorithm [2] PKCS1PSourceAlgorithms DEFAULT pSpecifiedEmpty
}
OAEP-PSSDigestAlgorithms ALGORITHM-IDENTIFIER ::= {
{ OID id-sha1 PARAMETERS NULL }|
{ OID id-sha256 PARAMETERS NULL }|
{ OID id-sha384 PARAMETERS NULL }|
{ OID id-sha512 PARAMETERS NULL },
... -- Allows for future expansion --
}
PKCS1MGFAlgorithms ALGORITHM-IDENTIFIER ::= {
{ OID id-mgf1 PARAMETERS OAEP-PSSDigestAlgorithms },
... -- Allows for future expansion --
}
PKCS1PSourceAlgorithms ALGORITHM-IDENTIFIER ::= {
{ OID id-pSpecified PARAMETERS OCTET STRING },
... -- Allows for future expansion --
}
@return the asn1 primitive representing the parameters.
This outputs the key in Pkcs1v2 format.
RsaPrivateKey ::= Sequence {
version Version,
modulus Integer, -- n
publicExponent Integer, -- e
privateExponent Integer, -- d
prime1 Integer, -- p
prime2 Integer, -- q
exponent1 Integer, -- d mod (p-1)
exponent2 Integer, -- d mod (q-1)
coefficient Integer -- (inverse of q) mod p
}
Version ::= Integer
This routine is written to output Pkcs1 version 0, private keys.
The default version
RSASSA-PSS-params ::= SEQUENCE {
hashAlgorithm [0] OAEP-PSSDigestAlgorithms DEFAULT sha1,
maskGenAlgorithm [1] PKCS1MGFAlgorithms DEFAULT mgf1SHA1,
saltLength [2] INTEGER DEFAULT 20,
trailerField [3] TrailerField DEFAULT trailerFieldBC
}
OAEP-PSSDigestAlgorithms ALGORITHM-IDENTIFIER ::= {
{ OID id-sha1 PARAMETERS NULL }|
{ OID id-sha256 PARAMETERS NULL }|
{ OID id-sha384 PARAMETERS NULL }|
{ OID id-sha512 PARAMETERS NULL },
... -- Allows for future expansion --
}
PKCS1MGFAlgorithms ALGORITHM-IDENTIFIER ::= {
{ OID id-mgf1 PARAMETERS OAEP-PSSDigestAlgorithms },
... -- Allows for future expansion --
}
TrailerField ::= INTEGER { trailerFieldBC(1) }
@return the asn1 primitive representing the parameters.
a Pkcs#7 signed data object.
Produce an object suitable for an Asn1OutputStream.
SignedData ::= Sequence {
version Version,
digestAlgorithms DigestAlgorithmIdentifiers,
contentInfo ContentInfo,
certificates
[0] IMPLICIT ExtendedCertificatesAndCertificates
OPTIONAL,
crls
[1] IMPLICIT CertificateRevocationLists OPTIONAL,
signerInfos SignerInfos }
a Pkcs#7 signer info object.
Produce an object suitable for an Asn1OutputStream.
SignerInfo ::= Sequence {
version Version,
issuerAndSerialNumber IssuerAndSerialNumber,
digestAlgorithm DigestAlgorithmIdentifier,
authenticatedAttributes [0] IMPLICIT Attributes OPTIONAL,
digestEncryptionAlgorithm DigestEncryptionAlgorithmIdentifier,
encryptedDigest EncryptedDigest,
unauthenticatedAttributes [1] IMPLICIT Attributes OPTIONAL
}
EncryptedDigest ::= OCTET STRING
DigestAlgorithmIdentifier ::= AlgorithmIdentifier
DigestEncryptionAlgorithmIdentifier ::= AlgorithmIdentifier
the elliptic curve private key object from SEC 1
ECPrivateKey ::= SEQUENCE {
version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
privateKey OCTET STRING,
parameters [0] Parameters OPTIONAL,
publicKey [1] BIT STRING OPTIONAL }
return the X9ECParameters object for the named curve represented by
the passed in object identifier. Null if the curve isn't present.
@param oid an object identifier representing a named curve, if present.
return the object identifier signified by the passed in name. Null
if there is no object identifier associated with name.
@return the object identifier associated with name, if present.
return the named curve name represented by the given object identifier.
returns an enumeration containing the name strings for curves
contained in this structure.
EllipticCurve OBJECT IDENTIFIER ::= {
iso(1) identified-organization(3) certicom(132) curve(0)
}
Handler class for dealing with S/MIME Capabilities
general preferences
encryption algorithms preferences
return an Attr object from the given object.
@param o the object we want converted.
@exception ArgumentException if the object cannot be converted.
returns an ArrayList with 0 or more objects of all the capabilities
matching the passed in capability Oid. If the Oid passed is null the
entire set is returned.
Produce an object suitable for an Asn1OutputStream.
SMIMECapabilities ::= Sequence OF SMIMECapability
general preferences
encryption algorithms preferences
Produce an object suitable for an Asn1OutputStream.
SMIMECapability ::= Sequence {
capabilityID OBJECT IDENTIFIER,
parameters ANY DEFINED BY capabilityID OPTIONAL
}
Handler for creating a vector S/MIME Capabilities
The SmimeEncryptionKeyPreference object.
SmimeEncryptionKeyPreference ::= CHOICE {
issuerAndSerialNumber [0] IssuerAndSerialNumber,
receipentKeyId [1] RecipientKeyIdentifier,
subjectAltKeyIdentifier [2] SubjectKeyIdentifier
}
@param sKeyId the subjectKeyIdentifier value (normally the X.509 one)
elliptic curves defined in "ECC Brainpool Standard Curves and Curve Generation"
http://www.ecc-brainpool.org/download/draft_pkix_additional_ecc_dp.txt
return the X9ECParameters object for the named curve represented by
the passed in object identifier. Null if the curve isn't present.
@param oid an object identifier representing a named curve, if present.
return the object identifier signified by the passed in name. Null
if there is no object identifier associated with name.
@return the object identifier associated with name, if present.
return the named curve name represented by the given object identifier.
returns an enumeration containing the name strings for curves
contained in this structure.
Accuracy ::= SEQUENCE {
seconds INTEGER OPTIONAL,
millis [0] INTEGER (1..999) OPTIONAL,
micros [1] INTEGER (1..999) OPTIONAL
}
@param o
@return a MessageImprint object.
MessageImprint ::= SEQUENCE {
hashAlgorithm AlgorithmIdentifier,
hashedMessage OCTET STRING }
TimeStampReq ::= SEQUENCE {
version INTEGER { v1(1) },
messageImprint MessageImprint,
--a hash algorithm OID and the hash value of the data to be
--time-stamped
reqPolicy TSAPolicyId OPTIONAL,
nonce INTEGER OPTIONAL,
certReq BOOLEAN DEFAULT FALSE,
extensions [0] IMPLICIT Extensions OPTIONAL
}
TimeStampResp ::= SEQUENCE {
status PkiStatusInfo,
timeStampToken TimeStampToken OPTIONAL }
TstInfo ::= SEQUENCE {
version INTEGER { v1(1) },
policy TSAPolicyId,
messageImprint MessageImprint,
-- MUST have the same value as the similar field in
-- TimeStampReq
serialNumber INTEGER,
-- Time-Stamping users MUST be ready to accommodate integers
-- up to 160 bits.
genTime GeneralizedTime,
accuracy Accuracy OPTIONAL,
ordering BOOLEAN DEFAULT FALSE,
nonce INTEGER OPTIONAL,
-- MUST be present if the similar field was present
-- in TimeStampReq. In that case it MUST have the same value.
tsa [0] GeneralName OPTIONAL,
extensions [1] IMPLICIT Extensions OPTIONAL }
dump a Der object as a formatted string with indentation
@param obj the Asn1Object to be dumped out.
dump out a DER object as a formatted string, in non-verbose mode
@param obj the Asn1Encodable to be dumped out.
@return the resulting string.
Dump out the object as a string
@param obj the Asn1Encodable to be dumped out.
@param verbose if true, dump out the contents of octet and bit strings.
@return the resulting string.
Holding class for the AttributeTypeAndValue structures that make up an RDN.
AttributeTypeAndValue::= SEQUENCE {
type OBJECT IDENTIFIER,
value ANY DEFINED BY type
}
A basic ASN.1 object representation.
DirectoryString ::= CHOICE {
teletexString TeletexString (SIZE (1..MAX)),
printableString PrintableString (SIZE (1..MAX)),
universalString UniversalString (SIZE (1..MAX)),
utf8String UTF8String (SIZE (1..MAX)),
bmpString BMPString (SIZE (1..MAX)) }
This interface provides a profile to conform to when
DNs are being converted into strings and back. The idea being that we'll be able to deal with
the number of standard ways the fields in a DN should be
encoded into their ASN.1 counterparts - a number that is rapidly approaching the
number of machines on the Internet.
Convert the passed in String value into the appropriate ASN.1 encoded object.
The OID associated with the value in the DN.
The value of the particular DN component.
The ASN.1 equivalent for the value.
Return the OID associated with the passed in name.
The string to match.
An OID
Return an array of RDN generated from the passed in String.
the String representation.
An array of corresponding RDNs.
Return true if the two names are equal.
First name for comparison.
Second name for comparison.
true if name1 = name 2, false otherwise.
Calculate a hashCode for the passed in name.
The name the hashCode is required for.
The calculated hashCode.
Convert the passed in X500Name to a String.
The name to convert.
A String representation.
Return the display name for toString() associated with the OID.
The OID of interest.
The name displayed in toString(), null if no mapping provided.
Return the acceptable names in a String DN that map to OID.
The OID of interest.
An array of String aliases for the OID, zero length if there are none.
Create a single valued RDN.
@param oid RDN type.
@param value RDN value.
Create a multi-valued RDN.
@param aAndVs attribute type/value pairs making up the RDN
Return the number of AttributeTypeAndValue objects in this RDN,
@return size of RDN, greater than 1 if multi-valued.
RelativeDistinguishedName ::=
SET OF AttributeTypeAndValue
AttributeTypeAndValue ::= SEQUENCE {
type AttributeType,
value AttributeValue }
@return this object as its ASN1Primitive type
This class provides some default behavior and common implementation for a
X500NameStyle. It should be easily extendable to support implementing the
desired X500NameStyle.
Tool function to shallow copy a Hashtable.
@param paramsMap table to copy
@return the copy of the table
For all string values starting with '#' is assumed, that these are
already valid ASN.1 objects encoded in hex.
All other string values are send to
{@link AbstractX500NameStyle#encodeStringValue(ASN1ObjectIdentifier, String)}.
Subclasses should overwrite
{@link AbstractX500NameStyle#encodeStringValue(ASN1ObjectIdentifier, String)}
to change the encoding of specific types.
@param oid the DN name of the value.
@param value the String representation of the value.
Encoded every value into a UTF8String.
Subclasses should overwrite
this method to change the encoding of specific types.
@param oid the DN oid of the value
@param value the String representation of the value
@return a the value encoded into a ASN.1 object. Never returns null.
Variation of BCStyle that insists on strict ordering for equality
and hashCode comparisons
country code - StringType(SIZE(2))
organization - StringType(SIZE(1..64))
organizational unit name - StringType(SIZE(1..64))
Title
common name - StringType(SIZE(1..64))
device serial number name - StringType(SIZE(1..64))
street - StringType(SIZE(1..64))
device serial number name - StringType(SIZE(1..64))
locality name - StringType(SIZE(1..64))
state, or province name - StringType(SIZE(1..64))
Naming attributes of type X520name
businessCategory - DirectoryString(SIZE(1..128)
postalCode - DirectoryString(SIZE(1..40)
dnQualifier - DirectoryString(SIZE(1..64)
RFC 3039 Pseudonym - DirectoryString(SIZE(1..64)
RFC 3039 DateOfBirth - GeneralizedTime - YYYYMMDD000000Z
RFC 3039 PlaceOfBirth - DirectoryString(SIZE(1..128)
RFC 3039 Gender - PrintableString (SIZE(1)) -- "M", "F", "m" or "f"
RFC 3039 CountryOfCitizenship - PrintableString (SIZE (2)) -- ISO 3166
codes only
RFC 3039 CountryOfResidence - PrintableString (SIZE (2)) -- ISO 3166
codes only
ISIS-MTT NameAtBirth - DirectoryString(SIZE(1..64)
RFC 3039 PostalAddress - SEQUENCE SIZE (1..6) OF
DirectoryString(SIZE(1..30))
RFC 2256 dmdName
id-at-telephoneNumber
id-at-name
Email address (RSA PKCS#9 extension) - IA5String.
Note: if you're trying to be ultra orthodox, don't use this! It shouldn't be in here.
more from PKCS#9
email address in Verisign certificates
LDAP User id.
default look up table translating OID values into their common symbols following
the convention in RFC 2253 with a few extras
look up table translating common symbols into their OIDS.
Singleton instance.
default look up table translating OID values into their common symbols following
the convention in RFC 2253 with a few extras
look up table translating common symbols into their OIDS.
Singleton instance.
Class for breaking up an X500 Name into it's component tokens.
The X.500 Name object.
Name ::= CHOICE {
RDNSequence }
RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
RelativeDistinguishedName ::= SET SIZE (1..MAX) OF AttributeTypeAndValue
AttributeTypeAndValue ::= SEQUENCE {
type OBJECT IDENTIFIER,
value ANY }
Return a X500Name based on the passed in tagged object.
@param obj tag object holding name.
@param explicit true if explicitly tagged false otherwise.
@return the X500Name
Constructor from ASN1Sequence
the principal will be a list of constructed sets, each containing an (OID, String) pair.
return an array of RDNs in structure order.
@return an array of RDN objects.
return an array of OIDs contained in the attribute type of each RDN in structure order.
@return an array, possibly zero length, of DerObjectIdentifiers objects.
return an array of RDNs containing the attribute type given by OID in structure order.
@param attributeType the type OID we are looking for.
@return an array, possibly zero length, of RDN objects.
test for equality - note: case is ignored.
The current default style.
@return default style for X500Name construction.
A builder class for making X.500 Name objects.
Constructor using the default style (BCStyle).
Constructor using a specified style.
The style template for string to DN conversion.
Add an RDN based on a single OID and a string representation of its value.
The OID for this RDN.
The string representation of the value the OID refers to.
The current builder instance.
Add an RDN based on a single OID and an ASN.1 value.
The OID for this RDN.
The ASN.1 value the OID refers to.
The current builder instance.
Add an RDN based on the passed in AttributeTypeAndValue.
the AttributeTypeAndValue to build the RDN from.
The current builder instance.
Add a multi-valued RDN made up of the passed in OIDs and associated string values.
The OIDs making up the RDN.
The string representation of the values the OIDs refer to.
The current builder instance.
Add a multi-valued RDN made up of the passed in OIDs and associated ASN.1 values.
The OIDs making up the RDN.
The ASN.1 values the OIDs refer to.
The current builder instance.
Add an RDN based on the passed in AttributeTypeAndValues.
The AttributeTypeAndValues to build the RDN from.
The current builder instance.
Build an X.500 name for the current builder state.
A new X.500 name.
The AccessDescription object.
AccessDescription ::= SEQUENCE {
accessMethod OBJECT IDENTIFIER,
accessLocation GeneralName }
create an AccessDescription with the oid and location provided.
@return the access method.
@return the access location
Return the OID in the Algorithm entry of this identifier.
Return the parameters structure in the Parameters entry of this identifier.
Produce an object suitable for an Asn1OutputStream.
AlgorithmIdentifier ::= Sequence {
algorithm OBJECT IDENTIFIER,
parameters ANY DEFINED BY algorithm OPTIONAL }
Don't use this one if you are trying to be RFC 3281 compliant.
Use it for v1 attribute certificates only.
Our GeneralNames structure
Produce an object suitable for an Asn1OutputStream.
AttCertIssuer ::= CHOICE {
v1Form GeneralNames, -- MUST NOT be used in this
-- profile
v2Form [0] V2Form -- v2 only
}
Produce an object suitable for an Asn1OutputStream.
AttCertValidityPeriod ::= Sequence {
notBeforeTime GeneralizedTime,
notAfterTime GeneralizedTime
}
return an Attr object from the given object.
@param o the object we want converted.
@exception ArgumentException if the object cannot be converted.
Produce an object suitable for an Asn1OutputStream.
Attr ::= Sequence {
attrType OBJECT IDENTIFIER,
attrValues Set OF AttributeValue
}
@param obj
@return
Produce an object suitable for an Asn1OutputStream.
AttributeCertificate ::= Sequence {
acinfo AttributeCertificateInfo,
signatureAlgorithm AlgorithmIdentifier,
signatureValue BIT STRING
}
Produce an object suitable for an Asn1OutputStream.
AttributeCertificateInfo ::= Sequence {
version AttCertVersion -- version is v2,
holder Holder,
issuer AttCertIssuer,
signature AlgorithmIdentifier,
serialNumber CertificateSerialNumber,
attrCertValidityPeriod AttCertValidityPeriod,
attributes Sequence OF Attr,
issuerUniqueID UniqueIdentifier OPTIONAL,
extensions Extensions OPTIONAL
}
AttCertVersion ::= Integer { v2(1) }
The AuthorityInformationAccess object.
id-pe-authorityInfoAccess OBJECT IDENTIFIER ::= { id-pe 1 }
AuthorityInfoAccessSyntax ::=
Sequence SIZE (1..MAX) OF AccessDescription
AccessDescription ::= Sequence {
accessMethod OBJECT IDENTIFIER,
accessLocation GeneralName }
id-ad OBJECT IDENTIFIER ::= { id-pkix 48 }
id-ad-caIssuers OBJECT IDENTIFIER ::= { id-ad 2 }
id-ad-ocsp OBJECT IDENTIFIER ::= { id-ad 1 }
create an AuthorityInformationAccess with the oid and location provided.
The AuthorityKeyIdentifier object.
id-ce-authorityKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 35 }
AuthorityKeyIdentifier ::= Sequence {
keyIdentifier [0] IMPLICIT KeyIdentifier OPTIONAL,
authorityCertIssuer [1] IMPLICIT GeneralNames OPTIONAL,
authorityCertSerialNumber [2] IMPLICIT CertificateSerialNumber OPTIONAL }
KeyIdentifier ::= OCTET STRING
*
* Calulates the keyidentifier using a SHA1 hash over the BIT STRING
* from SubjectPublicKeyInfo as defined in RFC2459.
*
* Example of making a AuthorityKeyIdentifier:
*
* SubjectPublicKeyInfo apki = new SubjectPublicKeyInfo((ASN1Sequence)new ASN1InputStream(
* publicKey.getEncoded()).readObject());
* AuthorityKeyIdentifier aki = new AuthorityKeyIdentifier(apki);
*
*
*
create an AuthorityKeyIdentifier with the GeneralNames tag and
the serial number provided as well.
create an AuthorityKeyIdentifier with the GeneralNames tag and
the serial number provided.
create an AuthorityKeyIdentifier with a precomputed key identifier
create an AuthorityKeyIdentifier with a precomupted key identifier
and the GeneralNames tag and the serial number provided as well.
Produce an object suitable for an Asn1OutputStream.
create a cA=true object for the given path length constraint.
@param pathLenConstraint
Produce an object suitable for an Asn1OutputStream.
BasicConstraints := Sequence {
cA Boolean DEFAULT FALSE,
pathLenConstraint Integer (0..MAX) OPTIONAL
}
PKIX RFC-2459
The X.509 v2 CRL syntax is as follows. For signature calculation,
the data that is to be signed is ASN.1 Der encoded.
CertificateList ::= Sequence {
tbsCertList TbsCertList,
signatureAlgorithm AlgorithmIdentifier,
signatureValue BIT STRING }
This class helps to support crossCerfificatePairs in a LDAP directory
according RFC 2587
crossCertificatePairATTRIBUTE::={
WITH SYNTAX CertificatePair
EQUALITY MATCHING RULE certificatePairExactMatch
ID joint-iso-ccitt(2) ds(5) attributeType(4) crossCertificatePair(40)}
The forward elements of the crossCertificatePair attribute of a
CA's directory entry shall be used to store all, except self-issued
certificates issued to this CA. Optionally, the reverse elements of the
crossCertificatePair attribute, of a CA's directory entry may contain a
subset of certificates issued by this CA to other CAs. When both the forward
and the reverse elements are present in a single attribute value, issuer name
in one certificate shall match the subject name in the other and vice versa,
and the subject public key in one certificate shall be capable of verifying
the digital signature on the other certificate and vice versa.
When a reverse element is present, the forward element value and the reverse
element value need not be stored in the same attribute value; in other words,
they can be stored in either a single attribute value or two attribute
values.
CertificatePair ::= SEQUENCE {
forward [0] Certificate OPTIONAL,
reverse [1] Certificate OPTIONAL,
-- at least one of the pair shall be present -- }
Constructor from Asn1Sequence.
The sequence is of type CertificatePair:
CertificatePair ::= SEQUENCE {
forward [0] Certificate OPTIONAL,
reverse [1] Certificate OPTIONAL,
-- at least one of the pair shall be present -- }
@param seq The ASN.1 sequence.
Constructor from a given details.
@param forward Certificates issued to this CA.
@param reverse Certificates issued by this CA to other CAs.
Produce an object suitable for an Asn1OutputStream.
Returns:
CertificatePair ::= SEQUENCE {
forward [0] Certificate OPTIONAL,
reverse [1] Certificate OPTIONAL,
-- at least one of the pair shall be present -- }
@return a DERObject
@return Returns the forward.
@return Returns the reverse.
Construct a CertificatePolicies object containing one PolicyInformation.
@param name the name to be contained.
Produce an object suitable for an ASN1OutputStream.
CertificatePolicies ::= SEQUENCE SIZE {1..MAX} OF PolicyInformation
CertPolicyId, used in the CertificatePolicies and PolicyMappings
X509V3 Extensions.
CertPolicyId ::= OBJECT IDENTIFIER
Return the distribution points making up the sequence.
@return DistributionPoint[]
Produce an object suitable for an Asn1OutputStream.
CrlDistPoint ::= Sequence SIZE {1..MAX} OF DistributionPoint
The CRLNumber object.
CRLNumber::= Integer(0..MAX)
The CRLReason enumeration.
CRLReason ::= Enumerated {
unspecified (0),
keyCompromise (1),
cACompromise (2),
affiliationChanged (3),
superseded (4),
cessationOfOperation (5),
certificateHold (6),
removeFromCRL (8),
privilegeWithdrawn (9),
aACompromise (10)
}
The DigestInfo object.
DigestInfo::=Sequence{
digestAlgorithm AlgorithmIdentifier,
digest OCTET STRING }
DisplayText class, used in
CertificatePolicies X509 V3 extensions (in policy qualifiers).
It stores a string in a chosen encoding.
DisplayText ::= CHOICE {
ia5String IA5String (SIZE (1..200)),
visibleString VisibleString (SIZE (1..200)),
bmpString BMPString (SIZE (1..200)),
utf8String UTF8String (SIZE (1..200)) }
@see PolicyQualifierInfo
@see PolicyInformation
Constant corresponding to ia5String encoding.
Constant corresponding to bmpString encoding.
Constant corresponding to utf8String encoding.
Constant corresponding to visibleString encoding.
Describe constant DisplayTextMaximumSize here.
Creates a new DisplayText instance.
@param type the desired encoding type for the text.
@param text the text to store. Strings longer than 200
characters are truncated.
Creates a new DisplayText instance.
@param text the text to encapsulate. Strings longer than 200
characters are truncated.
Creates a new DisplayText instance.
Useful when reading back a DisplayText class
from it's Asn1Encodable form.
@param contents an Asn1Encodable instance.
Returns the stored string object.
@return the stored text as a string.
The DistributionPoint object.
DistributionPoint ::= Sequence {
distributionPoint [0] DistributionPointName OPTIONAL,
reasons [1] ReasonFlags OPTIONAL,
cRLIssuer [2] GeneralNames OPTIONAL
}
The DistributionPointName object.
DistributionPointName ::= CHOICE {
fullName [0] GeneralNames,
nameRelativeToCRLIssuer [1] RDN
}
The extendedKeyUsage object.
extendedKeyUsage ::= Sequence SIZE (1..MAX) OF KeyPurposeId
Returns all extended key usages.
The returned ArrayList contains DerObjectIdentifier instances.
@return An ArrayList with all key purposes.
The GeneralName object.
GeneralName ::= CHOICE {
otherName [0] OtherName,
rfc822Name [1] IA5String,
dNSName [2] IA5String,
x400Address [3] ORAddress,
directoryName [4] Name,
ediPartyName [5] EDIPartyName,
uniformResourceIdentifier [6] IA5String,
iPAddress [7] OCTET STRING,
registeredID [8] OBJECT IDENTIFIER}
OtherName ::= Sequence {
type-id OBJECT IDENTIFIER,
value [0] EXPLICIT ANY DEFINED BY type-id }
EDIPartyName ::= Sequence {
nameAssigner [0] DirectoryString OPTIONAL,
partyName [1] DirectoryString }
When the subjectAltName extension contains an Internet mail address,
the address MUST be included as an rfc822Name. The format of an
rfc822Name is an "addr-spec" as defined in RFC 822 [RFC 822].
When the subjectAltName extension contains a domain name service
label, the domain name MUST be stored in the dNSName (an IA5String).
The name MUST be in the "preferred name syntax," as specified by RFC
1034 [RFC 1034].
When the subjectAltName extension contains a URI, the name MUST be
stored in the uniformResourceIdentifier (an IA5String). The name MUST
be a non-relative URL, and MUST follow the URL syntax and encoding
rules specified in [RFC 1738]. The name must include both a scheme
(e.g., "http" or "ftp") and a scheme-specific-part. The scheme-
specific-part must include a fully qualified domain name or IP
address as the host.
When the subjectAltName extension contains a iPAddress, the address
MUST be stored in the octet string in "network byte order," as
specified in RFC 791 [RFC 791]. The least significant bit (LSB) of
each octet is the LSB of the corresponding byte in the network
address. For IP Version 4, as specified in RFC 791, the octet string
MUST contain exactly four octets. For IP Version 6, as specified in
RFC 1883, the octet string MUST contain exactly sixteen octets [RFC
1883].
Create a GeneralName for the given tag from the passed in string.
This constructor can handle:
- rfc822Name
- iPAddress
- directoryName
- dNSName
- uniformResourceIdentifier
- registeredID
For x400Address, otherName and ediPartyName there is no common string
format defined.
Note: A directory name can be encoded in different ways into a byte
representation. Be aware of this if the byte representation is used for
comparing results.
@param tag tag number
@param name string representation of name
@throws ArgumentException if the string encoding is not correct or
not supported.
Construct a GeneralNames object containing one GeneralName.
The name to be contained.
Produce an object suitable for an Asn1OutputStream.
GeneralNames ::= Sequence SIZE {1..MAX} OF GeneralName
Class for containing a restriction object subtrees in NameConstraints. See
RFC 3280.
GeneralSubtree ::= SEQUENCE
{
baseName GeneralName,
minimum [0] BaseDistance DEFAULT 0,
maximum [1] BaseDistance OPTIONAL
}
@see org.bouncycastle.asn1.x509.NameConstraints
Constructor from a given details.
According RFC 3280, the minimum and maximum fields are not used with any
name forms, thus minimum MUST be zero, and maximum MUST be absent.
If minimum is null, zero is assumed, if
maximum is null, maximum is absent.
@param baseName
A restriction.
@param minimum
Minimum
@param maximum
Maximum
Produce an object suitable for an Asn1OutputStream.
Returns:
GeneralSubtree ::= SEQUENCE
{
baseName GeneralName,
minimum [0] BaseDistance DEFAULT 0,
maximum [1] BaseDistance OPTIONAL
}
@return a DERObject
The Holder object.
For an v2 attribute certificate this is:
Holder ::= SEQUENCE {
baseCertificateID [0] IssuerSerial OPTIONAL,
-- the issuer and serial number of
-- the holder's Public Key Certificate
entityName [1] GeneralNames OPTIONAL,
-- the name of the claimant or role
objectDigestInfo [2] ObjectDigestInfo OPTIONAL
-- used to directly authenticate the holder,
-- for example, an executable
}
For an v1 attribute certificate this is:
subject CHOICE {
baseCertificateID [0] IssuerSerial,
-- associated with a Public Key Certificate
subjectName [1] GeneralNames },
-- associated with a name
Constructor for a holder for an v1 attribute certificate.
@param tagObj The ASN.1 tagged holder object.
Constructor for a holder for an v2 attribute certificate. *
@param seq The ASN.1 sequence.
Constructs a holder from a IssuerSerial.
@param baseCertificateID The IssuerSerial.
@param version The version of the attribute certificate.
Returns 1 for v2 attribute certificates or 0 for v1 attribute
certificates.
@return The version of the attribute certificate.
Constructs a holder with an entityName for v2 attribute certificates or
with a subjectName for v1 attribute certificates.
@param entityName The entity or subject name.
Constructs a holder with an entityName for v2 attribute certificates or
with a subjectName for v1 attribute certificates.
@param entityName The entity or subject name.
@param version The version of the attribute certificate.
Constructs a holder from an object digest info.
@param objectDigestInfo The object digest info object.
Returns the entityName for an v2 attribute certificate or the subjectName
for an v1 attribute certificate.
@return The entityname or subjectname.
The Holder object.
Holder ::= Sequence {
baseCertificateID [0] IssuerSerial OPTIONAL,
-- the issuer and serial number of
-- the holder's Public Key Certificate
entityName [1] GeneralNames OPTIONAL,
-- the name of the claimant or role
objectDigestInfo [2] ObjectDigestInfo OPTIONAL
-- used to directly authenticate the holder,
-- for example, an executable
}
Implementation of IetfAttrSyntax as specified by RFC3281.
IetfAttrSyntax ::= Sequence {
policyAuthority [0] GeneralNames OPTIONAL,
values Sequence OF CHOICE {
octets OCTET STRING,
oid OBJECT IDENTIFIER,
string UTF8String
}
}
Produce an object suitable for an Asn1OutputStream.
IssuerSerial ::= Sequence {
issuer GeneralNames,
serial CertificateSerialNumber,
issuerUid UniqueIdentifier OPTIONAL
}
IssuingDistributionPoint ::= SEQUENCE {
distributionPoint [0] DistributionPointName OPTIONAL,
onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
onlySomeReasons [3] ReasonFlags OPTIONAL,
indirectCRL [4] BOOLEAN DEFAULT FALSE,
onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE }
Constructor from given details.
@param distributionPoint
May contain an URI as pointer to most current CRL.
@param onlyContainsUserCerts Covers revocation information for end certificates.
@param onlyContainsCACerts Covers revocation information for CA certificates.
@param onlySomeReasons
Which revocation reasons does this point cover.
@param indirectCRL
If true then the CRL contains revocation
information about certificates ssued by other CAs.
@param onlyContainsAttributeCerts Covers revocation information for attribute certificates.
Constructor from Asn1Sequence
@return Returns the distributionPoint.
@return Returns the onlySomeReasons.
The KeyPurposeID object.
KeyPurposeID ::= OBJECT IDENTIFIER
The KeyUsage object.
id-ce-keyUsage OBJECT IDENTIFIER ::= { id-ce 15 }
KeyUsage ::= BIT STRING {
digitalSignature (0),
nonRepudiation (1),
keyEncipherment (2),
dataEncipherment (3),
keyAgreement (4),
keyCertSign (5),
cRLSign (6),
encipherOnly (7),
decipherOnly (8) }
Basic constructor.
@param usage - the bitwise OR of the Key Usage flags giving the
allowed uses for the key.
e.g. (KeyUsage.keyEncipherment | KeyUsage.dataEncipherment)
Constructor from a given details.
permitted and excluded are Vectors of GeneralSubtree objects.
@param permitted Permitted subtrees
@param excluded Excluded subtrees
NoticeReference class, used in
CertificatePolicies X509 V3 extensions
(in policy qualifiers).
NoticeReference ::= Sequence {
organization DisplayText,
noticeNumbers Sequence OF Integer }
@see PolicyQualifierInfo
@see PolicyInformation
Creates a new NoticeReference instance.
@param organization a String value
@param numbers a Vector value
Creates a new NoticeReference instance.
@param organization a String value
@param noticeNumbers an ASN1EncodableVector value
Creates a new NoticeReference instance.
@param organization displayText
@param noticeNumbers an ASN1EncodableVector value
Creates a new NoticeReference instance.
Useful for reconstructing a NoticeReference
instance from its encodable/encoded form.
@param as an Asn1Sequence value obtained from either
calling @{link ToAsn1Object()} for a NoticeReference
instance or from parsing it from a Der-encoded stream.
Describe ToAsn1Object method here.
@return a Asn1Object value
ObjectDigestInfo ASN.1 structure used in v2 attribute certificates.
ObjectDigestInfo ::= SEQUENCE {
digestedObjectType ENUMERATED {
publicKey (0),
publicKeyCert (1),
otherObjectTypes (2) },
-- otherObjectTypes MUST NOT
-- be used in this profile
otherObjectTypeID OBJECT IDENTIFIER OPTIONAL,
digestAlgorithm AlgorithmIdentifier,
objectDigest BIT STRING
}
The public key is hashed.
The public key certificate is hashed.
An other object is hashed.
Constructor from given details.
If digestedObjectType is not {@link #publicKeyCert} or
{@link #publicKey} otherObjectTypeID must be given,
otherwise it is ignored.
@param digestedObjectType The digest object type.
@param otherObjectTypeID The object type ID for
otherObjectDigest.
@param digestAlgorithm The algorithm identifier for the hash.
@param objectDigest The hash value.
Produce an object suitable for an Asn1OutputStream.
ObjectDigestInfo ::= SEQUENCE {
digestedObjectType ENUMERATED {
publicKey (0),
publicKeyCert (1),
otherObjectTypes (2) },
-- otherObjectTypes MUST NOT
-- be used in this profile
otherObjectTypeID OBJECT IDENTIFIER OPTIONAL,
digestAlgorithm AlgorithmIdentifier,
objectDigest BIT STRING
}
PolicyMappings V3 extension, described in RFC3280.
PolicyMappings ::= Sequence SIZE (1..MAX) OF Sequence {
issuerDomainPolicy CertPolicyId,
subjectDomainPolicy CertPolicyId }
@see RFC 3280, section 4.2.1.6
Creates a new PolicyMappings instance.
@param seq an Asn1Sequence constructed as specified
in RFC 3280
Creates a new PolicyMappings instance.
@param mappings a HashMap value that maps
string oids
to other string oids.
PolicyQualifierId, used in the CertificatePolicies
X509V3 extension.
id-qt OBJECT IDENTIFIER ::= { id-pkix 2 }
id-qt-cps OBJECT IDENTIFIER ::= { id-qt 1 }
id-qt-unotice OBJECT IDENTIFIER ::= { id-qt 2 }
PolicyQualifierId ::=
OBJECT IDENTIFIER ( id-qt-cps | id-qt-unotice )
Policy qualifiers, used in the X509V3 CertificatePolicies
extension.
PolicyQualifierInfo ::= Sequence {
policyQualifierId PolicyQualifierId,
qualifier ANY DEFINED BY policyQualifierId }
Creates a new PolicyQualifierInfo instance.
@param policyQualifierId a PolicyQualifierId value
@param qualifier the qualifier, defined by the above field.
Creates a new PolicyQualifierInfo containing a
cPSuri qualifier.
@param cps the CPS (certification practice statement) uri as a
string.
Creates a new PolicyQualifierInfo instance.
@param as PolicyQualifierInfo X509 structure
encoded as an Asn1Sequence.
Returns a Der-encodable representation of this instance.
@return a Asn1Object value
PrivateKeyUsagePeriod ::= SEQUENCE
{
notBefore [0] GeneralizedTime OPTIONAL,
notAfter [1] GeneralizedTime OPTIONAL }
The BiometricData object.
BiometricData ::= SEQUENCE {
typeOfBiometricData TypeOfBiometricData,
hashAlgorithm AlgorithmIdentifier,
biometricDataHash OCTET STRING,
sourceDataUri IA5String OPTIONAL }
The Iso4217CurrencyCode object.
Iso4217CurrencyCode ::= CHOICE {
alphabetic PrintableString (SIZE 3), --Recommended
numeric INTEGER (1..999) }
-- Alphabetic or numeric currency code as defined in ISO 4217
-- It is recommended that the Alphabetic form is used
The MonetaryValue object.
MonetaryValue ::= SEQUENCE {
currency Iso4217CurrencyCode,
amount INTEGER,
exponent INTEGER }
-- value = amount * 10^exponent
The QCStatement object.
QCStatement ::= SEQUENCE {
statementId OBJECT IDENTIFIER,
statementInfo ANY DEFINED BY statementId OPTIONAL}
The SemanticsInformation object.
SemanticsInformation ::= SEQUENCE {
semanticsIdentifier OBJECT IDENTIFIER OPTIONAL,
nameRegistrationAuthorities NameRegistrationAuthorities
OPTIONAL }
(WITH COMPONENTS {..., semanticsIdentifier PRESENT}|
WITH COMPONENTS {..., nameRegistrationAuthorities PRESENT})
NameRegistrationAuthorities ::= SEQUENCE SIZE (1..MAX) OF
GeneralName
The TypeOfBiometricData object.
TypeOfBiometricData ::= CHOICE {
predefinedBiometricType PredefinedBiometricType,
biometricDataOid OBJECT IDENTIFIER }
PredefinedBiometricType ::= INTEGER {
picture(0),handwritten-signature(1)}
(picture|handwritten-signature)
The ReasonFlags object.
ReasonFlags ::= BIT STRING {
unused(0),
keyCompromise(1),
cACompromise(2),
affiliationChanged(3),
superseded(4),
cessationOfOperation(5),
certficateHold(6)
}
@param reasons - the bitwise OR of the Key Reason flags giving the
allowed uses for the key.
Implementation of the RoleSyntax object as specified by the RFC3281.
RoleSyntax ::= SEQUENCE {
roleAuthority [0] GeneralNames OPTIONAL,
roleName [1] GeneralName
}
RoleSyntax factory method.
@param obj the object used to construct an instance of
RoleSyntax. It must be an instance of RoleSyntax
or Asn1Sequence.
@return the instance of RoleSyntax built from the
supplied object.
@throws java.lang.ArgumentException if the object passed
to the factory is not an instance of RoleSyntax or
Asn1Sequence.
Constructor.
@param roleAuthority the role authority of this RoleSyntax.
@param roleName the role name of this RoleSyntax.
Constructor. Invoking this constructor is the same as invoking
new RoleSyntax(null, roleName).
@param roleName the role name of this RoleSyntax.
Utility constructor. Takes a string argument representing
the role name, builds a GeneralName to hold the role name
and calls the constructor that takes a GeneralName.
@param roleName
Constructor that builds an instance of RoleSyntax by
extracting the encoded elements from the Asn1Sequence
object supplied.
@param seq an instance of Asn1Sequence that holds
the encoded elements used to build this RoleSyntax.
Gets the role authority of this RoleSyntax.
@return an instance of GeneralNames holding the
role authority of this RoleSyntax.
Gets the role name of this RoleSyntax.
@return an instance of GeneralName holding the
role name of this RoleSyntax.
Gets the role name as a java.lang.string object.
@return the role name of this RoleSyntax represented as a
string object.
Gets the role authority as a string[] object.
@return the role authority of this RoleSyntax represented as a
string[] array.
Implementation of the method ToAsn1Object as
required by the superclass ASN1Encodable.
RoleSyntax ::= SEQUENCE {
roleAuthority [0] GeneralNames OPTIONAL,
roleName [1] GeneralName
}
This outputs the key in Pkcs1v2 format.
RSAPublicKey ::= Sequence {
modulus Integer, -- n
publicExponent Integer, -- e
}
Structure for a name or pseudonym.
NameOrPseudonym ::= CHOICE {
surAndGivenName SEQUENCE {
surName DirectoryString,
givenName SEQUENCE OF DirectoryString
},
pseudonym DirectoryString
}
@see org.bouncycastle.asn1.x509.sigi.PersonalData
Constructor from DERString.
The sequence is of type NameOrPseudonym:
NameOrPseudonym ::= CHOICE {
surAndGivenName SEQUENCE {
surName DirectoryString,
givenName SEQUENCE OF DirectoryString
},
pseudonym DirectoryString
}
@param pseudonym pseudonym value to use.
Constructor from Asn1Sequence.
The sequence is of type NameOrPseudonym:
NameOrPseudonym ::= CHOICE {
surAndGivenName SEQUENCE {
surName DirectoryString,
givenName SEQUENCE OF DirectoryString
},
pseudonym DirectoryString
}
@param seq The ASN.1 sequence.
Constructor from a given details.
@param pseudonym The pseudonym.
Constructor from a given details.
@param surname The surname.
@param givenName A sequence of directory strings making up the givenName
Produce an object suitable for an Asn1OutputStream.
Returns:
NameOrPseudonym ::= CHOICE {
surAndGivenName SEQUENCE {
surName DirectoryString,
givenName SEQUENCE OF DirectoryString
},
pseudonym DirectoryString
}
@return an Asn1Object
Contains personal data for the otherName field in the subjectAltNames
extension.
PersonalData ::= SEQUENCE {
nameOrPseudonym NameOrPseudonym,
nameDistinguisher [0] INTEGER OPTIONAL,
dateOfBirth [1] GeneralizedTime OPTIONAL,
placeOfBirth [2] DirectoryString OPTIONAL,
gender [3] PrintableString OPTIONAL,
postalAddress [4] DirectoryString OPTIONAL
}
@see org.bouncycastle.asn1.x509.sigi.NameOrPseudonym
@see org.bouncycastle.asn1.x509.sigi.SigIObjectIdentifiers
Constructor from Asn1Sequence.
The sequence is of type NameOrPseudonym:
PersonalData ::= SEQUENCE {
nameOrPseudonym NameOrPseudonym,
nameDistinguisher [0] INTEGER OPTIONAL,
dateOfBirth [1] GeneralizedTime OPTIONAL,
placeOfBirth [2] DirectoryString OPTIONAL,
gender [3] PrintableString OPTIONAL,
postalAddress [4] DirectoryString OPTIONAL
}
@param seq The ASN.1 sequence.
Constructor from a given details.
@param nameOrPseudonym Name or pseudonym.
@param nameDistinguisher Name distinguisher.
@param dateOfBirth Date of birth.
@param placeOfBirth Place of birth.
@param gender Gender.
@param postalAddress Postal Address.
Produce an object suitable for an Asn1OutputStream.
Returns:
PersonalData ::= SEQUENCE {
nameOrPseudonym NameOrPseudonym,
nameDistinguisher [0] INTEGER OPTIONAL,
dateOfBirth [1] GeneralizedTime OPTIONAL,
placeOfBirth [2] DirectoryString OPTIONAL,
gender [3] PrintableString OPTIONAL,
postalAddress [4] DirectoryString OPTIONAL
}
@return an Asn1Object
Object Identifiers of SigI specifciation (German Signature Law
Interoperability specification).
Key purpose IDs for German SigI (Signature Interoperability
Specification)
Certificate policy IDs for German SigI (Signature Interoperability
Specification)
Other Name IDs for German SigI (Signature Interoperability Specification)
To be used for for the generation of directory service certificates.
ID for PersonalData
Certificate is conform to german signature law.
This extension may contain further X.500 attributes of the subject. See also
RFC 3039.
SubjectDirectoryAttributes ::= Attributes
Attributes ::= SEQUENCE SIZE (1..MAX) OF Attribute
Attribute ::= SEQUENCE
{
type AttributeType
values SET OF AttributeValue
}
AttributeType ::= OBJECT IDENTIFIER
AttributeValue ::= ANY DEFINED BY AttributeType
@see org.bouncycastle.asn1.x509.X500Name for AttributeType ObjectIdentifiers.
Constructor from Asn1Sequence.
The sequence is of type SubjectDirectoryAttributes:
SubjectDirectoryAttributes ::= Attributes
Attributes ::= SEQUENCE SIZE (1..MAX) OF Attribute
Attribute ::= SEQUENCE
{
type AttributeType
values SET OF AttributeValue
}
AttributeType ::= OBJECT IDENTIFIER
AttributeValue ::= ANY DEFINED BY AttributeType
@param seq
The ASN.1 sequence.
Constructor from an ArrayList of attributes.
The ArrayList consists of attributes of type {@link Attribute Attribute}
@param attributes The attributes.
Produce an object suitable for an Asn1OutputStream.
Returns:
SubjectDirectoryAttributes ::= Attributes
Attributes ::= SEQUENCE SIZE (1..MAX) OF Attribute
Attribute ::= SEQUENCE
{
type AttributeType
values SET OF AttributeValue
}
AttributeType ::= OBJECT IDENTIFIER
AttributeValue ::= ANY DEFINED BY AttributeType
@return a DERObject
@return Returns the attributes.
The SubjectKeyIdentifier object.
SubjectKeyIdentifier::= OCTET STRING
Calculates the keyIdentifier using a SHA1 hash over the BIT STRING
from SubjectPublicKeyInfo as defined in RFC3280.
@param spki the subject public key info.
Return a RFC 3280 type 1 key identifier. As in:
(1) The keyIdentifier is composed of the 160-bit SHA-1 hash of the
value of the BIT STRING subjectPublicKey (excluding the tag,
length, and number of unused bits).
@param keyInfo the key info object containing the subjectPublicKey field.
@return the key identifier.
Return a RFC 3280 type 2 key identifier. As in:
(2) The keyIdentifier is composed of a four bit type field with
the value 0100 followed by the least significant 60 bits of the
SHA-1 hash of the value of the BIT STRING subjectPublicKey.
@param keyInfo the key info object containing the subjectPublicKey field.
@return the key identifier.
The object that contains the public key stored in a certficate.
The GetEncoded() method in the public keys in the JCE produces a DER
encoded one of these.
for when the public key is an encoded object - if the bitstring
can't be decoded this routine raises an IOException.
@exception IOException - if the bit string doesn't represent a Der
encoded object.
for when the public key is raw bits...
Produce an object suitable for an Asn1OutputStream.
SubjectPublicKeyInfo ::= Sequence {
algorithm AlgorithmIdentifier,
publicKey BIT STRING }
Target structure used in target information extension for attribute
certificates from RFC 3281.
Target ::= CHOICE {
targetName [0] GeneralName,
targetGroup [1] GeneralName,
targetCert [2] TargetCert
}
The targetCert field is currently not supported and must not be used
according to RFC 3281.
Creates an instance of a Target from the given object.
obj can be a Target or a {@link Asn1TaggedObject}
@param obj The object.
@return A Target instance.
@throws ArgumentException if the given object cannot be
interpreted as Target.
Constructor from Asn1TaggedObject.
@param tagObj The tagged object.
@throws ArgumentException if the encoding is wrong.
Constructor from given details.
Exactly one of the parameters must be not null.
@param type the choice type to apply to the name.
@param name the general name.
@throws ArgumentException if type is invalid.
@return Returns the targetGroup.
@return Returns the targetName.
Produce an object suitable for an Asn1OutputStream.
Returns:
Target ::= CHOICE {
targetName [0] GeneralName,
targetGroup [1] GeneralName,
targetCert [2] TargetCert
}
@return an Asn1Object
Target information extension for attributes certificates according to RFC
3281.
SEQUENCE OF Targets
Creates an instance of a TargetInformation from the given object.
obj can be a TargetInformation or a {@link Asn1Sequence}
@param obj The object.
@return A TargetInformation instance.
@throws ArgumentException if the given object cannot be interpreted as TargetInformation.
Constructor from a Asn1Sequence.
@param seq The Asn1Sequence.
@throws ArgumentException if the sequence does not contain
correctly encoded Targets elements.
Returns the targets in this target information extension.
The ArrayList is cloned before it is returned.
@return Returns the targets.
Constructs a target information from a single targets element.
According to RFC 3281 only one targets element must be produced.
@param targets A Targets instance.
According to RFC 3281 only one targets element must be produced. If
multiple targets are given they must be merged in
into one targets element.
@param targets An array with {@link Targets}.
Produce an object suitable for an Asn1OutputStream.
Returns:
SEQUENCE OF Targets
According to RFC 3281 only one targets element must be produced. If
multiple targets are given in the constructor they are merged into one
targets element. If this was produced from a
{@link Org.BouncyCastle.Asn1.Asn1Sequence} the encoding is kept.
@return an Asn1Object
Targets structure used in target information extension for attribute
certificates from RFC 3281.
Targets ::= SEQUENCE OF Target
Target ::= CHOICE {
targetName [0] GeneralName,
targetGroup [1] GeneralName,
targetCert [2] TargetCert
}
TargetCert ::= SEQUENCE {
targetCertificate IssuerSerial,
targetName GeneralName OPTIONAL,
certDigestInfo ObjectDigestInfo OPTIONAL
}
@see org.bouncycastle.asn1.x509.Target
@see org.bouncycastle.asn1.x509.TargetInformation
Creates an instance of a Targets from the given object.
obj can be a Targets or a {@link Asn1Sequence}
@param obj The object.
@return A Targets instance.
@throws ArgumentException if the given object cannot be interpreted as Target.
Constructor from Asn1Sequence.
@param targets The ASN.1 SEQUENCE.
@throws ArgumentException if the contents of the sequence are
invalid.
Constructor from given targets.
The ArrayList is copied.
@param targets An ArrayList of {@link Target}s.
@see Target
@throws ArgumentException if the ArrayList contains not only Targets.
Returns the targets in an ArrayList.
The ArrayList is cloned before it is returned.
@return Returns the targets.
Produce an object suitable for an Asn1OutputStream.
Returns:
Targets ::= SEQUENCE OF Target
@return an Asn1Object
The TbsCertificate object.
TbsCertificate ::= Sequence {
version [ 0 ] Version DEFAULT v1(0),
serialNumber CertificateSerialNumber,
signature AlgorithmIdentifier,
issuer Name,
validity Validity,
subject Name,
subjectPublicKeyInfo SubjectPublicKeyInfo,
issuerUniqueID [ 1 ] IMPLICIT UniqueIdentifier OPTIONAL,
subjectUniqueID [ 2 ] IMPLICIT UniqueIdentifier OPTIONAL,
extensions [ 3 ] Extensions OPTIONAL
}
Note: issuerUniqueID and subjectUniqueID are both deprecated by the IETF. This class
will parse them, but you really shouldn't be creating new ones.
PKIX RFC-2459 - TbsCertList object.
TbsCertList ::= Sequence {
version Version OPTIONAL,
-- if present, shall be v2
signature AlgorithmIdentifier,
issuer Name,
thisUpdate Time,
nextUpdate Time OPTIONAL,
revokedCertificates Sequence OF Sequence {
userCertificate CertificateSerialNumber,
revocationDate Time,
crlEntryExtensions Extensions OPTIONAL
-- if present, shall be v2
} OPTIONAL,
crlExtensions [0] EXPLICIT Extensions OPTIONAL
-- if present, shall be v2
}
creates a time object from a given date - if the date is between 1950
and 2049 a UTCTime object is Generated, otherwise a GeneralizedTime
is used.
Return our time as DateTime.
A date time.
Produce an object suitable for an Asn1OutputStream.
Time ::= CHOICE {
utcTime UTCTime,
generalTime GeneralizedTime }
UserNotice class, used in
CertificatePolicies X509 extensions (in policy
qualifiers).
UserNotice ::= Sequence {
noticeRef NoticeReference OPTIONAL,
explicitText DisplayText OPTIONAL}
@see PolicyQualifierId
@see PolicyInformation
Creates a new UserNotice instance.
@param noticeRef a NoticeReference value
@param explicitText a DisplayText value
Creates a new UserNotice instance.
@param noticeRef a NoticeReference value
@param str the explicitText field as a string.
Creates a new UserNotice instance.
Useful from reconstructing a UserNotice instance
from its encodable/encoded form.
@param as an ASN1Sequence value obtained from either
calling @{link toASN1Object()} for a UserNotice
instance or from parsing it from a DER-encoded stream.
Generator for Version 1 TbsCertificateStructures.
TbsCertificate ::= Sequence {
version [ 0 ] Version DEFAULT v1(0),
serialNumber CertificateSerialNumber,
signature AlgorithmIdentifier,
issuer Name,
validity Validity,
subject Name,
subjectPublicKeyInfo SubjectPublicKeyInfo,
}
Generator for Version 2 AttributeCertificateInfo
AttributeCertificateInfo ::= Sequence {
version AttCertVersion -- version is v2,
holder Holder,
issuer AttCertIssuer,
signature AlgorithmIdentifier,
serialNumber CertificateSerialNumber,
attrCertValidityPeriod AttCertValidityPeriod,
attributes Sequence OF Attr,
issuerUniqueID UniqueIdentifier OPTIONAL,
extensions Extensions OPTIONAL
}
@param attribute
Produce an object suitable for an Asn1OutputStream.
V2Form ::= Sequence {
issuerName GeneralNames OPTIONAL,
baseCertificateID [0] IssuerSerial OPTIONAL,
objectDigestInfo [1] ObjectDigestInfo OPTIONAL
-- issuerName MUST be present in this profile
-- baseCertificateID and objectDigestInfo MUST NOT
-- be present in this profile
}
Generator for Version 2 TbsCertList structures.
TbsCertList ::= Sequence {
version Version OPTIONAL,
-- if present, shall be v2
signature AlgorithmIdentifier,
issuer Name,
thisUpdate Time,
nextUpdate Time OPTIONAL,
revokedCertificates Sequence OF Sequence {
userCertificate CertificateSerialNumber,
revocationDate Time,
crlEntryExtensions Extensions OPTIONAL
-- if present, shall be v2
} OPTIONAL,
crlExtensions [0] EXPLICIT Extensions OPTIONAL
-- if present, shall be v2
}
Note: This class may be subject to change
Generator for Version 3 TbsCertificateStructures.
TbsCertificate ::= Sequence {
version [ 0 ] Version DEFAULT v1(0),
serialNumber CertificateSerialNumber,
signature AlgorithmIdentifier,
issuer Name,
validity Validity,
subject Name,
subjectPublicKeyInfo SubjectPublicKeyInfo,
issuerUniqueID [ 1 ] IMPLICIT UniqueIdentifier OPTIONAL,
subjectUniqueID [ 2 ] IMPLICIT UniqueIdentifier OPTIONAL,
extensions [ 3 ] Extensions OPTIONAL
}
an X509Certificate structure.
Certificate ::= Sequence {
tbsCertificate TbsCertificate,
signatureAlgorithm AlgorithmIdentifier,
signature BIT STRING
}
an object for the elements in the X.509 V3 extension block.
Convert the value of the passed in extension to an object.
The extension to parse.
The object the value string contains.
If conversion is not possible.
Subject Directory Attributes
Subject Key Identifier
Key Usage
Private Key Usage Period
Subject Alternative Name
Issuer Alternative Name
Basic Constraints
CRL Number
Reason code
Hold Instruction Code
Invalidity Date
Delta CRL indicator
Issuing Distribution Point
Certificate Issuer
Name Constraints
CRL Distribution Points
Certificate Policies
Policy Mappings
Authority Key Identifier
Policy Constraints
Extended Key Usage
Freshest CRL
Inhibit Any Policy
Authority Info Access
Subject Info Access
Logo Type
BiometricInfo
QCStatements
Audit identity extension in attribute certificates.
NoRevAvail extension in attribute certificates.
TargetInformation extension in attribute certificates.
Constructor from Asn1Sequence.
the extensions are a list of constructed sequences, either with (Oid, OctetString) or (Oid, Boolean, OctetString)
constructor from a table of extensions.
it's is assumed the table contains Oid/string pairs.
Constructor from a table of extensions with ordering.
It's is assumed the table contains Oid/string pairs.
Constructor from two vectors
@param objectIDs an ArrayList of the object identifiers.
@param values an ArrayList of the extension values.
return an Enumeration of the extension field's object ids.
return the extension represented by the object identifier
passed in.
@return the extension if it's present, null otherwise.
Extensions ::= SEQUENCE SIZE (1..MAX) OF Extension
Extension ::= SEQUENCE {
extnId EXTENSION.&id ({ExtensionSet}),
critical BOOLEAN DEFAULT FALSE,
extnValue OCTET STRING }
Generator for X.509 extensions
Reset the generator
Add an extension with the given oid and the passed in value to be included
in the OCTET STRING associated with the extension.
OID for the extension.
True if critical, false otherwise.
The ASN.1 object to be included in the extension.
Add an extension with the given oid and the passed in byte array to be wrapped
in the OCTET STRING associated with the extension.
OID for the extension.
True if critical, false otherwise.
The byte array to be wrapped.
Return true if there are no extension present in this generator.
True if empty, false otherwise
Generate an X509Extensions object based on the current state of the generator.
An X509Extensions object
A general class that reads all X9.62 style EC curve tables.
return a X9ECParameters object representing the passed in named
curve. The routine returns null if the curve is not present.
@param name the name of the curve requested
@return an X9ECParameters object or null if the curve is not available.
return the object identifier signified by the passed in name. Null
if there is no object identifier associated with name.
@return the object identifier associated with name, if present.
return a X9ECParameters object representing the passed in named
curve.
@param oid the object id of the curve requested
@return an X9ECParameters object or null if the curve is not available.
return an enumeration of the names of the available curves.
@return an enumeration of the names of the available curves.
ASN.1 def for Diffie-Hellman key exchange KeySpecificInfo structure. See
RFC 2631, or X9.42, for further details.
Produce an object suitable for an Asn1OutputStream.
KeySpecificInfo ::= Sequence {
algorithm OBJECT IDENTIFIER,
counter OCTET STRING SIZE (4..4)
}
ANS.1 def for Diffie-Hellman key exchange OtherInfo structure. See
RFC 2631, or X9.42, for further details.
Produce an object suitable for an Asn1OutputStream.
OtherInfo ::= Sequence {
keyInfo KeySpecificInfo,
partyAInfo [0] OCTET STRING OPTIONAL,
suppPubInfo [2] OCTET STRING
}
table of the current named curves defined in X.962 EC-DSA.
return the X9ECParameters object for the named curve represented by
the passed in object identifier. Null if the curve isn't present.
@param oid an object identifier representing a named curve, if present.
return the object identifier signified by the passed in name. Null
if there is no object identifier associated with name.
@return the object identifier associated with name, if present.
return the named curve name represented by the given object identifier.
returns an enumeration containing the name strings for curves
contained in this structure.
Produce an object suitable for an Asn1OutputStream.
Parameters ::= CHOICE {
ecParameters ECParameters,
namedCurve CURVES.&id({CurveNames}),
implicitlyCA Null
}
ASN.1 def for Elliptic-Curve Curve structure. See
X9.62, for further details.
Produce an object suitable for an Asn1OutputStream.
Curve ::= Sequence {
a FieldElement,
b FieldElement,
seed BIT STRING OPTIONAL
}
ASN.1 def for Elliptic-Curve ECParameters structure. See
X9.62, for further details.
Return the ASN.1 entry representing the Curve.
@return the X9Curve for the curve in these parameters.
Return the ASN.1 entry representing the FieldID.
@return the X9FieldID for the FieldID in these parameters.
Return the ASN.1 entry representing the base point G.
@return the X9ECPoint for the base point in these parameters.
Produce an object suitable for an Asn1OutputStream.
ECParameters ::= Sequence {
version Integer { ecpVer1(1) } (ecpVer1),
fieldID FieldID {{FieldTypes}},
curve X9Curve,
base X9ECPoint,
order Integer,
cofactor Integer OPTIONAL
}
class for describing an ECPoint as a Der object.
Produce an object suitable for an Asn1OutputStream.
ECPoint ::= OCTET STRING
Octet string produced using ECPoint.GetEncoded().
Class for processing an ECFieldElement as a DER object.
Produce an object suitable for an Asn1OutputStream.
FieldElement ::= OCTET STRING
- if q is an odd prime then the field element is
processed as an Integer and converted to an octet string
according to x 9.62 4.3.1.
- if q is 2m then the bit string
contained in the field element is converted into an octet
string with the same ordering padded at the front if necessary.
ASN.1 def for Elliptic-Curve Field ID structure. See
X9.62, for further details.
Constructor for elliptic curves over prime fields
F2.
@param primeP The prime p defining the prime field.
Constructor for elliptic curves over binary fields
F2m.
@param m The exponent m of
F2m.
@param k1 The integer k1 where xm +
xk1 + 1
represents the reduction polynomial f(z).
Constructor for elliptic curves over binary fields
F2m.
@param m The exponent m of
F2m.
@param k1 The integer k1 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
@param k2 The integer k2 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
@param k3 The integer k3 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z)..
Produce a Der encoding of the following structure.
FieldID ::= Sequence {
fieldType FIELD-ID.&id({IOSet}),
parameters FIELD-ID.&Type({IOSet}{@fieldType})
}
id-dsa-with-sha1 OBJECT IDENTIFIER ::= { iso(1) member-body(2)
us(840) x9-57 (10040) x9cm(4) 3 }
X9.63
X9.42
Enum to specify how the associated data will be introduced into the AEAD cipher
during processing.
The basic algorithm marker.
Return a readable version of the algorithm name.
Return any algorithm mode associated with this algorithm marker.
An enum representing all the modes available across the full algorithm set.
Base class for DH keys.
Return the algorithm this DSA key is for.
The key's algorithm.
Return the DH domain parameters associated with this key.
The DH domain parameters for this key.
Return an ASN.1 encoded representation of the implementing key.
An encoded representation of the key.
Class for Digital Signature Algorithm (DSA) private keys.
Base constructor for a Diffie-Hellman private key.
The algorithm marker for this key.
The domain parameters for this key.
The private X value for this key.
Constructor from an algorithm and an encoding of a PrivateKeyInfo object containing a DSA private key.
Algorithm marker to associate with the key.
An encoding of a PrivateKeyInfo object.
Constructor from an algorithm and a PrivateKeyInfo object containing a DSA private key.
Algorithm marker to associate with the key.
A PrivateKeyInfo object.
Return an ASN.1 encoded representation of the implementing key in a PrivateKeyInfo structure.
An encoded representation of the key.
Return the private X value.
Compare this key to another object.
The other object.
true if this equals o, false otherwise.
Return the hashcode for this key.
The key's hashcode.
Class for Diffie-Hellman public keys.
Constructor from an algorithm and an encoding of a SubjectPublicKeyInfo object containing a Diffie-Hellman public key.
Algorithm marker to associate with the key.
An encoding of a SubjectPublicKeyInfo object.
Constructor from an algorithm and a SubjectPublicKeyInfo object containing a Diffie-Hellman public key.
Algorithm marker to associate with the key.
A SubjectPublicKeyInfo object.
Return the public value Y.
Return an ASN.1 encoded representation of the implementing key in a SubjectPublicKeyInfo structure.
An encoded representation of the key.
Base class for DSA keys.
Return the algorithm this DSA key is for.
The key's algorithm.
Return the DSA domain parameters associated with this key.
The DSA domain parameters for this key.
Return an ASN.1 encoded representation of the implementing key.
An encoded representation of the key.
Class for Digital Signature Algorithm (DSA) private keys.
Base constructor for a DSA private key.
The algorithm marker for this key.
The domain parameters for this key.
The private X value for this key.
Constructor from an algorithm and an encoding of a PrivateKeyInfo object containing a DSA private key.
Algorithm marker to associate with the key.
An encoding of a PrivateKeyInfo object.
Constructor from an algorithm and a PrivateKeyInfo object containing a DSA private key.
Algorithm marker to associate with the key.
A PrivateKeyInfo object.
Return an ASN.1 encoded representation of the implementing key in a PrivateKeyInfo structure.
An encoded representation of the key.
Return the private X value.
Compare this key to another object.
The other object.
true if this equals o, false otherwise.
Return the hashcode for this key.
The key's hashcode.
Class for Digital Signature Algorithm (DSA) public keys.
Constructor from an algorithm and an encoding of a SubjectPublicKeyInfo object containing a DSA public key.
Algorithm marker to associate with the key.
An encoding of a SubjectPublicKeyInfo object.
Constructor from an algorithm and a SubjectPublicKeyInfo object containing a DSA public key.
Algorithm marker to associate with the key.
A SubjectPublicKeyInfo object.
Return the public value Y.
Return an ASN.1 encoded representation of the implementing key in a SubjectPublicKeyInfo structure.
An encoded representation of the key.
Base class for Elliptic Curve (EC) keys.
Return the algorithm this Elliptic Curve key is for.
The key's algorithm.
Return the Elliptic Curve domain parameters associated with this key.
The EC domain parameters for the key.
Return an ASN.1 encoded representation of the implementing key.
An encoded representation of the key.
Constructor from an algorithm and an encoding of a PrivateKeyInfo object containing an EC private key.
Algorithm marker to associate with the key.
An encoding of a PrivateKeyInfo object.
Constructor from an algorithm and a PrivateKeyInfo object containing an EC private key.
Algorithm marker to associate with the key.
A PrivateKeyInfo object.
Class for Elliptic Curve (EC) public keys.
Constructor from an algorithm and an encoding of a SubjectPublicKeyInfo object containing an EC public key.
Algorithm marker to associate with the key.
An encoding of a SubjectPublicKeyInfo object.
Constructor from an algorithm and a SubjectPublicKeyInfo object containing an EC public key.
Algorithm marker to associate with the key.
A SubjectPublicKeyInfo object.
Return an ASN.1 encoded representation of the implementing key in a SubjectPublicKeyInfo structure.
An encoded representation of the key.
Base class for Edwards Curve (EdDSA) keys.
Return the algorithm this Elliptic Curve key is for.
The key's algorithm.
Return an ASN.1 encoded representation of the implementing key.
An encoded representation of the key.
Construct a key from an encoding of a PrivateKeyInfo.
@param encoding the DER encoding of the key.
Construct a key from a PrivateKeyInfo.
@param keyInfo the PrivateKeyInfo containing the key.
Class for Edwards Curve EdDSA public keys.
Constructor from an algorithm and an encoding of a SubjectPublicKeyInfo object containing an EC public key.
An encoding of a SubjectPublicKeyInfo object.
Constructor from a SubjectPublicKeyInfo object containing an EdDSA public key.
A SubjectPublicKeyInfo object.
Return an ASN.1 encoded representation of the implementing key in a SubjectPublicKeyInfo structure.
An encoded representation of the key.
Carrier class for a public key and its associated private key. This class will check the key
pair on construction.
Create a public/private key pair.
@param publicKey the public key component.
@param privateKey the private key component.
@throws IllegalArgumentException if the public and private key arguments are inconsistent.
Gets the public key of the pair.
The public key.
Gets the private key of the pair.
The private key.
Base class for a generator of public/private key pairs.
Base parameter type.
Type of the public key in the key pair.
Type of the private key in the key pair.
Return the parameters associated with this key pair generator.
Generate a new key pair in accordance with the generator's parameter set.
A new key pair.
Return an ASN.1 encoded representation of the implementing key.
An encoded representation of the key.
Class for NewHope (NH) private keys.
Constructor from an algorithm and an encoding of a PrivateKeyInfo object containing a NewHope private key.
Algorithm marker to associate with the key.
An encoding of a PrivateKeyInfo object.
Constructor from an algorithm and a PrivateKeyInfo object containing a NewHope private key.
Algorithm marker to associate with the key.
A PrivateKeyInfo object.
Return an ASN.1 encoded representation of the implementing key in a PrivateKeyInfo structure.
An encoded representation of the key.
Class for NewHope (NH) public keys.
Constructor from an algorithm and an encoding of a SubjectPublicKeyInfo object containing a NewHope public key.
Algorithm marker to associate with the key.
An encoding of a SubjectPublicKeyInfo object.
Constructor from an algorithm and a SubjectPublicKeyInfo object containing a NewHope public key.
Algorithm marker to associate with the key.
A SubjectPublicKeyInfo object.
Return an ASN.1 encoded representation of the implementing key in a SubjectPublicKeyInfo structure.
An encoded representation of the key.
Base class for RSA keys.
Note: the module attempts to prevent accidental recent use of RSA keys for signing and encryption purposes by associating
a specific usage with a modulus. If the module is not running in approved mode this behavior can be overridden by
setting the system property "Org.BouncyCastle.Rsa.AllowMultiUse" to "true".
Specific RSA key usages.
No key usage defined yet.
Key usage signing or verification.
Key usage encryption or decryption.
Return the algorithm this RSA key is for.
The key's algorithm.
Return the modulus for this RSA key.
The key's modulus.
Check to see if a key can be used for a specific usage. Essentially this will return false if
the modulus is associated with a different usage already. The system property
"Org.BouncyCastle.Rsa.AllowMultiUse" can be set to "true" to override this check.
true if the modulus is already associated with the usage, or has not being used already; otherwise, false.
Usage for the RSA key.
Return an ASN.1 encoded representation of the implementing key.
An encoded representation of the key.
Class for RSA private keys.
Basic constructor for an RSA private key with CRT factors.
Algorithm marker.
The modulus.
The public exponent.
The private exponent.
The prime P.
The prime Q.
The prime exponent of P.
The prime exponent of Q.
The CRT coefficient.
Basic constructor for an RSA private key with simple components.
Algorithm marker.
The modulus.
The private exponent.
Constructor from an algorithm and an encoding of a PrivateKeyInfo object containing an RSA private key.
Algorithm marker to associate with the key.
An encoding of a PrivateKeyInfo object.
Constructor from an algorithm and a PrivateKeyInfo object containing an RSA private key.
Algorithm marker to associate with the key.
A PrivateKeyInfo object.
Return the public exponent.
Return the private exponent.
Return the prime P.
Return the prime Q.
Return the prime exponent of P.
Return the prime exponent of Q.
Return the CRT coefficient.
Return an ASN.1 encoded representation of the implementing key in a PrivateKeyInfo structure.
An encoded representation of the key.
Class for RSA public keys.
Basic constructor for an RSA public key from its numeric components.
The algorithm marker.
The modulus.
The public exponent.
Constructor from an algorithm and an encoding of a SubjectPublicKeyInfo object containing an RSA public key.
Algorithm marker to associate with the key.
An encoding of a SubjectPublicKeyInfo object.
Constructor from an algorithm and a SubjectPublicKeyInfo object containing an RSA public key.
Algorithm marker to associate with the key.
A SubjectPublicKeyInfo object.
Return the public exponent.
Return an ASN.1 encoded representation of the implementing key in a SubjectPublicKeyInfo structure.
An encoded representation of the key.
Base class for SPHINCS-256 keys.
Return the algorithm this SPHINCS key is for.
The key's algorithm.
Return the digest algorithm used to construct the tree for the public key.
The key digest algorithm for tree construction.
Return the key data (a byte representation of the digest tree used in signature processing).
The key data.
Return an ASN.1 encoded representation of the implementing key.
An encoded representation of the key.
Representation for SPHINCS-256 private keys.
Constructor from an algorithm and an encoding of a PrivateKeyInfo object containing a SPHINCS private key.
Algorithm marker to associate with the key.
An encoding of a PrivateKeyInfo object.
Constructor from an algorithm and a PrivateKeyInfo object containing a SPHINCS private key.
Algorithm marker to associate with the key.
A PrivateKeyInfo object.
Return an ASN.1 encoded representation of the implementing key in a PrivateKeyInfo structure.
An encoded representation of the key.
Return the key data (a byte representation of the digest tree used in signature generation).
The key data.
Representation for SPHINCS-256 public keys.
Constructor from an algorithm and an encoding of a SubjectPublicKeyInfo object containing a SPHINCS public key.
Algorithm marker to associate with the key.
An encoding of a SubjectPublicKeyInfo object.
Constructor from an algorithm and a SubjectPublicKeyInfo object containing a SPHINCS public key.
Algorithm marker to associate with the key.
A SubjectPublicKeyInfo object.
Return an ASN.1 encoded representation of the implementing key in a SubjectPublicKeyInfo structure.
An encoded representation of the key.
Return the key data (a byte representation of the digest tree used in signature verification).
The key data.
Minimal usable parameters.
@param p the prime p defining the Galois field.
@param g the generator of the multiplicative subgroup of order g.
Minimal usable parameters with a private value length (PKCS#3).
@param p the prime p defining the Galois field.
@param g the generator of the multiplicative subgroup of order g.
@param l the maximum bit length for the private value.
Minimal constructor for parameters able to be used to verify a public key.
@param p the prime p defining the Galois field.
@param g the generator of the multiplicative subgroup of order g.
@param q specifies the prime factor of p - 1
Minimal constructor for parameters able to be used to verify a public key with a private value length.
@param p the prime p defining the Galois field.
@param g the generator of the multiplicative subgroup of order g.
@param q specifies the prime factor of p - 1
@param l the maximum bit length for the private value.
Parameters which can verify a public key with private value lengths.
@param p the prime p defining the Galois field.
@param g the generator of the multiplicative subgroup of order g.
@param q specifies the prime factor of p - 1
@param m the minimum bit length for the private value.
@param l the maximum bit length for the private value.
Standard constructor - the full X9.42 parameter set.
@param p the prime p defining the Galois field.
@param g the generator of the multiplicative subgroup of order g.
@param q specifies the prime factor of p - 1
@param j optionally specifies the value that satisfies the equation p = jq+1
@param validation parameters for validating these domain parameters.
X9.42 parameters with private value length.
@param p the prime p defining the Galois field.
@param g the generator of the multiplicative subgroup of order g.
@param q specifies the prime factor of p - 1
@param l the maximum bit length for the private value.
@param validation parameters for validating these domain parameters.
Base constructor - the full domain parameter set.
@param p the prime p defining the Galois field.
@param g the generator of the multiplicative subgroup of order g.
@param q specifies the prime factor of p - 1
@param m the minimum bit length for the private value.
@param l the maximum bit length for the private value.
@param j optionally specifies the value that satisfies the equation p = jq+1
@param validation parameters for validating these domain parameters.
Return the prime p defining the Galois field.
@return the prime p.
Return the generator of the multiplicative subgroup of order g.
@return the generator g.
Return q, the prime factor of p - 1
@return q value
Return the subgroup factor J, which satisifes the equation p=jq+1, if present.
@return subgroup factor, or null.
Return the minimum length of the private value.
@return the minimum length of the private value in bits.
Return the private value length in bits - if set, zero otherwise
@return the private value length in bits, zero otherwise.
General index for DH parameters.
Negotiated Finite Field Diffie-Hellman Ephemeral Parameters
https://tools.ietf.org/html/rfc7919#appendix-A.1
More Modular Exponential (MODP) Diffie-Hellman groups for Internet Key Exchange (IKE)
https://tools.ietf.org/html/rfc3526
Retrieve an DH based domain parameter by parameter ID. A custom parameter set will be returned if one is available.
@param paramID identifier for the domain parameters.
@return the matching domain parameters if found, null otherwise.
Base constructor - a seed, the counter will be set to -1.
@param seed the seed used to generate the parameters.
Constructor with a seed and a (p, q) counter for it.
@param seed the seed used to generate the parameters.
@param counter the counter value associated with using the seed to generate the parameters.
Base constructor with a seed, counter, and usage index.
@param seed the seed value.
@param counter (p, q) counter - -1 if not avaliable.
@param usageIndex the usage index.
Return the (p, q) counter value.
@return the (p, q) counter value, -1 if unavailable.
Return the seed used for the parameter generation.
@return the seed array.
Return the usage index, -1 if none given.
@return the usage index.
Container class for DSA domain parameters.
Validation parameters for confirming DSA parameter generation.
Base constructor - a seed, the counter will be set to -1.
The seed used to generate the parameters.
Constructor with a seed and a (p, q) counter for it.
The seed used to generate the parameters.
The counter value associated with using the seed to generate the parameters.
Base constructor with a seed, counter, and usage index.
The seed value.
(p, q) counter - -1 if not avaliable.
The usage index.
Return the (p, q) counter value.
The (p, q) counter value, -1 if unavailable.
Return the seed used for the parameter generation.
The the seed array.
Return the usage index, -1 if none given.
The usage index.
Container class for Elliptic Curve domain parameters.
Constructor that assumes the co-factor h is 1.
The curve for these domain parameters.
The base point G for the domain parameters.
The order for the domain parameters.
Constructor with explicit co-factor.
The curve for these domain parameters.
The base point G for the domain parameters.
The order for the domain parameters.
The co-factor.
Constructor with explicit co-factor and generation seed.
The curve for these domain parameters.
The base point G for the domain parameters.
The order for the domain parameters.
The co-factor.
The seed value used to generate the domain parameters.
Return the curve associated with these domain parameters.
@return the domain parameters' curve.
Return the base point associated with these domain parameters.
@return the domain parameters' base point.
Return the order associated with these domain parameters.
@return the domain parameters' order.
Return the co-factor associated with these domain parameters.
@return the domain parameters' co-factor.
Return the generation seed associated with these domain parameters.
@return the domain parameters' seed.
Retrieve an EC based domain parameter by OID. A custom curve will be returned if one is available.
@param paramOid object identifier for the domain parameters.
@return the matching domain parameters if found, null otherwise.
Retrieve an EC based domain parameter by parameter ID. A custom curve will be returned if one is available.
@param paramID identifier for the domain parameters.
@return the matching domain parameters if found, null otherwise.
Extension class that identifies this domain parameter set as being the ImplicitlyCa domain
parameters for this JVM.
Base constructor.
The ImplicitlyCa domain parameters.
EC domain parameters associated with a specific object identifier.
Constructor that assumes the co-factor h is 1.
The object identifier that represents these parameters.
The curve for these domain parameters.
The base point G for the domain parameters.
The order for the domain parameters.
Constructor with explicit co-factor.
The object identifier that represents these parameters.
The curve for these domain parameters.
The base point G for the domain parameters.
The order for the domain parameters.
The co-factor.
Constructor with explicit co-factor and generation seed.
The object identifier that represents these parameters.
The curve for these domain parameters.
The base point G for the domain parameters.
The order for the domain parameters.
The co-factor.
The seed value used to generate the domain parameters.
Return object identifier that identifies these parameters.
The OID that names this parameter set.
Return the current wisdom on prime certainty requirements.
A certainty value.
Size of the key being generated.
Collection of methods for producing data length exceptions.
Base error class for operational errors.
The initial value is a placeholder, to be replaced by an actual MAC calculated by the core-mac
tool (as a post-build event).
The first few bytes are "_BCFIPS_MAC_", the rest was randomly generated.
Check to see if the FIPS module is ready for operation.
true if the module is ready for operation with all self-tests complete.
Return true if the module is in error status, false otherwise.
true, if an error has been detected, false otherwise.
Return a message indicating the current status.
READY if all is well, an exception message otherwise.
Return the HMAC used to verify that the code contained in the assembly is the same.
the internally calculated HMAC for the assembly.
this exception is thrown if a buffer that is meant to have output
copied into it turns out to be too short, or if we've been given
insufficient input. In general this exception will Get thrown rather
than an ArrayOutOfBounds exception.
base constructor.
create a DataLengthException with the given message.
@param message the message to be carried with the exception.
Algorithm marker specifically for use with message digests and HMACs.
The algorithm details object for calculators made by this factory.
Create a stream calculator for the digest algorithm associated with this factory. The stream
calculator is used for the actual operation of entering the data to be digested
and producing the digest block.
A calculator producing an IBlockResult with the final digest in it.
Return the block size of the underlying DRBG
Pair for a value exchange algorithm where the responding party has no private key, such as NewHope.
Base constructor.
The responding party's public key.
The calculated shared value.
Return the responding party's public key.
Return the shared value that is associated with the two public keys involved.
The shared value.
An SP800-90A CTR DRBG.
Construct a SP800-90A CTR DRBG.
Minimum entropy requirement is the security strength requested.
@param engine underlying block cipher to use to support DRBG
@param keySizeInBits size of the key to use with the block cipher.
@param securityStrength security strength required (in bits)
@param entropySource source of entropy to use for seeding/reseeding.
@param personalizationString personalization string to distinguish this DRBG (may be null).
@param nonce nonce to further distinguish this DRBG (may be null).
Return the block size (in bits) of the DRBG.
@return the number of bits produced on each internal round of the DRBG.
Return the security strength of the DRBG.
@return the security strength (in bits) of the DRBG.
Populate a passed in array with random data.
@param output output array for generated bits.
@param additionalInput additional input to be added to the DRBG in this step.
@param predictionResistant true if a reseed should be forced, false otherwise.
@return number of bits generated, -1 if a reseed required.
Reseed the DRBG.
@param additionalInput additional input to be added to the DRBG in this step.
Note that the input key must already be large enough to hold its expanded form
Pad out a key for TDEA, setting odd parity for each byte.
@param keyMaster
@param keyOff
@param tmp
@param tmpOff
Initialise the key generator - if strength is set to zero
the key generated will be 192 bits in size, otherwise
strength can be 128 or 192 (or 112 or 168 if you don't count
parity bits), depending on whether you wish to do 2-key or 3-key
triple DES.
the parameters to be used for key generation
Used by both Dual EC and Hash.
Lying entropy source for self testing
Source class for FIPS approved implementations of AES based algorithms.
Raw AES algorithm, can be used for creating general purpose AES keys.
Algorithm tag for AES with 128 bit key.
Algorithm tag for AES with 192 bit key.
Algorithm tag for AES with 256 bit key.
Parameters to use for creating a 128 bit AES key generator.
Parameters to use for creating a 192 bit AES key generator.
Parameters to use for creating a 256 bit AES key generator.
AES in electronic code book (ECB) mode.
AES in cipher block chaining (CBC) mode.
AES in cipher feedback (CFB) mode, 8 bit block size.
AES in cipher feedback (CFB) mode, 128 bit block size.
AES in output feedback (OFB) mode - 128 bit block size.
AES in counter (CTR) mode.
AES in CBC mode with cipher text stealing type CS1.
AES in CBC mode with cipher text stealing type CS2.
AES in CBC mode with cipher text stealing type CS3.
AES in counter with CBC-MAC (CCM).
AES in Galois/Counter Mode (GCM).
AES cipher-based CMAC algorithm.
AES cipher-based GMAC algorithm.
AES as a FIPS SP800-38F/RFC 3394 key wrapper.
AES as a FIPS SP800-38F key wrapper with padding.
AES as a FIPS SP800-38G format preserving encryption.
AES as a FIPS SP800-38G format preserving encryption.
AES key class.
AES key generation parameters base class.
AES key generator.
Generate a key.
An AES key.
Base class for simple AES parameters.
Base class for AES parameters requiring an initialization vector.
Base authentication parameters class for use with MACs.
Base authentication parameters class for use with MACs and AEAD ciphers requiring a nonce or IV.
Create a new parameter set with a different IV based on the output
of the passed in random.
A copy of the current parameter set with the new IV.
A SecureRandom for deriving the IV.
Create a new parameter set with a different IV based on the output
of the passed in random.
A copy of the current parameter set with the new IV.
A SecureRandom for deriving the IV.
Length of the IV to generate.
Base class for AES key wrap parameters.
Source class for FIPS approved mode Diffie-Hellman implementations.
Basic Diffie-Hellman algorithm marker, can be used for creating general purpose Diffie-Hellman keys.
Diffie-Hellman algorithm parameter source.
DHDomainParametersID for the NIST defined DH domain parameters.
Return a list of the common NIST curves.
A list of the common NIST curves.
Parameters for DH key agreement.
Default constructor which specifies returning the raw secret on agreement calculation.
The agreement algorithm.
Add a key material generator for doing final processing on the agreed value.
A new parameter set, including key material generator.
The key material generator to use.
Parameters for DH key pair generation.
Constructor for the default algorithm ID.
DH domain parameters representing the domain parameters for any generated keys will be for.
Constructor for the default algorithm ID.
DH named domain parameters ID representing the domain parameters for any generated keys will be for.
Return the DH domain parameters for this object.
The DH domain parameter set.
Key pair generator for DH. Create one these via CryptoServicesRegistrar.CreateGenerator() using the KeyGenerationParameters
object as the key.
Construct a key pair generator for EC keys,
Domain parameters and algorithm for the generated key.
A source of randomness for calculating the private value.
Generate a new DH key pair.
A new AsymmetricKeyPair containing an DH key pair.
Source class for FIPS approved implementations of Deterministic Random Bit Generators (DRBGs) from SP 800-90A.
HASH DRBG - SHA-1
HASH DRBG - SHA-224
HASH DRBG - SHA-256
HASH DRBG - SHA-384
HASH DRBG - SHA-512
HASH DRBG - SHA-512/224
HASH DRBG - SHA-512/256
HMAC DRBG - SHA-1
HMAC DRBG - SHA-224
HMAC DRBG - SHA-256
HMAC DRBG - SHA-384
HMAC DRBG - SHA-512
HMAC DRBG - SHA-512/224
HMAC DRBG - SHA-512/256
CTR DRBG - 3-Key TripleDES
CTR DRBG - 128 bit AES
CTR DRBG - 192 bit AES
CTR DRBG - 256 bit AES
Service class for DRBG SecureRandom builder retrieval.
Base class for DRBG SecureRandom construction.
Return a builder using an EntropySourceProvider based on the default SecureRandom with
predictionResistant set to false.
Any SecureRandom created from a builder constructed like this will make use of input passed to SecureRandom.setSeed() if
the default SecureRandom does for its generateSeed() call.
A new Builder instance.
Construct a builder with an EntropySourceProvider based on the passed in SecureRandom and the passed in value for prediction resistance.
A new Builder instance.
A source of entropy.
true if this entropySource is prediction resistant, false otherwise.
Create a builder which makes creates the SecureRandom objects from a specified entropy source provider.
Note: If this method is used any calls to setSeed() in the resulting SecureRandom will be ignored.
A new Builder instance.
A provider of EntropySource objects.
Builder for SecureRandom objects based on the FIPS DRBGs.
Set the personalization string for DRBG SecureRandoms created by this builder.
The current Builder instance.
The personalisation string for the underlying DRBG.
Set the security strength required for DRBGs used in building SecureRandom objects.
The current Builder instance.
The security strength (in bits)
Set the amount of entropy bits required for seeding and reseeding DRBGs used in building SecureRandom objects.
The current Builder instance.
The number of bits of entropy to be requested from the entropy source on each seed/reseed.
Build a SecureRandom based on a SP 800-90A DRBG.
nonce value to use in DRBG construction.
specify whether the underlying DRBG in the resulting SecureRandom should reseed on each request for bytes.
a SecureRandom supported by a DRBG.
Build a SecureRandom based on a SP 800-90A DRBG.
Nonce value to use in DRBG construction.
Specify whether the underlying DRBG in the resulting SecureRandom should reseed on each request for bytes.
Initial additional input to be used for generating the initial continuous health check block by the DRBG.
a SecureRandom supported by a DRBG.
Source class for FIPS approved implementations of DSA based algorithms.
DSA key marker, can be used for creating general purpose DSA keys.
DSA algorithm parameter source - default is SHA-384
Configuration parameters for DSA signatures.
Parameters for DSA key pair generation.
Base constructor for the default algorithm ID.
DSA domain parameters representing the parameter set any generated keys will be for.
Return the DSA domain parameters for this object.
The DSA domain parameter set.
Parameters for DSA domain parameter generation.
Construct just from strength (L) with a default value for N (160 for 1024, 256 for greater)
and a default certainty.
Desired length of prime P in bits (the effective key size).
Construct without a usage index, this will do a random construction of G.
Desired length of prime P in bits (the effective key size).
Desired length of prime Q in bits.
Construct for a specific usage index - this has the effect of using verifiable canonical generation of G.
Desired length of prime P in bits (the effective key size).
Desired length of prime Q in bits.
A valid usage index.
Construct from initial prime values, this will do a random construction of G.
The prime P.
The prime Q.
Construct for a specific usage index and initial prime values - this has the effect of using verifiable canonical generation of G.
The prime P.
The prime Q.
Seed used in the generation of (p, q).
A valid usage index.
Domain parameter generator for DSA.
Base constructor.
domain generation parameters.
A source of randomness for the parameter generation.
Generate a new set of DSA domain parameters.
A new set of DSADomainParameters
Domain parameter validator for DSA.
Base constructor - for 186-4
Digest to use in prime calculations.
Source of randomness for prime number testing.
Base constructor.
The version of DSS the validator is for.
Digest to use in prime calculations.
Source of randomness for prime number testing.
Validate P and Q against the passed in seed and counter.
The prime P.
The prime Q.
The seed P and Q were derived from.
The number of iterations required to derive P.
true if the P and Q values are the expected ones, false otherwise.
Do a partial validation of g against p and q.
The prime P.
The prime Q.
The generator G associated with P and Q.
true if the generator is partially valid, false otherwise.
Do a full validation of g against p and q by including the seed and index
associated with g's related parameters.
The prime P.
The prime Q.
The domain parameter seed used to generate p and q.
The 8 bit usage index for G.
The generator G associated with P and Q.
true if the generator is valid, false otherwise.
Key pair generator for DSA. Create one these via CryptoServicesRegistrar.CreateGenerator() using the KeyGenerationParameters
object as the key.
Construct a key pair generator for DSA keys.
Domain parameters and algorithm for the generated key.
A source of randomness for calculating the private value.
Generate a new DSA key pair.
A new AsymmetricKeyPair containing a DSA key pair.
Source class for FIPS approved implementations of Elliptic Curve (EC) algorithms.
Basic Elliptic Curve algorithm marker, can be used for creating general purpose Elliptic Curve keys.
Elliptic Curve DSA algorithm parameter source - default is SHA-384.
Elliptic Curve cofactor Diffie-Hellman algorithm parameter source.
ECDomainParametersID for the NIST defined EC domain parameters.
Return a list of the common NIST curves.
A list of the common NIST curves.
Parameters for EC key agreement.
Default constructor which specifies returning the raw secret on agreement calculation.
The agreement algorithm (DH or CDH).
Add a key material generator for doing final processing on the agreed value.
A new parameter set, including key material generator.
The key material generator to use.
Configuration parameters for EC DSA signatures.
Parameters for EC key pair generation.
Constructor for the default algorithm ID.
EC domain parameters representing the curve any generated keys will be for.
Constructor for the default algorithm ID.
EC named domain parameters ID representing the curve for any generated keys will be for.
Return the EC domain parameters for this object.
The EC domain parameter set.
Key pair generator for EC. Create one these via CryptoServicesRegistrar.CreateGenerator() using the KeyGenerationParameters
object as the key.
Construct a key pair generator for EC keys,
Domain parameters and algorithm for the generated key.
A source of randomness for calculating the private value.
Generate a new EC key pair.
A new AsymmetricKeyPair containing an EC key pair.
Source class for FIPS approved Key Derivation Function (KDF) implementations.
Parameters configuration for ASN X9.63-2001
Algorithm marker for concatenating KDF in FIPS SP 800-56C
Algorithm key builder for HKDF service in RFC 5869, FIPS SP 800-56C
Algorithm marker for Transport Layer Security Version 1.0 (TLSv1.0)
Algorithm marker for Transport Layer Security Version 1.1 (TLSv1.1)
Algorithm marker for Transport Layer Security Version 1.2 (TLSv1.2)
Builder for the TLS 1.0 key derivation function.
Builder for the TLS 1.1/1.2 key derivation function.
Parameters for the X9.63 and CONCATENATION key derivation function.
TLS protocol stages for KDF usage.
Parameters for the TLS 1.0 key derivation function.
Parameters for the TLS 1.1/1.2 key derivation function.
A key material generator based around a KDF.
Construct a KDF to process the agreed value with. The outputSize parameter determines how many bytes
will be generated.
KDF algorithm builder to use for parameter creation.
The iv parameter for KDF initialization.
The size of the output to be generated from the KDF.
Construct a KDF using the given PRF to process the agreed value with. The outputSize parameter determines how many bytes
will be generated.
KDF algorithm builder to use for parameter creation.
The PRF to use in the KDF.
The iv parameter for KDF initialization.
The size of the output to be generated from the KDF.
Generate a byte array containing key material based on the passed in agreed value.
The agreed value calculated during the agreement process.
A byte[] array containing the generated key material to use.
Nonce generator for use with AEAD ciphers such as GCM. The generator guarantees the sequence
number cannot wrap or go backwards.
Return the algorithm these parameters are associated with.
The algorithm these parameters are for.
Source class for FIPS approved implementations of Password-Based Key Derivation algorithms.
Algorithm ID for PBKDF2 (PKCS#5 scheme 2)
PBKDF2 deriver source - default PRF is HMAC(SHA-1)
PBKD parameters.
Specific type for representing FIPS algorithms which act as pseudo-random-functions.
Contruct a PRF algorithm and salt to process the Z value with (as in SP 800-56C)
PRF represent the HMAC algorithm to use.
The salt to use to initialise the PRF
Source class for FIPS approved implementations of RSA algorithms.
RSA OAEP key wrap algorithm parameter source - default is SHA-384
RSA PKCS#1 v1.5 signature algorithm parameter source - default is SHA-384
RSA X9.31 signature algorithm parameter source - default is SHA-384
RSA PSS signature algorithm parameter source - default is SHA-384
OAEP key wrap parameters base class.
PKCS#1.5/X9.31 signature parameters base class.
PSS signature parameters base class.
Parameters for RSA key pair generation.
Base constructor - a default certainty will be calculated.
The public exponent to use.
The key size (in bits)
Base constructor with certainty.
The public exponent to use.
The key size (in bits)
Certainty to use for prime number calculation.
Key pair generator for RSA. Create one these via CryptoServicesRegistrar.CreateGenerator() using the KeyGenerationParameters
object as the key.
Return the block size of the underlying DRBG.
Number of bits produced each cycle.
Return the security strength of the DRBG.
The security strength (in bits) of the DRBG.
Force a reseed of this instance.
Force a reseed with additional input.
Additional input to be used in conjunction with reseed.
Source class for implementations of FIPS approved secure hash algorithms.
The SHA-1 Digest marker.
The SHA-224 Digest marker.
The SHA-256 Digest marker.
The SHA-384 Digest marker.
The SHA-512 Digest marker.
The SHA512(224) Digest marker.
The SHA512(256) Digest marker.
The SHA3-224 Digest marker.
The SHA3-256 Digest marker.
The SHA3-384 Digest marker.
The SHA3-512 Digest marker.
The SHA-1 HMAC parameters source.
The SHA-224 HMAC parameters source.
The SHA-256 HMAC parameters source.
The SHA-384 HMAC parameters source.
The SHA-512 HMAC parameters source.
The SHA-512(224) HMAC parameters source.
The SHA-512(256) HMAC parameters source.
The SHA3-224 HMAC parameters source.
The SHA3-256 HMAC parameters source.
The SHA3-384 HMAC parameters source.
The SHA3-512 HMAC parameters source.
The SHAKE128 parameters source.
The SHAKE256 parameters source.
The cSHAKE128 parameters source.
The cSHAKE256 parameters source.
The KMac128 parameters source.
The KMac256 parameters source.
TheTupleHash128 parameters source.
The TupleHash256 parameters source.
The ParallelHash128 parameters source.
The ParallelHash256 parameters source.
Generic digest parameters.
Generic eXpandable output function (XOF) parameters.
Generic Customizable eXpandable output function (XOF) parameters.
Parameters for HMAC modes.
Return the size of the MAC these parameters are for.
The MAC size in bits.
Create a new parameter set with the specified MAC size associated with it.
The new parameter set.
Mac size in bits.
HMAC key class.
KeyedXof key class.
Source class for FIPS approved implementations of Triple-DES based algorithms.
Raw Triple-DES algorithm, can be used for creating general purpose Triple-DES keys.
Algorithm tag for Triple-DES with 128 bit (112 effective bits) key.
Algorithm tag for Triple-DES with 192 bit (168 effective bits) key.
Parameters to use for creating a 112 bit Triple-DES key generator.
Parameters to use for creating a 168 bit Triple-DES key generator.
Triple-DES in electronic code book (ECB) mode.
Triple-DES in cipher block chaining (CBC) mode.
Triple-DES in cipher feedback (CFB) mode, 8 bit block size.
Triple-DES in cipher feedback (CFB) mode, 128 bit block size.
Triple-DES in output feedback (OFB) mode - 128 bit block size.
Triple-DES in counter (CTR) mode.
Triple-DES in CBC mode with cipher text stealing type CS1.
Triple-DES in CBC mode with cipher text stealing type CS2.
Triple-DES in CBC mode with cipher text stealing type CS3.
Triple-DES as a FIPS SP800-38F/RFC 3394 key wrapper.
Triple-DES cipher-based CMAC algorithm.
Triple-DES key class.
Triple-DES key generation parameters base class.
Triple-DES key generator.
Base class for simple Triple-DES parameters.
Base class for Triple-DES parameters requiring an initialization vector.
Base authentication parameters class for use with MACs.
Base class for Triple-DES key wrap parameters.
Construct a SP800-90A Hash DRBG.
Minimum entropy requirement is the security strength requested.
@param digest source digest to use for DRB stream.
@param securityStrength security strength required (in bits)
@param entropySource source of entropy to use for seeding/reseeding.
@param personalizationString personalization string to distinguish this DRBG (may be null).
@param nonce nonce to further distinguish this DRBG (may be null).
Return the block size (in bits) of the DRBG.
@return the number of bits produced on each internal round of the DRBG.
Return the security strength of the DRBG.
@return the security strength (in bits) of the DRBG.
Populate a passed in array with random data.
@param output output array for generated bits.
@param additionalInput additional input to be added to the DRBG in this step.
@param predictionResistant true if a reseed should be forced, false otherwise.
@return number of bits generated, -1 if a reseed required.
Reseed the DRBG.
@param additionalInput additional input to be added to the DRBG in this step.
A SP800-90A HMAC DRBG.
Construct a SP800-90A Hash DRBG.
Minimum entropy requirement is the security strength requested.
@param hMac Hash MAC to base the DRBG on.
@param securityStrength security strength required (in bits)
@param entropySource source of entropy to use for seeding/reseeding.
@param personalizationString personalization string to distinguish this DRBG (may be null).
@param nonce nonce to further distinguish this DRBG (may be null).
Return the block size (in bits) of the DRBG.
@return the number of bits produced on each round of the DRBG.
Return the security strength of the DRBG.
@return the security strength (in bits) of the DRBG.
Populate a passed in array with random data.
@param output output array for generated bits.
@param additionalInput additional input to be added to the DRBG in this step.
@param predictionResistant true if a reseed should be forced, false otherwise.
@return number of bits generated, -1 if a reseed required.
Reseed the DRBG.
@param additionalInput additional input to be added to the DRBG in this step.
Source class for non-approved mode AES based modes and algorithms.
AES in OpenPGP CFB Mode.
Base class for general AES parameters requiring an initialization vector.
Base authentication parameters class for use with MACs and AEAD ciphers requiring a nonce or IV.
Source class for ARC4/RC4 based algorithms.
Raw ARC4/RC4 algorithm, can be used for creating general purpose Camellia keys.
Parameters to use for creating an ARC4/RC4 key generator (default is 128 bits).
Standard ARC4/RC4 stream mode.
ARC4/RC4 key class.
Base ARC4/RC4 key generation parameters.
ARC4/RC4 key generator.
Generate a key.
An ARC4 key.
Base class for stanard ARC4/RC4 mode of operation.
Source class for Camellia based algorithms.
Raw Camellia algorithm, can be used for creating general purpose Camellia keys.
Algorithm tag for Camellia with 128 bit key.
Algorithm tag for Camellia with 192 bit key.
Algorithm tag for Camellia with 256 bit key.
Parameters to use for creating a 128 bit Camellia key generator.
Parameters to use for creating a 192 bit Camellia key generator.
Parameters to use for creating a 256 bit Camellia key generator.
Camellia in electronic code book (ECB) mode.
Camellia in cipher block chaining (CBC) mode.
Camellia in cipher feedback (CFB) mode, 8 bit block size.
Camellia in cipher feedback (CFB) mode, 128 bit block size.
Camellia in output feedback (OFB) mode - 128 bit block size.
Camellia in counter (CTR) mode.
Camellia in CBC mode with cipher text stealing type CS1.
Camellia in CBC mode with cipher text stealing type CS2.
Camellia in CBC mode with cipher text stealing type CS3.
Camellia in counter with CBC-MAC (CCM).
Camellia in Galois/Counter Mode (GCM).
Camellia in OpenPGP CFB Mode.
Camellia cipher-based CMAC algorithm.
Camellia cipher-based GMAC algorithm.
Camellia as a General SP800-38F/RFC 3657 key wrapper.
Camellia as a General SP800-38F key wrapper with padding.
Camellia key class.
Camellia key generation parameters base class.
Camellia key generator.
Generate a key.
A Camellia key.
Base class for simple Camellia parameters.
Base class for Camellia parameters requiring an initialization vector.
Base authentication parameters class for use with MACs.
Base authentication parameters class for use with MACs and AEAD ciphers requiring a nonce or IV.
Base class for Camellia key wrap parameters.
ChaCha in eSTREAM mode, as described in the eSTREAM submission, with an 8 byte nonce.
ChaCha in IETF mode, as described in RFC 7539, with a 12 byte nonce.
ChaCha key class.
ChaCha key generation parameters base class.
ChaCha key generator.
Generate a key.
A ChaCha key.
Source class for non-FIPS implementations of DSA based algorithms.
Source class for non-FIPS implementations of Elliptic Curve (EC) based algorithms.
Source class for Edwards Curve EC Signature Algorithms
Key pair generator for EdDSA. Create one these via CryptoServicesRegistrar.CreateGenerator() using the KeyGenerationParameters
object as the key.
Construct a key pair generator for EC keys,
Algorithm for the generated key.
A source of randomness for calculating the private value.
Generate a new EdDSA key pair.
A new AsymmetricKeyPair containing an EdDSA key pair.
ElGamal OAEP key wrap algorithm parameter source - default is SHA-384
ElGamal PKCS#1.5 key wrap algorithm parameter source.
OAEP key wrap parameters base class.
Parameters for use with PKCS#1 v1.5 formatted key wrapping/unwrapping and encryption/decryption.
ElGamal key pair generation parameters.
Base constructor for specific domain parameters.
@param domainParameters the DH domain parameters.
Constructor for specifying the ElGamal algorithm explicitly.
@param parameters the particular parameter set to generate keys for.
@param domainParameters DH domain parameters representing the curve any generated keys will be for.
ElGamal key pair generator class.
Source class for the PQC key-exchange algorithm NewHope
Raw NewHope algorithm marker.
Perform key exchange calculations using SHA3_256 to process the result.
Service generator handle for NewHope key pair generation.
Base class for the NewHope key exchange parameters.
Parameters for NewHope key pair generation.
Base class for NewHope key pair generation.
Source class for implementations of Password-Based Key Derivation Algorithms
Algorithm ID for PKCS#12
Algorithm ID for OpenSSL
PKCS#12 PBE algorithm parameter source - default PRF is SHA-1
OpenSSL PBE algorithm parameter source - PRF is MD5
PKCS12 password based key deriver builder service.
OpenSSL password based key deriver builder service.
General PBKD parameters.
OpenSSL PBKD parameters.
Source class for Poly1305 MAC calculators.
Raw Poly1305 algorithm, can be used for creating general purpose Poly1305 keys.
Parameters to use for creating a 256 bit Poly1305 key generator.
Standard Poly1305 MAC mode.
Base authentication parameters class for use the Poly1305 MAC.
Return the size of the MAC these parameters are for.
The MAC size in bits.
Create a new parameter set with the specified MAC size associated with it.
The new parameter set.
Mac size in bits.
Poly1305 key class.
Poly1305 key generation parameters base class.
Poly1305 key generator.
Generate a key.
A Poly1305 key.
RSA PKCS#1.5 key wrap algorithm parameter source.
Parameters for use with PKCS#1 v1.5 formatted key wrapping/unwrapping and encryption/decryption.
Source class for SEED based algorithms.
Raw SEED algorithm, can be used for creating general purpose SEED keys.
Parameters to use for creating a 128 bit SEED key generator.
SEED in electronic code book (ECB) mode.
SEED in cipher block chaining (CBC) mode.
SEED in cipher feedback (CFB) mode, 8 bit block size.
SEED in cipher feedback (CFB) mode, 128 bit block size.
SEED in output feedback (OFB) mode - 128 bit block size.
SEED in counter (CTR) mode.
SEED in CBC mode with cipher text stealing type CS1.
SEED in CBC mode with cipher text stealing type CS2.
SEED in CBC mode with cipher text stealing type CS3.
SEED in counter with CBC-MAC (CCM).
SEED in Galois/Counter Mode (GCM).
SEED cipher-based CMAC algorithm.
SEED cipher-based GMAC algorithm.
SEED as a General SP800-38F/RFC 4010 key wrapper.
SEED as a General SP800-38F key wrapper with padding.
SEED key class.
SEED key generation parameters base class.
SEED key generator.
Generate a key.
A SEED key.
Base class for simple SEED parameters.
Base class for SEED parameters requiring an initialization vector.
Base authentication parameters class for use with MACs.
Base authentication parameters class for use with MACs and AEAD ciphers requiring a nonce or IV.
Base class for SEED key wrap parameters.
Source class for Serpent based algorithms.
Raw Serpent algorithm, can be used for creating general purpose Serpent keys.
Algorithm tag for Serpent with 128 bit key.
Algorithm tag for Serpent with 192 bit key.
Algorithm tag for Serpent with 256 bit key.
Parameters to use for creating a 128 bit Serpent key generator.
Parameters to use for creating a 192 bit Serpent key generator.
Parameters to use for creating a 256 bit Serpent key generator.
Serpent in electronic code book (ECB) mode.
Serpent in cipher block chaining (CBC) mode.
Serpent in cipher feedback (CFB) mode, 8 bit block size.
Serpent in cipher feedback (CFB) mode, 128 bit block size.
Serpent in output feedback (OFB) mode - 128 bit block size.
Serpent in counter (CTR) mode.
Serpent in CBC mode with cipher text stealing type CS1.
Serpent in CBC mode with cipher text stealing type CS2.
Serpent in CBC mode with cipher text stealing type CS3.
Serpent in counter with CBC-MAC (CCM).
Serpent in Galois/Counter Mode (GCM).
Serpent cipher-based CMAC algorithm.
Serpent cipher-based GMAC algorithm.
Serpent as a General SP800-38F key wrapper.
Serpent as a General SP800-38F key wrapper with padding.
Serpent key class.
Serpent key generation parameters base class.
Serpent key generator.
Generate a key.
A Serpent key.
Base class for simple Serpent parameters.
Base class for Serpent parameters requiring an initialization vector.
Base authentication parameters class for use with MACs.
Base authentication parameters class for use with MACs and AEAD ciphers requiring a nonce or IV.
Base class for Serpent key wrap parameters.
Source class for the PQC signature algorithm SPHINCS-256
Raw SPHINCS-256 algorithm marker.
Base parameters object for SPHINCS-256 - default is SHA-512.
Parameters for SPHINCS-256 key pair generation.
Constructor for the default algorithm ID.
Constructor specifying a particular tree digest.
Tree digest to use for key and eventual signature construction
Return the digest algorithm used to construct the tree for the public key.
The key digest algorithm for tree construction.
Key pair generator for SPHINCS-256. Create one these via CryptoServicesRegistrar.CreateGenerator() using the KeyGenerationParameters
object as the key.
Construct a key pair generator for SPHINCS-256 keys,
Domain parameters and algorithm for the generated key.
A source of randomness for calculating the private value.
Generate a new SPHINCS-256 key pair.
A new AsymmetricKeyPair containing an SPHINCS-256 key pair.
Source class for non-approved mode Triple-DES based modes and algorithms.
Triple-DES in OpenPGP CFB Mode.
Base class for general Triple-DES parameters requiring an initialization vector.
Base authentication parameters class for use with MACs and AEAD ciphers requiring a nonce or IV.
General service interface for block ciphers that can be used with AEAD algorithms.
Extension of cipher which provides for the processing of AAD in addition to the plain text/cipher text.
Gets the stream for reading/writing data to be processed.
The stream associated representing the AAD for this cipher.
Gets the size of the MAC.
The size of the MAC.
Return the MAC calculated processing the data given to this cipher.
The AEAD cipher's MAC.
Base interface for AEAD cipher builders.
algorithm details type parameter.
Build a cipher for the algorithm and parameter details in this builder.
The manner in which associated data will be introduced.
The stream to write/read any encrypted/decrypted data.
Service interface for AEAD ciphers.
Return an AEAD cipher builder which will build decrypting ciphers.
The type of the details for AEAD cipher to be produced.
The algorithm and parameter details for the type of AEAD cipher to be produced.
Return an AEAD cipher builder which will build encrypting ciphers.
The type of the details for AEAD cipher to be produced.
The algorithm and parameter details for the type of AEAD cipher to be produced.
Interface for a provider of AEAD decryptor builders.
The algorithm/parameter details type the builders are for.
Create an AEAD decryptor builder for the given details.
The algorithm/parameter details type the builder is for.
An AEAD cipher builder which produces decryptors for the given details.
Interface for a provider of AEAD encryptor builders.
The algorithm/parameter details type the builders are for.
Create an AEAD encryptor builder for the given details.
The algorithm/parameter details type the builder is for.
An AEAD cipher builder which produces encryptors for the given details.
Base interface for a calculator used in key agreement.
The algorithm/parameter details type the agreement calculators are for.
The algorithm details object for calculators made by this factory.
Calculate the agreement using the passed in public key.
The public key of the other party.
A byte array containing the agreed value.
Interface for a provider of key agreement calculators.
The algorithm/parameter details type the key agreement calculators are for.
Return a key agreement calculator as described in the passed in algorithm details object.
The details of the key agreement algorithm is required.
A new agreement.
Base interface for a service to support the creation of key agreement calculators.
Return a key agreement calculator as described in the passed in algorithm details object.
The type of the details for the key agreement algorithm to be produced.
The details of the key agreement algorithm is required.
A new agreement.
Base interface for mapping from an alphabet to a set of indexes
suitable for use with FPE.
Return the number of characters in the alphabet.
the radix for the alphabet.
Return the passed in char[] as a byte array of indexes (indexes
can be more than 1 byte)
an index array.
characters to be mapped.
Return a char[] for this alphabet based on the indexes passed.
an array of char corresponding to the index values.
input array of indexes.
Base interface for Public/Private keys.
Return an ASN.1 encoding of the key wrapped in a PrivateKeyInfo or a SubjectPublicKeyInfo structure.
An encoding of a PrivateKeyInfo or a SubjectPublicKeyInfo structure.
Base interface for a generator of public/private key pairs.
Base parameter type.
Type of the public key in the key pair.
Type of the private key in the key pair.
Return the parameters associated with this key pair generator.
Generate a new key pair in accordance with the generator's parameter set.
A new key pair.
Marker interface for private keys.
Marker interface for public keys.
Base interface for authentication parameters (used with MAC/HMAC algorithms).
Underlying type implementing the interface.
The algorithm marker type.
Return the size of the MAC these parameters are for.
The MAC size in bits.
Create a new parameter set with the specified MAC size associated with it.
The new parameter set.
Mac size in bits.
Base interface for authentication parameters with IVs (used with AEAD algorithms).
Underlying type implementing the interface.
The algorithm marker type.
Return an implementation of the parameters with an IV constructed from the passed in SecureRandom of length ivLen.
A new set of parameters.
Source of randomness for iv (nonce)
Length of the iv (nonce) in bytes to use with the algorithm.
Base interface for a cipher that requires block aligned input.
The block size for this cipher.
The size of the block.
Return the size of the output buffer required for a Write() plus a
close() with the write() being passed inputLen bytes.
The returned size may be dependent on the initialisation of this cipher
and may not be accurate once subsequent input data is processed as the cipher may
add, add or remove padding, as it sees fit.
The space required to accommodate a call to processBytes and doFinal with inputLen bytes of input.
The length of the expected input.
Return the size of the output buffer required for a write() with the write() being
passed inputLen bytes and just updating the cipher output.
The space required to accommodate a call to processBytes with inputLen bytes of input.
The length of the expected input.
Gets the stream for reading/writing data processed/to be processed.
The stream associated with this block cipher.
Base interface for block cipher builders.
algorithm details type parameter.
Return the algorithm and parameter details associated with any block cipher built.
Return the blocksize for the underlying block cipher.
Return the maximum output size that a given input will produce.
the length of the expected input.
The maximum possible output size that can produced for the expected input length.
Build a cipher that operates on the passed in stream and uses the passed in padding.
The stream to write/read any encrypted/decrypted data.
The padding to use with the data processed.
A cipher based around the given stream and padding
Build a block cipher that operates on the passed in stream.
The stream to write/read any encrypted/decrypted data.
A cipher based around the given stream.
Service interface for block ciphers.
Return a block cipher builder for decrypting block ciphers.
The type of the details for the block cipher to be produced.
The algorithm and parameter details for the type of block cipher to be produced.
A builder for decrypting block ciphers for the passed in details.
Return a block cipher builder for encrypting block ciphers.
The type of the details for the block cipher to be produced.
The algorithm and parameter details for the type of block cipher to be produced.
A builder for encrypting block ciphers for the passed in details.
Return a block cipher builder for decrypting ciphers.
The type of the details for the cipher to be produced.
The algorithm and parameter details for the type of cipher to be produced.
A builder for decrypting ciphers for the passed in details.
Return a block cipher builder for encrypting ciphers.
The type of the details for the cipher to be produced.
The algorithm and parameter details for the type of cipher to be produced.
A builder for encrypting ciphers for the passed in details.
Return a key wrapper.
The type of the details for the key wrapper to be produced.
The algorithm and parameter details for the type of key wrapper to be produced.
A key wrapper for the passed in details.
Return a key unwrapper.
The type of the details for the key unwrapper to be produced.
The algorithm and parameter details for the type of key unwrapper to be produced.
A key unwrapper for the passed in details.
Interface for a provider of block cipher decryptor builders.
The algorithm/parameter details type the builders are for.
Create a block decryptor builder for the given details.
The algorithm/parameter details type the builder is for.
A block cipher builder which produces decryptors for the given details.
Interface for a provider of block cipher encryptor builders.
The algorithm/parameter details type the builders are for.
Create a block encryptor builder for the given details.
The algorithm/parameter details type the builder is for.
A block cipher builder which produces encryptors for the given details.
Operators that reduce their input to a single block return an object
of this type.
Return the number of bytes in the result
The length of the result in bytes.
Return the final result of the operation. Note: this a reference, clearing it will
have the same effect as clearing the object.
A block of bytes, representing the result of an operation.
Store the final result of the operation by copying it into the destination array. Note:
this has the effect of clearing the object.
The number of bytes copied into destination.
The byte array to copy the result into.
The offset into destination to start copying the result at.
Return type for operators that produce a block of data and an associated message digest.
Return the digest associated with the final result of the operation. Note: this a reference, clearing it will
have the same effect as clearing the object.
A digest associated with the result of an operation.
Store the digest associated with the final result of the operation by copying it into the destination array. Note:
this has the effect of clearing the object.
The number of bytes copied into destination.
The byte array to copy the digest into.
The offset into destination to start copying the digest at.
Return type for operators that produce a block of data and an associated recovered message.
Return the recovered message associated with this result.
a recovered message object.
Interface for a converter that produces a byte encoding for a char array.
Return the type of the conversion.
The type name for the conversion.
Return a byte encoded representation of the passed in char array.
The char array to convert
A byte encoding of str.
Base interface for a ciphers that do not require data to be block aligned.
Note: In cases where the underlying algorithm is block based, these ciphers may add or remove padding as needed.
Return the size of the output buffer required for a Write() plus a
close() with the write() being passed inputLen bytes.
The returned size may be dependent on the initialisation of this cipher
and may not be accurate once subsequent input data is processed as the cipher may
add, add or remove padding, as it sees fit.
The space required to accommodate a call to processBytes and doFinal with inputLen bytes of input.
The length of the expected input.
Return the size of the output buffer required for a write() with the write() being
passed inputLen bytes and just updating the cipher output.
The space required to accommodate a call to processBytes with inputLen bytes of input.
The length of the expected input.
Gets the stream for reading/writing data processed/to be processed.
The stream associated with this cipher.
Base interface for cipher builders.
algorithm details type parameter.
Return the algorithm and parameter details associated with any cipher built.
Return the maximum output size that a given input will produce.
the length of the expected input.
The maximum possible output size that can produced for the expected input length.
Build a cipher that operates on the passed in stream.
The stream to write/read any encrypted/decrypted data.
A cipher based around the given stream.
A cipher builder that can also return the key it was initialized with.
The algorithm details parameter type.
Return the key we were initialized with.
Marker interface for classes that can be used with CryptoServicesRegistrar.CreateService()
The service produced.
Marker interface for classes that can be used with CryptoServicesRegistrar.CreateGenerator()
The generator produced.
Marker interface for factory classes that can be used with CryptoServicesRegistrar.CreateService()
The factory service produced.
Marker interface for builder classes that can be used with CryptoServicesRegistrar.CreateService()
The builder service produced.
Base interface for factories that produce stream-based signature verifiers which are only
valid within a particular date range.
Configuration parameters type for the verifiers.
Return true if this verify is valid at the passed in time.
The date/time to check validity of the verifier at.
true if a signature at dateTime is valid, false otherwise.
Interface describing a provider of cipher builders for creating decrypting ciphers.
The algorithm details/parameter type for the cipher builders produced.
Return a cipher builder for creating decrypting ciphers.
The algorithm details/parameters to use to create the final cipher.
A new cipher builder.
Base interface for operator factories that create stream-based digest calculators.
The algorithm details/parameter type for the digest factory.
The algorithm details object for calculators made by this factory.
Return the size of the digest associated with this factory.
The length of the digest produced by this calculators from this factory in bytes.
Create a stream calculator for the digest associated with this factory. The stream
calculator is used for the actual operation of entering the data to be digested
and producing the digest block.
A calculator producing an IBlockResult with the final digest in it.
Interface describing a provider of digest factory objects.
The algorithm details/parameter type for the digest factories produced.
Return a new digest factory for the passed in algorithm details.
The algorithm details/parameters to use to create the factory.
A new digest factory.
Interface to SP800-90A/X9.31 deterministic random bit generators.
Return the block size of the DRBG.
The block size (in bits) produced by each round of the DRBG.
Return the security strength of the DRBG.
The security strength (in bits) of the DRBG.
Populate a passed in array with random data.
Output array for generated bits.
Additional input to be added to the DRBG in this step.
true if a reseed should be forced, false otherwise.
number of bits generated, -1 if a reseed required.
Reseed the DRBG.
Additional input to be added to the DRBG in this step.
Return a KAT for the DRBG - used prior to initialisation.
A self test
The algorithm type
Return a KAT for the DRBG - used prior to reseed.
A reseed self test
The algorithm type
Interface for builders of SecureRandom objects based on DRBGs.
The type of SecureRandom produced, e.g. FipsSecureRandom
Set the personalization string to be used in building the final DRBG.
The personalization string for the final DRBG.
The current builder.
Set the security strength for the underlying DRBG.
The current builder.
Set how many bits of entropy are required for each reseeding of the DRBG.
Number of entropy bit required on a seed/reseed.
The current builder.
Produce a SecureRandom of type TRand based on a DRBG.
A nonce to use in underlying DRBG initialization.
True if the underlying DRBG is to be operated in prediction resistant mode, false otherwise.
The final SecureRandom built from an underlying DRBG.
Produce a SecureRandom of type TRand based on a DRBG.
A nonce to use in underlying DRBG initialization.
True if the underlying DRBG is to be operated in prediction resistant mode, false otherwise.
An additional input parameter for DRBG intialization.
The final SecureRandom built from an underlying DRBG.
Service interface for builders of SecureRandom objects based on DRBGs.
The type of SecureRandom produced, e.g. FipsSecureRandom
Create a builder for a DRBG that will be seeded using the default entropy source for the module.
A builder for a SecureRandom based on a DRBG.
Create a builder for a DRBG that will be seeded using the passed in entropy source based on
a SecureRandom which should be considered to be prediction resistant or not.
A source of entropy for DRBG seeding.
true if the entropy source can be considered prediction resistant, false otherwise.
A builder for a SecureRandom based on a DRBG seeded using entropySource.
Create a builder for a DRBG that will be seeded using entropy sources created from the passed in entropy source provider.
A provider of entropy sources.
A builder for a SecureRandom based on a DRBG seeded using entropy sources from the provider.
Base interface describing an entropy source for a DRBG.
Return whether or not this entropy source is regarded as prediction resistant.
true if this instance is prediction resistant; otherwise, false.
Return a byte array of entropy.
The entropy bytes.
Return the number of bits of entropy this source can produce.
The size, in bits, of the return value of getEntropy.
Base interface describing a provider of entropy sources.
Return an entropy source providing a block of entropy.
The size of the block of entropy required.
An entropy source providing bitsRequired blocks of entropy.
Service interface for NewHope style key material exchange generators.
Generate an exchange pair based on the sender public key.
The public key of the exchange initiator.
An ExchangePair derived from the sender public key.
Base interface factories that produce KDF output.
The algorithm details object for KDF results made by this factory.
Provide a result block of the given size in bytes.
The number of bytes contained in the result.
a block result containing the generated bytes.
Service interface for KDF calculators.
Create a KDF calculator configured using the algorithmDetails parameter.
The parameter type associated with algorithmDetails
The configuration parameters for the returned KDF calculator.
A new KDF calculator.
Base interface for keys.
Gets the algorithm the key is for.
The key's algorithm.
Determines whether the specified is equal to the current .
The to compare with the current .
true if the specified is equal to the current
; otherwise, false.
Return the hash code for the key.
A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.
Base interface for a key unwrapper.
The algorithm details/parameter type for the key unwrapper.
The parameter set used to configure this key unwrapper.
Unwrap the passed in data.
The array containing the data to be unwrapped.
The offset into cipherText at which the unwrapped data starts.
The length of the data to be unwrapped.
an IBlockResult containing the unwrapped key data.
Interface describing a provider of key unwrapper objects.
The algorithm details/parameter type for the key unwrappers produced.
Return a new key unwrapper for the passed in algorithm details.
The algorithm details/parameters to use to create the unwrapper.
A new key unwrapper.
Service interface for key unwrappers.
Create a key unwrapper configured using the algorithmDetails parameter.
The parameter type associated with algorithmDetails
The configuration parameters for the returned key unwrapper.
A new key unwrapper.
Base interface for a key wrapper.
The algorithm details/parameter type for the key wrapper.
The parameter set used to configure this key wrapper.
Wrap the passed in key data.
The key data to be wrapped.
an IBlockResult containing the wrapped key data.
Interface describing a provider of key wrapper objects.
The algorithm details/parameter type for the key wrappers produced.
Return a new key wrapper for the passed in algorithm details.
The algorithm details/parameters to use to create the wrapper.
A new key wrapper.
Service interface for key wrappers.
Create a make factory configured using the algorithmDetails parameter.
The parameter type associated with algorithmDetails
The configuration parameters for the returned key wrapper.
A new key wrapper.
Base interface for key material generators used in key agreement.
Generate key material using the passed in agreed value.
The agreed value calculated from key agreement.
The key material derived from agreed and any internal parameters.
Base interface for operator factories that create stream-based MAC calculators.
The algorithm details object for calculators made by this factory.
Return the size of the MAC associated with this factory.
The length of the MAC produced by this calculators from this factory in bytes.
Create a stream calculator for the MAC associated with this factory. The stream
calculator is used for the actual operation of entering the data into the MAC calculator
and producing the MAC block.
A calculator producing an IBlockResult with the final MAC in it.
Interface describing a provider of MAC calculator factory objects.
The algorithm details/parameter type for the MAC calculator factories produced.
Return a new MAC calculator factory for the passed in algorithm details.
The algorithm details/parameters to use to create the factory.
A new MAC calculator factory.
Service interface for MAC factory objects.
Create a MAC factory configured using the algorithmDetails parameter.
The parameter type associated with algorithmDetails
The configuration parameters for the returned MAC factory.
A new MAC factory.
a Diffie-Hellman key agreement class.
note: This is only the basic algorithm, it doesn't take advantage of
long term public keys if they are available. See the DHAgreement class
for a "better" implementation.
given a short term public key from a given party calculate the next
message in the agreement sequence.
P1363 7.2.2 ECSVDP-DHC
ECSVDP-DHC is Elliptic Curve Secret Value Derivation Primitive,
Diffie-Hellman version with cofactor multiplication. It is based on
the work of [DH76], [Mil86], [Kob87], [LMQ98] and [Kal98a]. This
primitive derives a shared secret value from one party's private key
and another party's public key, where both have the same set of EC
domain parameters. If two parties correctly execute this primitive,
they will produce the same output. This primitive can be invoked by a
scheme to derive a shared secret key; specifically, it may be used
with the schemes ECKAS-DH1 and DL/ECKAS-DH2. It does not assume the
validity of the input public key (see also Section 7.2.1).
Note: As stated P1363 compatibility mode with ECDH can be preset, and
in this case the implementation doesn't have a ECDH compatibility mode
(if you want that just use ECDHBasicAgreement and note they both implement
BasicAgreement!).
a holding class for public/private parameter pairs.
basic constructor.
@param publicParam a public key parameters object.
@param privateParam the corresponding private key parameters.
return the public key parameters.
@return the public key parameters.
return the private key parameters.
@return the private key parameters.
The AEAD block ciphers already handle buffering internally, so this class
just takes care of implementing IBufferedCipher methods.
initialise the cipher.
@param forEncryption if true the cipher is initialised for
encryption, if false for decryption.
@param param the key and other data required by the cipher.
@exception ArgumentException if the parameters argument is
inappropriate.
return the blocksize for the underlying cipher.
@return the blocksize for the underlying cipher.
return the size of the output buffer required for an update
an input of len bytes.
@param len the length of the input.
@return the space required to accommodate a call to update
with len bytes of input.
return the size of the output buffer required for an update plus a
doFinal with an input of len bytes.
@param len the length of the input.
@return the space required to accommodate a call to update and doFinal
with len bytes of input.
process a single byte, producing an output block if necessary.
@param in the input byte.
@param out the space for any output that might be produced.
@param outOff the offset from which the output will be copied.
@return the number of output bytes copied to out.
@exception DataLengthException if there isn't enough space in out.
@exception InvalidOperationException if the cipher isn't initialised.
process an array of bytes, producing output if necessary.
@param in the input byte array.
@param inOff the offset at which the input data starts.
@param len the number of bytes to be copied out of the input array.
@param out the space for any output that might be produced.
@param outOff the offset from which the output will be copied.
@return the number of output bytes copied to out.
@exception DataLengthException if there isn't enough space in out.
@exception InvalidOperationException if the cipher isn't initialised.
Process the last block in the buffer.
@param out the array the block currently being held is copied into.
@param outOff the offset at which the copying starts.
@return the number of output bytes copied to out.
@exception DataLengthException if there is insufficient space in out for
the output, or the input is not block size aligned and should be.
@exception InvalidOperationException if the underlying cipher is not
initialised.
@exception InvalidCipherTextException if padding is expected and not found.
@exception DataLengthException if the input is not block size
aligned.
Reset the buffer and cipher. After resetting the object is in the same
state as it was after the last init (if there was one).
A wrapper class that allows block ciphers to be used to process data in
a piecemeal fashion. The BufferedBlockCipher outputs a block only when the
buffer is full and more data is being added, or on a doFinal.
Note: in the case where the underlying cipher is either a CFB cipher or an
OFB one the last block may not be a multiple of the block size.
constructor for subclasses
Create a buffered block cipher without padding.
@param cipher the underlying block cipher this buffering object wraps.
false otherwise.
initialise the cipher.
@param forEncryption if true the cipher is initialised for
encryption, if false for decryption.
@param param the key and other data required by the cipher.
@exception ArgumentException if the parameters argument is
inappropriate.
return the blocksize for the underlying cipher.
@return the blocksize for the underlying cipher.
return the size of the output buffer required for an update
an input of len bytes.
@param len the length of the input.
@return the space required to accommodate a call to update
with len bytes of input.
return the size of the output buffer required for an update plus a
doFinal with an input of len bytes.
@param len the length of the input.
@return the space required to accommodate a call to update and doFinal
with len bytes of input.
process a single byte, producing an output block if necessary.
@param in the input byte.
@param out the space for any output that might be produced.
@param outOff the offset from which the output will be copied.
@return the number of output bytes copied to out.
@exception DataLengthException if there isn't enough space in out.
@exception InvalidOperationException if the cipher isn't initialised.
process an array of bytes, producing output if necessary.
@param in the input byte array.
@param inOff the offset at which the input data starts.
@param len the number of bytes to be copied out of the input array.
@param out the space for any output that might be produced.
@param outOff the offset from which the output will be copied.
@return the number of output bytes copied to out.
@exception DataLengthException if there isn't enough space in out.
@exception InvalidOperationException if the cipher isn't initialised.
Process the last block in the buffer.
@param out the array the block currently being held is copied into.
@param outOff the offset at which the copying starts.
@return the number of output bytes copied to out.
@exception DataLengthException if there is insufficient space in out for
the output, or the input is not block size aligned and should be.
@exception InvalidOperationException if the underlying cipher is not
initialised.
@exception InvalidCipherTextException if padding is expected and not found.
@exception DataLengthException if the input is not block size
aligned.
Reset the buffer and cipher. After resetting the object is in the same
state as it was after the last init (if there was one).
The base class for symmetric, or secret, cipher key generators.
initialise the key generator.
@param param the parameters to be used for key generation
Generate a secret key.
@return a byte array containing the key value.
Customizable SHAKE function.
Base constructor
bit length of the underlying SHAKE function, 128 or 256.
the function name string, note this is reserved for use by NIST. Avoid using it if not required.
the customization string - available for local use.
base implementation of MD4 family style digest as outlined in
"Handbook of Applied Cryptography", pages 344 - 347.
Implementation of Keccak based on following KeccakNISTInterface.c from http://keccak.noekeon.org/
Following the naming conventions used in the C source code to enable easy review of the implementation.
Return the size of block that the compression function is applied to in bytes.
@return internal byte length of a block.
Base class for SHA-384 and SHA-512.
Constructor for variable length word
Copy constructor. We are using copy constructors in place
of the object.Clone() interface as this interface is not
supported by J2ME.
adjust the byte counts so that byteCount2 represents the
upper long (less 3 bits) word of the byte count.
implementation of MD5 as outlined in "Handbook of Applied Cryptography", pages 346 - 347.
Copy constructor. This will copy the state of the provided
message digest.
reset the chaining variables to the IV values.
ParallelHash - a hash designed to support the efficient hashing of very long strings, by taking advantage,
of the parallelism available in modern processors with an optional XOF mode.
From NIST Special Publication 800-185 - SHA-3 Derived Functions:cSHAKE, KMAC, TupleHash and ParallelHash
Base constructor.
@param bitLength bit length of the underlying SHAKE function, 128 or 256.
@param S the customization string - available for local use.
@param B the blocksize (in bytes) for hashing.
implementation of SHA-1 as outlined in "Handbook of Applied Cryptography", pages 346 - 349.
It is interesting to ponder why the, apart from the extra IV, the other difference here from MD5
is the "endianness" of the word processing!
Copy constructor. This will copy the state of the provided
message digest.
reset the chaining variables
SHA-224 as described in RFC 3874
block word digest
SHA-1 512 32 160
SHA-224 512 32 224
SHA-256 512 32 256
SHA-384 1024 64 384
SHA-512 1024 64 512
Standard constructor
Copy constructor. This will copy the state of the provided
message digest.
reset the chaining variables
Draft FIPS 180-2 implementation of SHA-256. Note: As this is
based on a draft this implementation is subject to change.
block word digest
SHA-1 512 32 160
SHA-256 512 32 256
SHA-384 1024 64 384
SHA-512 1024 64 512
Copy constructor. This will copy the state of the provided
message digest.
reset the chaining variables
Draft FIPS 180-2 implementation of SHA-384. Note: As this is
based on a draft this implementation is subject to change.
block word digest
SHA-1 512 32 160
SHA-256 512 32 256
SHA-384 1024 64 384
SHA-512 1024 64 512
Copy constructor. This will copy the state of the provided
message digest.
reset the chaining variables
Implementation of SHA-3 based on following KeccakNISTInterface.c from http://keccak.noekeon.org/
Following the naming conventions used in the C source code to enable easy review of the implementation.
Draft FIPS 180-2 implementation of SHA-512. Note: As this is
based on a draft this implementation is subject to change.
block word digest
SHA-1 512 32 160
SHA-256 512 32 256
SHA-384 1024 64 384
SHA-512 1024 64 512
Copy constructor. This will copy the state of the provided
message digest.
reset the chaining variables
FIPS 180-4 implementation of SHA-512/t
Standard constructor
Copy constructor. This will copy the state of the provided
message digest.
reset the chaining variables
Implementation of SHAKE based on following KeccakNISTInterface.c from http://keccak.noekeon.org/
Following the naming conventions used in the C source code to enable easy review of the implementation.
TupleHash - a hash designed to simply hash a tuple of input strings, any or all of which may be empty strings,
in an unambiguous way with an optional XOF mode.
From NIST Special Publication 800-185 - SHA-3 Derived Functions:cSHAKE, KMAC, TupleHash and ParallelHash
Base constructor.
@param bitLength bit length of the underlying SHAKE function, 128 or 256.
@param S the customization string - available for local use.
return the X9ECParameters object for the named curve represented by
the passed in object identifier. Null if the curve isn't present.
@param oid an object identifier representing a named curve, if present.
return the object identifier signified by the passed in name. Null
if there is no object identifier associated with name.
@return the object identifier associated with name, if present.
return the named curve name represented by the given object identifier.
returns an enumeration containing the name strings for curves
contained in this structure.
Optimal Asymmetric Encryption Padding (OAEP) - see PKCS 1 V 2.
@exception InvalidCipherTextException if the decrypted block turns out to
be badly formatted.
mask generator function, as described in PKCS1v2.
this does your basic Pkcs 1 v1.5 padding - whether or not you should be using this
depends on your application - see Pkcs1 Version 2 for details.
some providers fail to include the leading zero in PKCS1 encoded blocks. If you need to
work with one of these set the system property org.bouncycastle.pkcs1.strict to false.
The system property is checked during construction of the encoding object, it is set to
true by default.
Basic constructor.
@param cipher
Constructor for decryption with a fixed plaintext length.
@param cipher The cipher to use for cryptographic operation.
@param pLen Length of the expected plaintext.
Constructor for decryption with a fixed plaintext length and a fallback
value that is returned, if the padding is incorrect.
@param cipher
The cipher to use for cryptographic operation.
@param fallback
The fallback value, we don't to a arraycopy here.
Checks if the argument is a correctly PKCS#1.5 encoded Plaintext
for encryption.
@param encoded The Plaintext.
@param pLen Expected length of the plaintext.
@return Either 0, if the encoding is correct, or -1, if it is incorrect.
Decode PKCS#1.5 encoding, and return a random value if the padding is not correct.
@param in The encrypted block.
@param inOff Offset in the encrypted block.
@param inLen Length of the encrypted block.
@param pLen Length of the desired output.
@return The plaintext without padding, or a random value if the padding was incorrect.
@throws InvalidCipherTextException
@exception InvalidCipherTextException if the decrypted block is not in Pkcs1 format.
an implementation of the AES (Rijndael), from FIPS-197.
For further details see: http://csrc.nist.gov/encryption/aes/.
This implementation is based on optimizations from Dr. Brian Gladman's paper and C code at
http://fp.gladman.plus.com/cryptography_technology/rijndael/
There are three levels of tradeoff of speed vs memory
Because java has no preprocessor, they are written as three separate classes from which to choose
The fastest uses 8Kbytes of static tables to precompute round calculations, 4 256 word tables for encryption
and 4 for decryption.
The middle performance version uses only one 256 word table for each, for a total of 2Kbytes,
adding 12 rotate operations per round to compute the values contained in the other tables from
the contents of the first.
The slowest version uses no static tables at all and computes the values in each round.
This file contains the middle performance version with 2Kbytes of static tables for round precomputation.
Calculate the necessary round keys
The number of calculations depends on key size and block size
AES specified a fixed block size of 128 bits and key sizes 128/192/256 bits
This code is written assuming those are the only possible values
default constructor - 128 bit block size.
initialise an AES cipher.
@param forEncryption whether or not we are for encryption.
@param parameters the parameters required to set up the cipher.
@exception ArgumentException if the parameters argument is
inappropriate.
Camellia - based on RFC 3713.
Implementation of Daniel J. Bernstein's ChaCha stream cipher.
Creates a 20 rounds ChaCha engine.
Creates a ChaCha engine with a specific number of rounds.
the number of rounds (must be an even number).
ChaCha function.
The number of ChaCha rounds to execute
The input words.
The ChaCha state to modify.
A class that provides a basic DESede (or Triple DES) engine.
initialise a DESede cipher.
@param forEncryption whether or not we are for encryption.
@param parameters the parameters required to set up the cipher.
@exception ArgumentException if the parameters argument is
inappropriate.
A class that provides a basic DES engine.
initialise a DES cipher.
@param forEncryption whether or not we are for encryption.
@param parameters the parameters required to set up the cipher.
@exception ArgumentException if the parameters argument is
inappropriate.
what follows is mainly taken from "Applied Cryptography", by
Bruce Schneier, however it also bears great resemblance to Richard
Outerbridge's D3DES...
Generate an integer based working key based on our secret key
and what we processing we are planning to do.
Acknowledgements for this routine go to James Gillogly and Phil Karn.
(whoever, and wherever they are!).
the DES engine.
this does your basic ElGamal algorithm.
initialise the ElGamal engine.
@param forEncryption true if we are encrypting, false otherwise.
@param param the necessary ElGamal key parameters.
Return the maximum size for an input block to this engine.
For ElGamal this is always one byte less than the size of P on
encryption, and twice the length as the size of P on decryption.
@return maximum size for an input block.
Return the maximum size for an output block to this engine.
For ElGamal this is always one byte less than the size of P on
decryption, and twice the length as the size of P on encryption.
@return maximum size for an output block.
Process a single block using the basic ElGamal algorithm.
@param in the input array.
@param inOff the offset into the input buffer where the data starts.
@param length the length of the data to be processed.
@return the result of the ElGamal process.
@exception DataLengthException the input block is too large.
initialise a RC4 cipher.
@param forEncryption whether or not we are for encryption.
@param parameters the parameters required to set up the cipher.
@exception ArgumentException if the parameters argument is
inappropriate.
this does your basic RSA algorithm with blinding
initialise the RSA engine.
@param forEncryption true if we are encrypting, false otherwise.
@param param the necessary RSA key parameters.
Return the maximum size for an input block to this engine.
For RSA this is always one byte less than the key size on
encryption, and the same length as the key size on decryption.
@return maximum size for an input block.
Return the maximum size for an output block to this engine.
For RSA this is always one byte less than the key size on
decryption, and the same length as the key size on encryption.
@return maximum size for an output block.
Process a single block using the basic RSA algorithm.
@param inBuf the input array.
@param inOff the offset into the input buffer where the data starts.
@param inLen the length of the data to be processed.
@return the result of the RSA process.
@exception DataLengthException the input block is too large.
this does your basic RSA algorithm.
initialise the RSA engine.
@param forEncryption true if we are encrypting, false otherwise.
@param param the necessary RSA key parameters.
Return the maximum size for an input block to this engine.
For RSA this is always one byte less than the key size on
encryption, and the same length as the key size on decryption.
@return maximum size for an input block.
Return the maximum size for an output block to this engine.
For RSA this is always one byte less than the key size on
decryption, and the same length as the key size on encryption.
@return maximum size for an output block.
Implementation of Daniel J. Bernstein's Salsa20 stream cipher, Snuffle 2005
Constants
Creates a 20 round Salsa20 engine.
Creates a Salsa20 engine with a specific number of rounds.
the number of rounds (must be an even number).
Rotate left
@param x value to rotate
@param y amount to rotate x
@return rotated x
Implementation of the SEED algorithm as described in RFC 4009
* Serpent is a 128-bit 32-round block cipher with variable key lengths,
* including 128, 192 and 256 bit keys conjectured to be at least as
* secure as three-key triple-DES.
*
* Serpent was designed by Ross Anderson, Eli Biham and Lars Knudsen as a
* candidate algorithm for the NIST AES Quest.
*
*
* For full details see The Serpent home page
*
Expand a user-supplied key material into a session key.
@param key The user-key bytes (multiples of 4) to use.
@exception ArgumentException
Encrypt one block of plaintext.
@param input the array containing the input data.
@param inOff offset into the in array the data starts at.
@param output the array the output data will be copied into.
@param outOff the offset into the out array the output will start at.
Decrypt one block of ciphertext.
@param input the array containing the input data.
@param inOff offset into the in array the data starts at.
@param output the array the output data will be copied into.
@param outOff the offset into the out array the output will start at.
initialise a Serpent cipher.
@param encrypting whether or not we are for encryption.
@param params the parameters required to set up the cipher.
@throws IllegalArgumentException if the params argument is
inappropriate.
Process one block of input from the array in and write it to
the out array.
@param in the array containing the input data.
@param inOff offset into the in array the data starts at.
@param out the array the output data will be copied into.
@param outOff the offset into the out array the output will start at.
@return the number of bytes processed and produced.
@throws DataLengthException if there isn't enough data in in, or
space in out.
@throws IllegalStateException if the cipher isn't initialised.
InvSO - {13, 3,11, 0,10, 6, 5,12, 1,14, 4, 7,15, 9, 8, 2 } - 15 terms.
S1 - {15,12, 2, 7, 9, 0, 5,10, 1,11,14, 8, 6,13, 3, 4 } - 14 terms.
InvS1 - { 5, 8, 2,14,15, 6,12, 3,11, 4, 7, 9, 1,13,10, 0 } - 14 steps.
S2 - { 8, 6, 7, 9, 3,12,10,15,13, 1,14, 4, 0,11, 5, 2 } - 16 terms.
InvS2 - {12, 9,15, 4,11,14, 1, 2, 0, 3, 6,13, 5, 8,10, 7 } - 16 steps.
S3 - { 0,15,11, 8,12, 9, 6, 3,13, 1, 2, 4,10, 7, 5,14 } - 16 terms.
InvS3 - { 0, 9,10, 7,11,14, 6,13, 3, 5,12, 2, 4, 8,15, 1 } - 15 terms
S4 - { 1,15, 8, 3,12, 0,11, 6, 2, 5, 4,10, 9,14, 7,13 } - 15 terms.
InvS4 - { 5, 0, 8, 3,10, 9, 7,14, 2,12,11, 6, 4,15,13, 1 } - 15 terms.
S5 - {15, 5, 2,11, 4,10, 9,12, 0, 3,14, 8,13, 6, 7, 1 } - 16 terms.
InvS5 - { 8,15, 2, 9, 4, 1,13,14,11, 6, 5, 3, 7,12,10, 0 } - 16 terms.
S6 - { 7, 2,12, 5, 8, 4, 6,11,14, 9, 1,15,13, 3,10, 0 } - 15 terms.
InvS6 - {15,10, 1,13, 5, 3, 6, 0, 4, 9,14, 7, 2,12, 8,11 } - 15 terms.
S7 - { 1,13,15, 0,14, 8, 2,11, 7, 4,12,10, 9, 3, 5, 6 } - 16 terms.
InvS7 - { 3, 0, 6,13, 9,14,15, 8, 5,12,11, 7,10, 1, 4, 2 } - 17 terms.
Apply the linear transformation to the register set.
Apply the inverse of the linear transformation to the register set.
Base class for format-preserving encryption.
Process length bytes from inBuf, writing the output to outBuf.
number of bytes output.
input data.
offset in input data to start at.
number of bytes to process.
destination buffer.
offset to start writing at in destination buffer.
Initialize the FPE engine for encryption/decryption.
number of bytes output.
true if initialising for encryption, false otherwise.
the key and other parameters to use to set the engine up.
Basic KDF generator for derived keys and ivs as defined by IEEE P1363a/ISO 18033
This implementation is based on ISO 18033/P1363a.
Construct a KDF Parameters generator.
@param counterStart value of counter.
@param digest the digest to be used as the source of derived keys.
return the underlying digest.
fill len bytes of the output buffer with bytes generated from
the derivation function.
@throws ArgumentException if the size of the request will cause an overflow.
@throws DataLengthException if the out buffer is too small.
Generator for Concatenation Key Derivation Function defined in NIST SP 800-56A, Sect 5.8.1
@param digest the digest to be used as the source of generated bytes
return the underlying digest.
int to octet string.
fill len bytes of the output buffer with bytes generated from
the derivation function.
@throws DataLengthException if the out buffer is too small.
a Diffie-Hellman key pair generator.
This generates keys consistent for use in the MTI/A0 key agreement protocol
as described in "Handbook of Applied Cryptography", Pages 516-519.
a DSA key pair generator.
This Generates DSA keys in line with the method described
in FIPS 186-3 B.1 FFC Key Pair Generation.
Generate suitable parameters for DSA, in line with FIPS 186-2, or FIPS 186-3.
Initialise the generator
This form can only be used for older DSA (pre-DSA2) parameters
the size of keys in bits (from 512 up to 1024, and a multiple of 64)
measure of robustness of primes (at least 80 for FIPS 186-2 compliance)
the source of randomness to use
Initialise the generator for DSA 2
You must use this Init method if you need to generate parameters for DSA 2 keys
An instance of DsaParameterGenerationParameters used to configure this generator
Generates a set of DsaParameters
Can take a while...
generate suitable parameters for DSA, in line with
FIPS 186-3 A.1 Generation of the FFC Primes p and q.
Given the domain parameters this routine generates an EC key
pair in accordance with X9.62 section 5.2.1 pages 26, 27.
HMAC-based Extract-and-Expand Key Derivation Function (HKDF) implemented
according to IETF RFC 5869, May 2010 as specified by H. Krawczyk, IBM
Research & P. Eronen, Nokia. It uses a HMac internally to compute de OKM
(output keying material) and is likely to have better security properties
than KDF's based on just a hash function.
Creates a HKDFBytesGenerator based on the given hash function.
@param hash the digest to be used as the source of generatedBytes bytes
Performs the expand part of the key derivation function, using currentT
as input and output buffer.
@throws DataLengthException if the total number of bytes generated is larger than the one
specified by RFC 5869 (255 * HashLen)
Key Generator for HMAC-based Extract-and-Expand Key Derivation Function (HKDF) implemented
according to IETF RFC 5869, May 2010 as specified by H. Krawczyk, IBM
Research & P. Eronen, Nokia. It uses a HMac internally to compute de OKM
(output keying material) and is likely to have better security properties
than KDF's based on just a hash function.
Creates a HKDFBytesGenerator based on the given hash function.
@param hash the digest to be used as the source of generatedBytes bytes
Performs the extract part of the key derivation function.
@param salt the salt to use
@param ikm the input keying material
@return the PRK as KeyParameter
KDF2 generator for derived keys and ivs as defined by IEEE P1363a/ISO 18033
This implementation is based on IEEE P1363/ISO 18033.
Construct a KDF2 bytes generator. Generates key material
according to IEEE P1363 or ISO 18033 depending on the initialisation.
@param digest the digest to be used as the source of derived keys.
Generator for PBE derived keys and ivs as usd by OpenSSL.
The scheme is a simple extension of PKCS 5 V2.0 Scheme 1 using MD5 with an
iteration count of 1.
Construct a OpenSSL Parameters generator.
Initialise - note the iteration count for this algorithm is fixed at 1.
@param password password to use.
@param salt salt to use.
the derived key function, the ith hash of the password and the salt.
Generate a key parameter derived from the password, salt, and iteration
count we are currently initialised with.
@param keySize the size of the key we want (in bits)
@return a KeyParameter object.
@exception ArgumentException if the key length larger than the base hash size.
Generate a key parameter for use with a MAC derived from the password,
salt, and iteration count we are currently initialised with.
@param keySize the size of the key we want (in bits)
@return a KeyParameter object.
@exception ArgumentException if the key length larger than the base hash size.
Generator for Pbe derived keys and ivs as defined by Pkcs 12 V1.0.
The document this implementation is based on can be found at
RSA's Pkcs12 Page
Construct a Pkcs 12 Parameters generator.
@param digest the digest to be used as the source of derived keys.
@exception ArgumentException if an unknown digest is passed in.
add a + b + 1, returning the result in a. The a value is treated
as a BigInteger of length (b.Length * 8) bits. The result is
modulo 2^b.Length in case of overflow.
generation of a derived key ala Pkcs12 V1.0.
Generate a key parameter derived from the password, salt, and iteration
count we are currently initialised with.
@param keySize the size of the key we want (in bits)
@return a KeyParameter object.
Generate a key with initialisation vector parameter derived from
the password, salt, and iteration count we are currently initialised
with.
@param keySize the size of the key we want (in bits)
@param ivSize the size of the iv we want (in bits)
@return a ParametersWithIV object.
Generate a key parameter for use with a MAC derived from the password,
salt, and iteration count we are currently initialised with.
@param keySize the size of the key we want (in bits)
@return a KeyParameter object.
Generator for Pbe derived keys and ivs as defined by Pkcs 5 V2.0 Scheme 2.
This generator uses a SHA-1 HMac as the calculation function.
The document this implementation is based on can be found at
RSA's Pkcs5 Page
construct a Pkcs5 Scheme 2 Parameters generator.
Generate a key parameter derived from the password, salt, and iteration
count we are currently initialised with.
@param keySize the size of the key we want (in bits)
@return a KeyParameter object.
Generate a key with initialisation vector parameter derived from
the password, salt, and iteration count we are currently initialised
with.
@param keySize the size of the key we want (in bits)
@param ivSize the size of the iv we want (in bits)
@return a ParametersWithIV object.
Generate a key parameter for use with a MAC derived from the password,
salt, and iteration count we are currently initialised with.
@param keySize the size of the key we want (in bits)
@return a KeyParameter object.
Generates keys for the Poly1305 MAC.
Poly1305 keys are 256 bit keys consisting of a 128 bit secret key used for the underlying block
cipher followed by a 128 bit {@code r} value used for the polynomial portion of the Mac.
The {@code r} value has a specific format with some bits required to be cleared, resulting in an
effective 106 bit key.
A separately generated 256 bit key can be modified to fit the Poly1305 key format by using the
{@link #clamp(byte[])} method to clear the required bits.
Initialises the key generator.
Poly1305 keys are always 256 bits, so the key length in the provided parameters is ignored.
Generates a 256 bit key in the format required for Poly1305 - e.g.
k[0] ... k[15], r[0] ... r[15] with the required bits in r cleared
as per .
Modifies an existing 32 byte key value to comply with the requirements of the Poly1305 key by
clearing required bits in the r (second 16 bytes) portion of the key.
Specifically:
- r[3], r[7], r[11], r[15] have top four bits clear (i.e., are {0, 1, . . . , 15})
- r[4], r[8], r[12] have bottom two bits clear (i.e., are in {0, 4, 8, . . . , 252})
a 32 byte key value k[0] ... k[15], r[0] ... r[15]
Checks a 32 byte key for compliance with the Poly1305 key requirements, e.g.
k[0] ... k[15], r[0] ... r[15] with the required bits in r cleared
as per .
Key.
if the key is of the wrong length, or has invalid bits set
in the r portion of the key.
An RSA key pair generator.
Choose a random prime value for use with RSA.
The bit-length of the returned prime.
The RSA public exponent.
Minimum bound for the square of the returned prime.
A prime p, with (p-1) relatively prime to e.
Base interface for a public/private key block cipher.
The name of the algorithm this cipher implements.
Initialise the cipher.
Initialise for encryption if true, for decryption if false.
The key or other data required by the cipher.
The maximum size, in bytes, an input block may be.
The maximum size, in bytes, an output block will be.
Process a block.
The input buffer.
The offset into inBuf that the input block begins.
The length of the input block.
Input decrypts improperly.
Input is too large for the cipher.
interface that a public/private key pair generator should conform to.
intialise the key pair generator.
@param the parameters the key pair is to be initialised with.
return an AsymmetricCipherKeyPair containing the Generated keys.
@return an AsymmetricCipherKeyPair containing the Generated keys.
The basic interface that basic Diffie-Hellman implementations
conforms to.
initialise the agreement engine.
return the field size for the agreement algorithm in bytes.
given a public key from a given party calculate the next
message in the agreement sequence.
Base interface for a symmetric key block cipher.
The name of the algorithm this cipher implements.
Initialise the cipher.
Initialise for encryption if true, for decryption if false.
The key or other data required by the cipher.
The block size for this cipher, in bytes.
Indicates whether this cipher can handle partial blocks.
Process a block.
The input buffer.
The offset into inBuf that the input block begins.
The output buffer.
The offset into outBuf to write the output block.
If input block is wrong size, or outBuf too small.
The number of bytes processed and produced.
Reset the cipher to the same state as it was after the last init (if there was one).
Block cipher engines are expected to conform to this interface.
The name of the algorithm this cipher implements.
Initialise the cipher.
If true the cipher is initialised for encryption,
if false for decryption.
The key and other data required by the cipher.
Reset the cipher. After resetting the cipher is in the same state
as it was after the last init (if there was one).
all parameter classes implement this.
base interface for general purpose byte derivation functions.
return the message digest used as the basis for the function
Parameters for key/byte stream derivation classes
interface that a message digest conforms to.
return the algorithm name
@return the algorithm name
return the size, in bytes, of the digest produced by this message digest.
@return the size, in bytes, of the digest produced by this message digest.
return the size, in bytes, of the internal buffer used by this digest.
@return the size, in bytes, of the internal buffer used by this digest.
update the message digest with a single byte.
@param inByte the input byte to be entered.
update the message digest with a block of bytes.
@param input the byte array containing the data.
@param inOff the offset into the byte array where the data starts.
@param len the length of the data.
Close the digest, producing the final digest value. The doFinal
call leaves the digest reset.
@param output the array the digest is to be copied into.
@param outOff the offset into the out array the digest is to start at.
reset the digest back to it's initial state.
interface for classes implementing the Digital Signature Algorithm
initialise the signer for signature generation or signature
verification.
@param forSigning true if we are generating a signature, false
otherwise.
@param param key parameters for signature generation.
sign the passed in message (usually the output of a hash function).
@param message the message to be signed.
@return two big integers representing the r and s values respectively.
verify the message message against the signature values r and s.
@param message the message that was supposed to have been signed.
@param r the r signature value.
@param s the s signature value.
The base interface for implementations of message authentication codes (MACs).
Initialise the MAC.
@param param the key and other data required by the MAC.
@exception ArgumentException if the parameters argument is
inappropriate.
Return the name of the algorithm the MAC implements.
@return the name of the algorithm the MAC implements.
Return the block size for this MAC (in bytes).
@return the block size for this MAC in bytes.
add a single byte to the mac for processing.
@param in the byte to be processed.
@exception InvalidOperationException if the MAC is not initialised.
@param in the array containing the input.
@param inOff the index in the array the data begins at.
@param len the length of the input starting at inOff.
@exception InvalidOperationException if the MAC is not initialised.
@exception DataLengthException if there isn't enough data in in.
Compute the final stage of the MAC writing the output to the out
parameter.
doFinal leaves the MAC in the same state it was after the last init.
@param out the array the MAC is to be output to.
@param outOff the offset into the out buffer the output is to start at.
@exception DataLengthException if there isn't enough space in out.
@exception InvalidOperationException if the MAC is not initialised.
Reset the MAC. At the end of resetting the MAC should be in the
in the same state it was after the last init (if there was one).
Return the name of the algorithm the signer implements.
@return the name of the algorithm the signer implements.
Initialise the signer for signing or verification.
@param forSigning true if for signing, false otherwise
@param param necessary parameters.
update the internal digest with the byte b
update the internal digest with the byte array in
Generate a signature for the message we've been loaded with using
the key we were initialised with.
return true if the internal state represents the signature described
in the passed in array.
reset the internal state
The interface stream ciphers conform to.
The name of the algorithm this cipher implements.
Initialise the cipher.
If true the cipher is initialised for encryption,
if false for decryption.
The key and other data required by the cipher.
If the parameters argument is inappropriate.
encrypt/decrypt a single byte returning the result.
the byte to be processed.
the result of processing the input byte.
Process a block of bytes from input putting the result into output.
The input byte array.
The offset into input where the data to be processed starts.
The number of bytes to be processed.
The output buffer the processed bytes go into.
The offset into output the processed data starts at.
If the output buffer is too small.
Reset the cipher to the same state as it was after the last init (if there was one).
The name of the algorithm this cipher implements.
With FIPS PUB 202 a new kind of message digest was announced which supported extendable output, or variable digest sizes.
This interface provides the extra method required to support variable output on a digest implementation.
Output the results of the final calculation for this digest to outLen number of bytes.
output array to write the output bytes to.
offset to start writing the bytes at.
the number of output bytes requested.
the number of bytes written
Start outputting the results of the final calculation for this digest. Unlike DoFinal, this method
will continue producing output until the Xof is explicitly reset, or signals otherwise.
output array to write the output bytes to.
offset to start writing the bytes at.
the number of output bytes requested.
the number of bytes written
The base class for parameters to key generators.
initialise the generator with a source of randomness
and a strength (in bits).
@param random the random byte source.
@param strength the size, in bits, of the keys we want to produce.
return the random source associated with this
generator.
@return the generators random source.
return the bit strength for keys produced by this generator,
@return the strength of the keys this generator produces (in bits).
standard CBC Block Cipher MAC - if no padding is specified the default of
pad of zeroes is used.
create a standard MAC based on a CBC block cipher. This will produce an
authentication code half the length of the block size of the cipher.
@param cipher the cipher to be used as the basis of the MAC generation.
create a standard MAC based on a CBC block cipher. This will produce an
authentication code half the length of the block size of the cipher.
@param cipher the cipher to be used as the basis of the MAC generation.
@param padding the padding to be used to complete the last block.
create a standard MAC based on a block cipher with the size of the
MAC been given in bits. This class uses CBC mode as the basis for the
MAC generation.
Note: the size of the MAC must be at least 24 bits (FIPS Publication 81),
or 16 bits if being used as a data authenticator (FIPS Publication 113),
and in general should be less than the size of the block cipher as it reduces
the chance of an exhaustive attack (see Handbook of Applied Cryptography).
@param cipher the cipher to be used as the basis of the MAC generation.
@param macSizeInBits the size of the MAC in bits, must be a multiple of 8.
create a standard MAC based on a block cipher with the size of the
MAC been given in bits. This class uses CBC mode as the basis for the
MAC generation.
Note: the size of the MAC must be at least 24 bits (FIPS Publication 81),
or 16 bits if being used as a data authenticator (FIPS Publication 113),
and in general should be less than the size of the block cipher as it reduces
the chance of an exhaustive attack (see Handbook of Applied Cryptography).
@param cipher the cipher to be used as the basis of the MAC generation.
@param macSizeInBits the size of the MAC in bits, must be a multiple of 8.
@param padding the padding to be used to complete the last block.
Reset the mac generator.
CMAC - as specified at www.nuee.nagoya-u.ac.jp/labs/tiwata/omac/omac.html
CMAC is analogous to OMAC1 - see also en.wikipedia.org/wiki/CMAC
CMAC is a NIST recomendation - see
csrc.nist.gov/CryptoToolkit/modes/800-38_Series_Publications/SP800-38B.pdf
CMAC/OMAC1 is a blockcipher-based message authentication code designed and
analyzed by Tetsu Iwata and Kaoru Kurosawa.
CMAC/OMAC1 is a simple variant of the CBC MAC (Cipher Block Chaining Message
Authentication Code). OMAC stands for One-Key CBC MAC.
It supports 128- or 64-bits block ciphers, with any key size, and returns
a MAC with dimension less or equal to the block size of the underlying
cipher.
create a standard MAC based on a CBC block cipher (64 or 128 bit block).
This will produce an authentication code the length of the block size
of the cipher.
@param cipher the cipher to be used as the basis of the MAC generation.
create a standard MAC based on a block cipher with the size of the
MAC been given in bits.
Note: the size of the MAC must be at least 24 bits (FIPS Publication 81),
or 16 bits if being used as a data authenticator (FIPS Publication 113),
and in general should be less than the size of the block cipher as it reduces
the chance of an exhaustive attack (see Handbook of Applied Cryptography).
@param cipher the cipher to be used as the basis of the MAC generation.
@param macSizeInBits the size of the MAC in bits, must be a multiple of 8 and @lt;= 128.
Reset the mac generator.
The GMAC specialisation of Galois/Counter mode (GCM) detailed in NIST Special Publication
800-38D.
GMac is an invocation of the GCM mode where no data is encrypted (i.e. all input data to the Mac
is processed as additional authenticated data with the underlying GCM block cipher).
Creates a GMAC based on the operation of a block cipher in GCM mode.
This will produce an authentication code the length of the block size of the cipher.
the cipher to be used in GCM mode to generate the MAC.
Creates a GMAC based on the operation of a 128 bit block cipher in GCM mode.
This will produce an authentication code the length of the block size of the cipher.
the cipher to be used in GCM mode to generate the MAC.
the mac size to generate, in bits. Must be a multiple of 8, between 32 and 128 (inclusive).
Sizes less than 96 are not recommended, but are supported for specialized applications.
Initialises the GMAC - requires a
providing a and a nonce.
HMAC implementation based on RFC2104
H(K XOR opad, H(K XOR ipad, text))
Reset the mac generator.
Poly1305 message authentication code, designed by D. J. Bernstein.
Poly1305 computes a 128-bit (16 bytes) authenticator, using a 128 bit nonce and a 256 bit key
consisting of a 128 bit key applied to an underlying cipher, and a 128 bit key (with 106
effective key bits) used in the authenticator.
The polynomial calculation in this implementation is adapted from the public domain poly1305-donna-unrolled C implementation
by Andrew M (@floodyberry).
Polynomial key
Polynomial key
Polynomial key
Polynomial key
Polynomial key
Precomputed 5 * r[1..4]
Precomputed 5 * r[1..4]
Precomputed 5 * r[1..4]
Precomputed 5 * r[1..4]
Encrypted nonce
Encrypted nonce
Encrypted nonce
Encrypted nonce
Current block of buffered input
Current offset in input buffer
Polynomial accumulator
Polynomial accumulator
Polynomial accumulator
Polynomial accumulator
Polynomial accumulator
Constructs a Poly1305 MAC, where the key passed to init() will be used directly.
Constructs a Poly1305 MAC, using a 128 bit block cipher.
Initialises the Poly1305 MAC.
a {@link ParametersWithIV} containing a 128 bit nonce and a {@link KeyParameter} with
a 256 bit key complying to the {@link Poly1305KeyGenerator Poly1305 key format}.
implements Cipher-Block-Chaining (CBC) mode on top of a simple cipher.
Basic constructor.
@param cipher the block cipher to be used as the basis of chaining.
return the underlying block cipher that we are wrapping.
@return the underlying block cipher that we are wrapping.
Initialise the cipher and, possibly, the initialisation vector (IV).
If an IV isn't passed as part of the parameter, the IV will be all zeros.
@param forEncryption if true the cipher is initialised for
encryption, if false for decryption.
@param param the key and other data required by the cipher.
@exception ArgumentException if the parameters argument is
inappropriate.
return the algorithm name and mode.
@return the name of the underlying algorithm followed by "/CBC".
return the block size of the underlying cipher.
@return the block size of the underlying cipher.
Process one block of input from the array in and write it to
the out array.
@param in the array containing the input data.
@param inOff offset into the in array the data starts at.
@param out the array the output data will be copied into.
@param outOff the offset into the out array the output will start at.
@exception DataLengthException if there isn't enough data in in, or
space in out.
@exception InvalidOperationException if the cipher isn't initialised.
@return the number of bytes processed and produced.
reset the chaining vector back to the IV and reset the underlying
cipher.
Do the appropriate chaining step for CBC mode encryption.
@param in the array containing the data to be encrypted.
@param inOff offset into the in array the data starts at.
@param out the array the encrypted data will be copied into.
@param outOff the offset into the out array the output will start at.
@exception DataLengthException if there isn't enough data in in, or
space in out.
@exception InvalidOperationException if the cipher isn't initialised.
@return the number of bytes processed and produced.
Do the appropriate chaining step for CBC mode decryption.
@param in the array containing the data to be decrypted.
@param inOff offset into the in array the data starts at.
@param out the array the decrypted data will be copied into.
@param outOff the offset into the out array the output will start at.
@exception DataLengthException if there isn't enough data in in, or
space in out.
@exception InvalidOperationException if the cipher isn't initialised.
@return the number of bytes processed and produced.
Implements the Counter with Cipher Block Chaining mode (CCM) detailed in
NIST Special Publication 800-38C.
Note: this mode is a packet mode - it needs all the data up front.
Basic constructor.
@param cipher the block cipher to be used.
return the underlying block cipher that we are wrapping.
@return the underlying block cipher that we are wrapping.
Returns a byte array containing the mac calculated as part of the
last encrypt or decrypt operation.
@return the last mac calculated.
Process a packet of data for either CCM decryption or encryption.
@param in data for processing.
@param inOff offset at which data starts in the input array.
@param inLen length of the data in the input array.
@return a byte array containing the processed input..
@throws IllegalStateException if the cipher is not appropriately set up.
@throws InvalidCipherTextException if the input data is truncated or the mac check fails.
Process a packet of data for either CCM decryption or encryption.
@param in data for processing.
@param inOff offset at which data starts in the input array.
@param inLen length of the data in the input array.
@param output output array.
@param outOff offset into output array to start putting processed bytes.
@return the number of bytes added to output.
@throws IllegalStateException if the cipher is not appropriately set up.
@throws InvalidCipherTextException if the input data is truncated or the mac check fails.
@throws DataLengthException if output buffer too short.
implements a Cipher-FeedBack (CFB) mode on top of a simple cipher.
Basic constructor.
@param cipher the block cipher to be used as the basis of the
feedback mode.
@param blockSize the block size in bits (note: a multiple of 8)
return the underlying block cipher that we are wrapping.
@return the underlying block cipher that we are wrapping.
Initialise the cipher and, possibly, the initialisation vector (IV).
If an IV isn't passed as part of the parameter, the IV will be all zeros.
An IV which is too short is handled in FIPS compliant fashion.
@param forEncryption if true the cipher is initialised for
encryption, if false for decryption.
@param param the key and other data required by the cipher.
@exception ArgumentException if the parameters argument is
inappropriate.
return the algorithm name and mode.
@return the name of the underlying algorithm followed by "/CFB"
and the block size in bits.
return the block size we are operating at.
@return the block size we are operating at (in bytes).
Process one block of input from the array in and write it to
the out array.
@param in the array containing the input data.
@param inOff offset into the in array the data starts at.
@param out the array the output data will be copied into.
@param outOff the offset into the out array the output will start at.
@exception DataLengthException if there isn't enough data in in, or
space in out.
@exception InvalidOperationException if the cipher isn't initialised.
@return the number of bytes processed and produced.
Do the appropriate processing for CFB mode encryption.
@param in the array containing the data to be encrypted.
@param inOff offset into the in array the data starts at.
@param out the array the encrypted data will be copied into.
@param outOff the offset into the out array the output will start at.
@exception DataLengthException if there isn't enough data in in, or
space in out.
@exception InvalidOperationException if the cipher isn't initialised.
@return the number of bytes processed and produced.
Do the appropriate processing for CFB mode decryption.
@param in the array containing the data to be decrypted.
@param inOff offset into the in array the data starts at.
@param out the array the encrypted data will be copied into.
@param outOff the offset into the out array the output will start at.
@exception DataLengthException if there isn't enough data in in, or
space in out.
@exception InvalidOperationException if the cipher isn't initialised.
@return the number of bytes processed and produced.
reset the chaining vector back to the IV and reset the underlying
cipher.
A Two-Pass Authenticated-Encryption Scheme Optimized for Simplicity and
Efficiency - by M. Bellare, P. Rogaway, D. Wagner.
http://www.cs.ucdavis.edu/~rogaway/papers/eax.pdf
EAX is an AEAD scheme based on CTR and OMAC1/CMAC, that uses a single block
cipher to encrypt and authenticate data. It's on-line (the length of a
message isn't needed to begin processing it), has good performances, it's
simple and provably secure (provided the underlying block cipher is secure).
Of course, this implementations is NOT thread-safe.
Constructor that accepts an instance of a block cipher engine.
@param cipher the engine to use
Implements the Galois/Counter mode (GCM) detailed in
NIST Special Publication 800-38D.
MAC sizes from 32 bits to 128 bits (must be a multiple of 8) are supported. The default is 128 bits.
Sizes less than 96 are not recommended, but are supported for specialized applications.
A block cipher mode that includes authenticated encryption with a streaming mode
and optional associated data.
The name of the algorithm this cipher implements.
The block cipher underlying this algorithm.
Initialise the cipher.
Parameter can either be an AeadParameters or a ParametersWithIV object.
Initialise for encryption if true, for decryption if false.
The key or other data required by the cipher.
The block size for this cipher, in bytes.
Add a single byte to the associated data check.
If the implementation supports it, this will be an online operation and will not retain the associated data.
The byte to be processed.
Add a sequence of bytes to the associated data check.
If the implementation supports it, this will be an online operation and will not retain the associated data.
The input byte array.
The offset into the input array where the data to be processed starts.
The number of bytes to be processed.
Encrypt/decrypt a single byte.
@param input the byte to be processed.
@param outBytes the output buffer the processed byte goes into.
@param outOff the offset into the output byte array the processed data starts at.
@return the number of bytes written to out.
@exception DataLengthException if the output buffer is too small.
Process a block of bytes from in putting the result into out.
@param inBytes the input byte array.
@param inOff the offset into the in array where the data to be processed starts.
@param len the number of bytes to be processed.
@param outBytes the output buffer the processed bytes go into.
@param outOff the offset into the output byte array the processed data starts at.
@return the number of bytes written to out.
@exception DataLengthException if the output buffer is too small.
Finish the operation either appending or verifying the MAC at the end of the data.
@param outBytes space for any resulting output data.
@param outOff offset into out to start copying the data at.
@return number of bytes written into out.
@throws InvalidOperationException if the cipher is in an inappropriate state.
@throws InvalidCipherTextException if the MAC fails to match.
Return the value of the MAC associated with the last stream processed.
@return MAC for plaintext data.
Return the size of the output buffer required for a ProcessBytes
an input of len bytes.
@param len the length of the input.
@return the space required to accommodate a call to ProcessBytes
with len bytes of input.
Return the size of the output buffer required for a ProcessBytes plus a
DoFinal with an input of len bytes.
@param len the length of the input.
@return the space required to accommodate a call to ProcessBytes and DoFinal
with len bytes of input.
Reset the cipher to the same state as it was after the last init (if there was one).
A Cipher Text Stealing (CTS) mode cipher. CTS allows block ciphers to
be used to produce cipher text which is the same length as the plain text.
This class implements the NIST version as documented in "Addendum to NIST SP 800-38A, Recommendation for Block Cipher Modes of Operation: Three Variants of Ciphertext Stealing for CBC Mode"
Create a buffered block cipher that uses NIST Cipher Text Stealing
@param type type of CTS mode (CS1, CS2, or CS3)
@param cipher the underlying block cipher used to create the CBC block cipher this cipher uses..
return the size of the output buffer required for an update
an input of len bytes.
@param len the length of the input.
@return the space required to accommodate a call to update
with len bytes of input.
return the size of the output buffer required for an update plus a
doFinal with an input of len bytes.
@param len the length of the input.
@return the space required to accommodate a call to update and doFinal
with len bytes of input.
process a single byte, producing an output block if necessary.
@param in the input byte.
@param out the space for any output that might be produced.
@param outOff the offset from which the output will be copied.
@return the number of output bytes copied to out.
@exception DataLengthException if there isn't enough space in out.
@exception IllegalStateException if the cipher isn't initialised.
process an array of bytes, producing output if necessary.
@param in the input byte array.
@param inOff the offset at which the input data starts.
@param len the number of bytes to be copied out of the input array.
@param out the space for any output that might be produced.
@param outOff the offset from which the output will be copied.
@return the number of output bytes copied to out.
@exception DataLengthException if there isn't enough space in out.
@exception IllegalStateException if the cipher isn't initialised.
Process the last block in the buffer.
@param out the array the block currently being held is copied into.
@param outOff the offset at which the copying starts.
@return the number of output bytes copied to out.
@exception DataLengthException if there is insufficient space in out for
the output.
@exception IllegalStateException if the underlying cipher is not
initialised.
@exception org.bouncycastle.crypto.InvalidCipherTextException if cipher text decrypts wrongly (in
case the exception will never get thrown).
implements a Output-FeedBack (OFB) mode on top of a simple cipher.
Basic constructor.
@param cipher the block cipher to be used as the basis of the
feedback mode.
@param blockSize the block size in bits (note: a multiple of 8)
return the underlying block cipher that we are wrapping.
@return the underlying block cipher that we are wrapping.
Initialise the cipher and, possibly, the initialisation vector (IV).
If an IV isn't passed as part of the parameter, the IV will be all zeros.
An IV which is too short is handled in FIPS compliant fashion.
@param forEncryption if true the cipher is initialised for
encryption, if false for decryption.
@param param the key and other data required by the cipher.
@exception ArgumentException if the parameters argument is
inappropriate.
return the algorithm name and mode.
@return the name of the underlying algorithm followed by "/OFB"
and the block size in bits
return the block size we are operating at (in bytes).
@return the block size we are operating at (in bytes).
Process one block of input from the array in and write it to
the out array.
@param in the array containing the input data.
@param inOff offset into the in array the data starts at.
@param out the array the output data will be copied into.
@param outOff the offset into the out array the output will start at.
@exception DataLengthException if there isn't enough data in in, or
space in out.
@exception InvalidOperationException if the cipher isn't initialised.
@return the number of bytes processed and produced.
reset the feedback vector back to the IV and reset the underlying
cipher.
* Implements OpenPGP's rather strange version of Cipher-FeedBack (CFB) mode
* on top of a simple cipher. This class assumes the IV has been prepended
* to the data stream already, and just accomodates the reset after
* (blockSize + 2) bytes have been read.
*
* For further info see RFC 2440.
*
Basic constructor.
@param cipher the block cipher to be used as the basis of the
feedback mode.
return the underlying block cipher that we are wrapping.
@return the underlying block cipher that we are wrapping.
return the algorithm name and mode.
@return the name of the underlying algorithm followed by "/OpenPGPCFB"
and the block size in bits.
return the block size we are operating at.
@return the block size we are operating at (in bytes).
Process one block of input from the array in and write it to
the out array.
@param in the array containing the input data.
@param inOff offset into the in array the data starts at.
@param out the array the output data will be copied into.
@param outOff the offset into the out array the output will start at.
@exception DataLengthException if there isn't enough data in in, or
space in out.
@exception InvalidOperationException if the cipher isn't initialised.
@return the number of bytes processed and produced.
reset the chaining vector back to the IV and reset the underlying
cipher.
Initialise the cipher and, possibly, the initialisation vector (IV).
If an IV isn't passed as part of the parameter, the IV will be all zeros.
An IV which is too short is handled in FIPS compliant fashion.
@param forEncryption if true the cipher is initialised for
encryption, if false for decryption.
@param parameters the key and other data required by the cipher.
@exception ArgumentException if the parameters argument is
inappropriate.
Encrypt one byte of data according to CFB mode.
@param data the byte to encrypt
@param blockOff offset in the current block
@returns the encrypted byte
Do the appropriate processing for CFB IV mode encryption.
@param in the array containing the data to be encrypted.
@param inOff offset into the in array the data starts at.
@param out the array the encrypted data will be copied into.
@param outOff the offset into the out array the output will start at.
@exception DataLengthException if there isn't enough data in in, or
space in out.
@exception InvalidOperationException if the cipher isn't initialised.
@return the number of bytes processed and produced.
Do the appropriate processing for CFB IV mode decryption.
@param in the array containing the data to be decrypted.
@param inOff offset into the in array the data starts at.
@param out the array the encrypted data will be copied into.
@param outOff the offset into the out array the output will start at.
@exception DataLengthException if there isn't enough data in in, or
space in out.
@exception InvalidOperationException if the cipher isn't initialised.
@return the number of bytes processed and produced.
Implements the Segmented Integer Counter (SIC) mode on top of a simple
block cipher.
Basic constructor.
@param c the block cipher to be used.
return the underlying block cipher that we are wrapping.
@return the underlying block cipher that we are wrapping.
Base constructor.
@param key key to be used by underlying cipher
@param macSize macSize in bits
@param nonce nonce to be used
Base constructor.
@param key key to be used by underlying cipher
@param macSize macSize in bits
@param nonce nonce to be used
@param associatedText associated text, if any
return true if the passed in key is a DES-EDE weak key.
@param key bytes making up the key
@param offset offset into the byte array the key starts at
@param length number of bytes making up the key
return true if the passed in key is a DES-EDE weak key.
@param key bytes making up the key
@param offset offset into the byte array the key starts at
DES has 16 weak keys. This method will check
if the given DES key material is weak or semi-weak.
Key material that is too short is regarded as weak.
See "Applied
Cryptography" by Bruce Schneier for more information.
@return true if the given DES key material is weak or semi-weak,
false otherwise.
DES Keys use the LSB as the odd parity bit. This can
be used to check for corrupt keys.
@param bytes the byte array to set the parity on.
The minimum bitlength of the private value.
The bitlength of the private value.
Construct without a usage index, this will do a random construction of G.
@param L desired length of prime P in bits (the effective key size).
@param N desired length of prime Q in bits.
@param certainty certainty level for prime number generation.
@param random the source of randomness to use.
Construct for a specific usage index - this has the effect of using verifiable canonical generation of G.
@param L desired length of prime P in bits (the effective key size).
@param N desired length of prime Q in bits.
@param certainty certainty level for prime number generation.
@param random the source of randomness to use.
@param usageIndex a valid usage index.
Parameter class for the HKDFKeyGenerator class.
Returns the input keying material or seed.
@return the keying material
Returns if step 1: extract has to be skipped or not
@return true for skipping, false for no skipping of step 1
Returns the salt, or null if the salt should be generated as a byte array
of HashLen zeros.
@return the salt, or null
Parameter class for the HKDFBytesGenerator class.
Returns the input keying material or seed.
@return the keying material
Returns the info field, which may be empty (null is converted to empty).
@return the info field, never null
parameters for Key derivation functions for ISO-18033
parameters for Key derivation functions for IEEE P1363a
Parameter class for the HKdfBytesGenerator class.
Returns the key
@return the key.
Returns the info field, which may be empty (null is converted to empty).
@return the info field, never null
super class for all Password Based Encyrption (Pbe) parameter generator classes.
base constructor.
initialise the Pbe generator.
@param password the password converted into bytes (see below).
@param salt the salt to be mixed with the password.
@param iterationCount the number of iterations the "mixing" function
is to be applied for.
return the iteration count.
@return the iteration count.
Generate derived parameters for a key of length keySize.
@param keySize the length, in bits, of the key required.
@return a parameters object representing a key.
Generate derived parameters for a key of length keySize, and
an initialisation vector (IV) of length ivSize.
@param keySize the length, in bits, of the key required.
@param ivSize the length, in bits, of the iv required.
@return a parameters object representing a key and an IV.
Generate derived parameters for a key of length keySize, specifically
for use with a MAC.
@param keySize the length, in bits, of the key required.
@return a parameters object representing a key.
converts a password to a byte array according to the scheme in
Pkcs5 (ascii, no padding)
@param password a character array representing the password.
@return a byte array representing the password.
converts a password to a byte array according to the scheme in
PKCS5 (UTF-8, no padding)
@param password a character array representing the password.
@return a byte array representing the password.
converts a password to a byte array according to the scheme in
Pkcs12 (unicode, big endian, 2 zero pad bytes at the end).
@param password a character array representing the password.
@return a byte array representing the password.
initialise the signer for signature generation or signature verification.
true if we are generating a signature, false otherwise
key parameters for signature generation.
sign the passed in message (usually the output of a hash function).
the message to be signed.
the signature of the message
verify the message message against the signature value
the message that was supposed to have been signed.
the signature of the message.
ChaCha core function
SPHINCS-256 signer.
This implementation is heavily based on the reference implementation in SUPERCOP, the main difference being the digests used
for message hashing and tree construction are now configurable (within limits...)
Base constructor.
@param nDigest the "n-digest" must produce 32 bytes of output - used for tree construction.
@param twoNDigest the "2n-digest" must produce 64 bytes of output - used for initial message/key/seed hashing.
Uses Microsoft's RNGCryptoServiceProvider
Random generation based on the digest with counter. Calling AddSeedMaterial will
always increase the entropy of the hash.
Internal access to the digest is synchronized so a single one of these can be shared.
Generic interface for objects generating random bytes.
Add more seed material to the generator.
A byte array to be mixed into the generator's state.
Add more seed material to the generator.
A long value to be mixed into the generator's state.
Fill byte array with random values.
Array to be filled.
Fill byte array with random values.
Array to receive bytes.
Index to start filling at.
Length of segment to fill.
update the internal digest with the byte b
update the internal digest with the byte array in
Generate a signature for the message we've been loaded with using
the key we were initialised with.
true if the internal state represents the signature described in the passed in array.
Reset the internal state
The Digital Signature Algorithm - as described in "Handbook of Applied
Cryptography", pages 452 - 453.
Default configuration, random K values.
Configuration with an alternate, possibly deterministic calculator of K.
@param kCalculator a K value calculator.
Generate a signature for the given message using the key we were
initialised with. For conventional DSA the message should be a SHA-1
hash of the message of interest.
@param message the message that will be verified later.
return true if the value r and s represent a DSA signature for
the passed in message for standard DSA the message should be a
SHA-1 hash of the real message to be verified.
EC-DSA as described in X9.62
Default configuration, random K values.
Configuration with an alternate, possibly deterministic calculator of K.
@param kCalculator a K value calculator.
Generate a signature for the given message using the key we were
initialised with. For conventional DSA the message should be a SHA-1
hash of the message of interest.
@param message the message that will be verified later.
return true if the value r and s represent a DSA signature for
the passed in message (for standard DSA the message should be
a SHA-1 hash of the real message to be verified).
initialise the signer for signing or verification.
@param forSigning
true if for signing, false otherwise
@param parameters
necessary parameters.
update the internal digest with the byte b
update the internal digest with the byte array in
Generate a signature for the message we've been loaded with using the key
we were initialised with.
return true if the internal state represents the signature described in
the passed in array.
A deterministic K calculator based on the algorithm in section 3.2 of RFC 6979.
Base constructor.
The HMAC to use in the calculator.
Interface defining calculators of K values for DSA/ECDSA.
Return true if this calculator is deterministic, false otherwise.
>true if this instance is deterministic; otherwise, false.
Non-deterministic initialiser.
The order of the DSA group.
A source of randomness.
Deterministic initialiser.
The order of the DSA group.
The DSA private value.
The message being signed.
Return the next valid value of K.
A K value.
RSA-PSS as described in Pkcs# 1 v 2.1.
Note: the usual value for the salt length is the number of
bytes in the hash function.
Basic constructor
the asymmetric cipher to use.
the digest to use.
the length of the salt to use (in bytes).
clear possible sensitive data
update the internal digest with the byte b
update the internal digest with the byte array in
reset the internal state
Generate a signature for the message we've been loaded with using
the key we were initialised with.
return true if the internal state represents the signature described
in the passed in array.
int to octet string.
mask generator function, as described in Pkcs1v2.
Load oid table.
Initialise the signer for signing or verification.
@param forSigning true if for signing, false otherwise
@param param necessary parameters.
update the internal digest with the byte b
update the internal digest with the byte array in
Generate a signature for the message we've been loaded with using
the key we were initialised with.
return true if the internal state represents the signature described
in the passed in array.
X9.31-1998 - signing using a hash.
The message digest hash, H, is encapsulated to form a byte string as follows
EB = 06 || PS || 0xBA || H || TRAILER
where PS is a string of bytes all of value 0xBB of length such that |EB|=|n|, and TRAILER is the ISO/IEC 10118 part number†for the digest. The byte string, EB, is converted to an integer value, the message representative, f.
Generate a signer with either implicit or explicit trailers for X9.31.
@param cipher base cipher to use for signature creation/verification
@param digest digest to use.
@param implicit whether or not the trailer is implicit or gives the hash.
Constructor for a signer with an explicit digest trailer.
@param cipher cipher to use.
@param digest digest to sign with.
clear possible sensitive data
update the internal digest with the byte b
update the internal digest with the byte array in
reset the internal state
generate a signature for the loaded message using the key we were
initialised with.
return true if the signature represents a ISO9796-2 signature
for the passed in message.
an implementation of the AES Key Wrapper from the NIST Key Wrap
Specification as described in RFC 3394/SP800-38F.
For further details see: http://www.ietf.org/rfc/rfc3394.txt
and http://csrc.nist.gov/encryption/kms/key-wrap.pdf.
Create a RFC 3394 WrapEngine specifying the direction for wrapping and unwrapping..
@param engine the block cipher to be used for wrapping.
@param useReverseDirection true if engine should be used in decryption mode for wrapping, false otherwise.
an implementation of the AES Key Wrapper from the NIST Key Wrap
Specification as described in RFC 3394/SP800-38F.
For further details see: http://www.ietf.org/rfc/rfc3394.txt
and http://csrc.nist.gov/encryption/kms/key-wrap.pdf.
Create a RFC 3394 WrapEngine specifying the direction for wrapping and unwrapping..
@param engine the block cipher to be used for wrapping.
@param useReverseDirection true if engine should be used in decryption mode for wrapping, false otherwise.
This exception is thrown whenever we find something we don't expect in a message
Base constructor.
Create a InvalidCipherTextException with the given message.
The message to be carried with the exception.
Create a InvalidCipherTextException with the given message and underlying cause.
The message to be carried with the exception.
The exception that caused this exception to be raised.
Base interface for OAEP parameters.
The type of the implementing parameter.
The algorithm type for the parameters.
The digest algorithm type for the parameters.
Return the digest algorithm associated with these parameters.
Return the digest algorithm used in the mask generation function associated with these parameters.
Return the encoding parameters to be used in the padding created from these parameters.
A copy of the encoding parameters.
Create a new parameter instance with the OAEP encoding configured with the passed in digest.
Note: this will also set the MGF digest to the same algorithm.
The base digest function to use for the OAEP encoding.
A new instance of the parameter object configured for the new digest.
Create a new parameter instance with the mask generation function configured with the passed in digest.
The digest algorithm to use with the MGF.
A new instance of the parameter object configured for the new MGF digest.
Create a new parameter instance configured with the passed in salt.
A specific encoding parameter to use with the OAEP encoding.
A new instance of the parameter object configured for the new encoding parameter.
Base interface for operator parameters.
The algorithm type for the parameters.
Return the algorithm these parameters are associated with.
The algorithm these parameters are for.
Base interface for parameters with initialization vectors or nonces.
The type of the implementing parameter.
The algorithm type for the parameters.
Return the initialization vector associated with this parameter set.
the IV for these parameters.
Create a new parameter set with a different IV.
the IV to use.
A copy of the current parameter set with the new IV.
Create a new parameter set with a different IV based on the output of the passed in random.
The SecureRandom to use as the source of IV data.
A copy of the current parameter set with the new IV.
Base interface for password based key derivers.
Type for the deriver's configuration parameters.
Return the parameters for this deriver.
the deriver's parameters.
Derive a key of the given keySizeInBytes length.
A byte array containing the raw key data.
Type of key to be calculated.
The number of bytes to be produced.
Derive a key of the given keySizeInBytes length and an iv of ivSizeInBytes length.
a 2 element byte[] array containing the raw key data in element 0, the iv in element 1.
Type of key to be calculated.
The number of bytes to be produced for the key data.
The number of bytes to be produced for the IV data.
Base interface for a builder of password derivers.
Type for the deriver builder's configuration parameters.
Return a new builder configured with the passed in digest as the pseudo random function for derivers produced.
The digest algorithm to use as a PRF.
A new builder.
Return a new builder configured with the passed in salt for derivers it builds.
The salt to use with the PRF.
A new builder.
Return a new builder configured with the passed in iteration count for derivers it builds.
The iteration count to use with the PRF.
A new builder.
Build a key deriver based on the current configuration.
a new password based key deriver.
Service interface for a password based key deriver builder.
Type for configuration parameters used to create derivers produced by this service.
Construct a builder from the passed in password encoding.
a byte encoding of the password.
Construct a builder from the passed in password as converted by converter.
a converter to use to convert the password into bytes.
a password as a char array.
Base interface for a provider to support the dynamic creation of password based derivers.
Type for configuration parameters used to create derivers produced by this provider.
Return a password based deriver for the algorithm details passed in.
The details of the password to key derivation algorithm the deriver is for.
A new password based deriver.
Base interface for PSS signature parameters.
The type of the implementing parameter.
The algorithm type for the parameters.
The digest algorithm type for the parameters.
Return the digest algorithm for processing the message to be signed.
Return the digest algorithm to be used in the mask generation function.
Return the length of the salt specified for these parameters.
Return the fixed salt the parameters are configured with, if present.
The fixed salt if available, null otherwise.
Set the digest algorithm. Note: this will also set the MGF digest to the same algorithm.
The digest algorithm to use.
A new parameter set with the changed configuration.
Create a new parameter instance with the mask generation function configured with the passed in digest.
The digest algorithm to use with the MGF.
A new instance of the parameter object configured for the new MGF digest.
Create a new parameter instance with a static salt configured for signatures generated.
A new instance of the parameter object configured for the new salt.
Create a new parameter instance with a specific salt length configured for signatures generated.
The length of the salt to use, or assume.
A new instance of the parameter object configured for the new salt length.
Base interface for a recovered message object.
Return true if the full message has been recovered, false if only partially.
Return a byte array representing the message data recovered.
The recovered content.
Base interface for operator factories that create stream-based signature calculators.
Configuration parameters used to create the factory.
The algorithm details object for calculators made by this factory.
Create a stream calculator for the signature algorithm associated with this factory. The stream
calculator is used for the actual operation of entering the data to be signed
and producing the signature block.
A calculator producing an IBlockResult with the final signature in it.
Base interface for a service to support the creation of signature factories.
Return a signature factory for signature algorithm described in the passed in algorithm details object.
The details of the signature algorithm verification is required for.
A new signature factory.
Base interface for signature parameters.
The type of the implementing parameter.
The algorithm type for the parameters.
The digest algorithm type for the parameters.
Return the digest algorithm for processing the message to be signed.
Set the digest algorithm.
The digest algorithm to use.
A new parameter set with the changed configuration.
Extension to ISignatureFactory which allows for recovery of the calculated message digest.
Configuration parameters used to create the factory.
Create a stream calculator for this signature factory. The stream
calculator is used for the actual operation of entering the data to be signed
and producing the signature block and its associated digest.
A calculator producing an IBlockResultWithRecovered with a signature and the calculated digest in it.
An extension to ISignatureFactory which adds recovered messages.
Configuration parameters used to create the factory.
Create a stream calculator for this signature calculator. The stream
calculator is used for the actual operation of entering the data to be signed
and producing the signature block.
A calculator producing an IBlockResultWithRecovered with a signature and the recovered message in it.
Base interface for cryptographic operations such as Hashes, MACs, and Signatures which reduce a stream of data
to a single value.
Type of the result produced by this calculator.
Return a "sink" stream which only exists to update the implementing object.
A stream to write to in order to update the implementing object.
Return the result of processing the stream. This value is only available once the stream
has been closed.
The result of processing the stream.
Interface describing a symmetric key.
Return the bytes associated with this key.
Key bytes, null or exception if they are not available.
Base interface for symmetric key generators.
Generate a new key.
A new key.
Return a result of processing the stream with a specified length. This value is only available once the stream
has been closed.
The result.
The length of the result expected in the result object.
Operators that reduce their input to the verification of a signature produce this type.
Return true if the passed in data matches what is expected by the verifier.
The bytes representing the signature.
true if the signature verifies, false otherwise.
Return true if the length bytes from off in the source array match the signature
expected by the verifier.
Byte array containing the signature.
The offset into the source array where the signature starts.
The number of bytes in source making up the signature.
true if the signature verifies, false otherwise.
Base interface for factories that produce stream-based signature verifiers.
Configuration parameters type for the verifiers.
The algorithm details object for this verifier.
Create a stream calculator for this verifier. The stream
calculator is used for the actual operation of entering the data to be verified
and producing a result which can be used to verify the original signature.
A calculator producing an IVerifier which can verify the signature.
Base interface for a provider to support the dynamic creation of signature verifier factories.
Type for the configuration parameters for the verifier this provider produces.
Return a signature verifier factory for signature algorithm described in the passed in algorithm details object.
The details of the signature algorithm verification is required for.
A new signature verifier factory.
Service interface for creating verifier factory objects.
Return a new verifier factory configured according to the contents of algorithmDetails.
The type of the configuration parameters.
The configuration parameters to use to configure the factory.
A new verifier factory.
Extension interface for a verifier which includes a recovered message.
Return the recovered message picked up as a result of verification.
The recovered message found in the verified signature.
Factory for verifiers which include recovered messages.
Create a stream calculator for this signature calculator. The stream
calculator is used for the actual operation of entering the data to be verified
against a pre-existing signature.
A calculator producing an IVerifierWithRecoveredMessage with a verifier and the recovered message in it.
Base interface for operator factories that create eXpandable Output Functions (XOF).
Type for the configuration parameters for the verifier this provider produces.
The algorithm details object for calculators made by this factory.
Create a stream calculator for the XOF associated with this factory. The stream
calculator is used for the actual operation of entering the data to be processed
and producing the XOF output.
A calculator producing an IBlockResult containing the output from the XOF.
Provider interface for providers of XOF factory objects.
Type for the configuration parameters for the verifier this provider produces.
Create a new XOF factory using the passed in parameters.
Configuration parameters for the XOF factory.
A new factory for producing XOFs
Service interface for keyed-XoF factory objects.
Create an XoF factory configured using the algorithmDetails parameter.
The parameter type associated with algorithmDetails
The configuration parameters for the returned XoF factory.
A new MAC factory.
Specific Algorithm for representing pairing of a base algorithm and a PRF in a KDF.
Return the algorithm representing the KDF.
Return an algorithm representing the PRF used by the KDF.
The algorithm details object for calculators made by this factory.
Create a stream calculator for the digest algorithm associated with this factory. The stream
calculator is used for the actual operation of entering the data to be digested
and producing the digest block.
A calculator producing an IBlockResult with the final digest in it.
Block cipher padders are expected to conform to this interface
Return the name of the algorithm the cipher implements.
The name of the algorithm the cipher implements.
Add the pad bytes to the passed in block, returning the number of bytes added.
The number of pad bytes added.
Return the number of pad bytes present in the block.
The number of pad bytes present in the block.
If the padding is badly formed or invalid
A padder that adds ISO10126-2 padding to a block.
Base constructor providing a source of randomness.
A SecureRandom
A padder that adds the padding according to the scheme referenced in
ISO 7814-4 - scheme 2 from ISO 9797-1. The first byte is 0x80, rest is 0x00
A padder that adds Pkcs7/Pkcs5 padding to a block.
A padder that adds Trailing Bit Complement (TBC) padding to a block.
A padder that adds X9.23 padding to a block - if a SecureRandom is
passed in random padding is assumed, otherwise padding with zeros is used.
Base constructor providing a source of randomness or null if zero padding required.
A SecureRandom (may be null)
Base class for key agreement parameters.
Acceptable algorithm type.
Acceptable digest algorithm type.
Acceptable PRF type.
Acceptable KDF type.
Constructor which specifies returning a MAC/HMAC of the raw secret on agreement calculation using one of the
standard PRFs as described in SP800-56C.
The agreement algorithm these parameters are for.
The MAC/HMAC algorithm to use.
The byte string to key the MAC/HMAC with.
Constructor with a KDF to process the Z value with. The outputSize parameter determines how many bytes
will be generated.
The agreement algorithm these parameters are for.
KDF algorithm type to use for parameter creation.
The iv parameter for KDF initialization.
The size of the output to be generated from the KDF.
Return the KDF algorithm type.
The KDF algorithm, null if not present.
Return the size of the output required from the KDF.
The number of bytes to be generated by a KDF using these parameters.
Return the salt/iv associated with these parameters.
The salt, null if not present.
Return the size of the MAC these parameters are for.
The MAC size in bits.
Create a new parameter set with the specified MAC size associated with it.
The new parameter set.
Mac size in bits.
Base class for authentications parameters with IVs associated with them (e.g. for CCM, etc)
Extending type.
Algorithm type associated with extending class.
Return a copy of the IV, null if there isn't one.
A copy of the IV.
Create a new parameter set with a different IV.
A copy of the current parameter set with the new IV.
The IV to use.
Create a new parameter set with a different IV based on the output
of the passed in random.
A copy of the current parameter set with the new IV.
A SecureRandom for deriving the IV.
Create a new parameter set with a different IV based on the output
of the passed in random.
A copy of the current parameter set with the new IV.
A SecureRandom for deriving the IV.
Length of the IV to generate.
Base class for OAEP parameter objects.
The actual parameter type.
The algorithm type for the parameters.
The digest algorithm type for the parameters.
Return the digest algorithm associated with these parameters.
Return the digest algorithm used in the mask generation function associated with these parameters.
Return the encoding parameters to be used in the padding created from these parameters.
A copy of the encoding parameters.
Return a new parameters object which uses the passed in digest algorithm in the OAEP padding.
A digest algorithm.
A new parameters object.
Return a new parameters object which uses the passed in digest algorithm for its mask generation function.
The digest algorithm to be used in the MGF.
A new parameters object.
Return a new parameters object which includes the passed in encoding parameters.
The encoding parameters to be included.
A new parameters object.
Create a new parameter set with a different IV.
A copy of the current parameter set with the new IV.
The IV to use.
Create a new parameter set with a different IV based on the output
of the passed in random.
A copy of the current parameter set with the new IV.
A SecureRandom for deriving the IV.
Base class for PSS signature parameters.
Type extending this one.
The type of algorithm the parameters are for.
The type of digest the parameters are for.
Return the digest algorithm for processing the message to be signed.
Return the digest algorithm to be used in the mask generation function.
Return the length of the salt specified for these parameters.
Return the fixed salt the parameters are configured with, if present.
The fixed salt if available, null otherwise.
Set the digest algorithm. Note: this will also set the MGF digest to the same algorithm.
The digest algorithm to use.
A new parameter set with the changed configuration.
Set the MGF digest algorithm explicitly.
The digest algorith to use for mask generation.
A new parameter set with the changed configuration.
Provide a fixed salt value to use with the signature.
A fixed salt value to use.
A new parameter set with the changed configuration.
Specify a length for the salt value in the signature.
The length of the salt to use.
A new parameter set with the changed configuration.
Specific type for representing algorithms which act as pseudo-random-functions.
Base constructor.
A message describing the error.
The algorithm the failure was for.
The algorithm details object for calculators made by this factory.
Create a stream calculator for the signature algorithm associated with this factory. The stream
calculator is used for the actual operation of entering the data to be signed
and producing the signature block.
A calculator producing an IBlockResult with the final signature in it.
A simple block result object which just carries a byte array.
Base constructor - a wrapper for the passed in byte array.
The byte array to be wrapped.
Return the number of bytes in the result
The length of the result in bytes.
Return the final result of the operation.
A block of bytes, representing the result of an operation.
Store the final result of the operation by copying it into the destination array.
The number of bytes copied into destination.
The byte array to copy the result into.
The offset into destination to start copying the result at.
Base class for symmetric secret keys.
Base constructor.
The algorithm this secret key is associated with.
The bytes representing the key's value.
Base constructor for a specific algorithm associated with a parameter set.
The parameter set with the algorithm this secret key is associated with.
The bytes representing the key's value.
Specific constructor for a SHS authentication parameters.
The parameter set with the algorithm this secret key is associated with.
The bytes representing the key's value.
Return the algorithm this secret key is for.
Return the bytes representing this keys value.
The bytes making up this key.
The target key type a deriver is trying to produce a key for.
Target key for a symmetric cipher.
Target key for a MAC.
A basic alphabet mapper that just creates a mapper based on the
passed in array of characters.
Base constructor.
@param alphabet a string of characters making up the alphabet.
Base constructor.
@param alphabet an array of characters making up the alphabet.
An EntropySourceProvider where entropy generation is based on a SecureRandom output using SecureRandom.generateSeed().
Create a entropy source provider based on the passed in SecureRandom.
The SecureRandom to base EntropySource construction on.
Boolean indicating if the SecureRandom is based on prediction resistant entropy or not (true if it is)
Return an entropy source that will create bitsRequired bits of entropy on each invocation of getEntropy().
Size (in bits) of entropy to be created by the provided source.
An EntropySource that generates bitsRequired bits of entropy on each call to its getEntropy() method.
Builder and holder class for preparing SP 800-56A/56B compliant MacData. Elements in the data are copied in
directly as byte arrays.
Standard type strings for the headers of KAS/KTS MAC calculations.
Builder to create OtherInfo
Create a basic builder with just the compulsory fields.
the MAC header
sender party ID.
receiver party ID.
ephemeral data from sender.
ephemeral data from receiver.
Add optional text.
optional agreed text to add to the MAC.
the current builder instance.
Build the MacData from the inputs.
The algorithm details object for calculators made by this factory.
Create a stream calculator for the signature algorithm associated with this factory. The stream
calculator is used for the actual operation of entering the data to be signed
and producing the signature block.
A calculator producing an IBlockResult with the final signature in it.
Gets the result.
The result.
Gets the result.
The result.
The length (in bytes) of the output wanted from the XOF.
The algorithm details object for calculators made by this factory.
Create a stream calculator for the XOF associated with this factory. The stream
calculator is used for the actual operation of entering the data to be processed
and producing the XOF output.
A calculator producing an StreamResult which can be used to read the output from the XOF.
return a = a + b - b preserved.
unsigned comparison on two arrays - note the arrays may
start with leading zeros.
return z = x / y - done in place (z value preserved, x contains the
remainder)
return whether or not a BigInteger is probably prime with a
probability of 1 - (1/2)**certainty.
From Knuth Vol 2, pg 395.
Calculate the numbers u1, u2, and u3 such that:
u1 * a + u2 * b = u3
where u3 is the greatest common divider of a and b.
a and b using the extended Euclid algorithm (refer p. 323
of The Art of Computer Programming vol 2, 2nd ed).
This also seems to have the side effect of calculating
some form of multiplicative inverse.
@param a First number to calculate gcd for
@param b Second number to calculate gcd for
@param u1Out the return object for the u1 value
@return The greatest common divisor of a and b
return w with w = x * x - w is assumed to have enough space.
return x with x = y * z - x is assumed to have enough space.
Calculate mQuote = -m^(-1) mod b with b = 2^32 (32 = word size)
Montgomery multiplication: a = x * y * R^(-1) mod m
Based algorithm 14.36 of Handbook of Applied Cryptography.
m, x, y should have length n
a should have length (n + 1)
b = 2^32, R = b^n
The result is put in x
NOTE: the indices of x, y, m, a different in HAC and in Java
return x = x % y - done in place (y value preserved)
do a left shift - this returns a new array.
do a right shift - this does it in place.
do a right shift by one - this does it in place.
returns x = x - y - we assume x is >= y
Class representing a simple version of a big decimal. A
SimpleBigDecimal is basically a
{@link java.math.BigInteger BigInteger} with a few digits on the right of
the decimal point. The number of (binary) digits on the right of the decimal
point is called the scale of the SimpleBigDecimal.
Unlike in {@link java.math.BigDecimal BigDecimal}, the scale is not adjusted
automatically, but must be set manually. All SimpleBigDecimals
taking part in the same arithmetic operation must have equal scale. The
result of a multiplication of two SimpleBigDecimals returns a
SimpleBigDecimal with double scale.
Returns a SimpleBigDecimal representing the same numerical
value as value.
@param value The value of the SimpleBigDecimal to be
created.
@param scale The scale of the SimpleBigDecimal to be
created.
@return The such created SimpleBigDecimal.
Constructor for SimpleBigDecimal. The value of the
constructed SimpleBigDecimal Equals bigInt /
2scale.
@param bigInt The bigInt value parameter.
@param scale The scale of the constructed SimpleBigDecimal.
Class holding methods for point multiplication based on the window
τ-adic nonadjacent form (WTNAF). The algorithms are based on the
paper "Improved Algorithms for Arithmetic on Anomalous Binary Curves"
by Jerome A. Solinas. The paper first appeared in the Proceedings of
Crypto 1997.
The window width of WTNAF. The standard value of 4 is slightly less
than optimal for running time, but keeps space requirements for
precomputation low. For typical curves, a value of 5 or 6 results in
a better running time. When changing this value, the
αu's must be computed differently, see
e.g. "Guide to Elliptic Curve Cryptography", Darrel Hankerson,
Alfred Menezes, Scott Vanstone, Springer-Verlag New York Inc., 2004,
p. 121-122
24
The αu's for a=0 as an array
of ZTauElements.
The αu's for a=0 as an array
of TNAFs.
The αu's for a=1 as an array
of ZTauElements.
The αu's for a=1 as an array
of TNAFs.
Computes the norm of an element λ of
Z[τ].
@param mu The parameter μ of the elliptic curve.
@param lambda The element λ of
Z[τ].
@return The norm of λ.
Computes the norm of an element λ of
R[τ], where λ = u + vτ
and u and u are real numbers (elements of
R).
@param mu The parameter μ of the elliptic curve.
@param u The real part of the element λ of
R[τ].
@param v The τ-adic part of the element
λ of R[τ].
@return The norm of λ.
Rounds an element λ of R[τ]
to an element of Z[τ], such that their difference
has minimal norm. λ is given as
λ = λ0 + λ1τ.
@param lambda0 The component λ0.
@param lambda1 The component λ1.
@param mu The parameter μ of the elliptic curve. Must
equal 1 or -1.
@return The rounded element of Z[τ].
@throws ArgumentException if lambda0 and
lambda1 do not have same scale.
Approximate division by n. For an integer
k, the value λ = s k / n is
computed to c bits of accuracy.
@param k The parameter k.
@param s The curve parameter s0 or
s1.
@param vm The Lucas Sequence element Vm.
@param a The parameter a of the elliptic curve.
@param m The bit length of the finite field
Fm.
@param c The number of bits of accuracy, i.e. the scale of the returned
SimpleBigDecimal.
@return The value λ = s k / n computed to
c bits of accuracy.
Computes the τ-adic NAF (non-adjacent form) of an
element λ of Z[τ].
@param mu The parameter μ of the elliptic curve.
@param lambda The element λ of
Z[τ].
@return The τ-adic NAF of λ.
Applies the operation τ() to an
AbstractF2mPoint.
@param p The AbstractF2mPoint to which τ() is applied.
@return τ(p)
Returns the parameter μ of the elliptic curve.
@param curve The elliptic curve from which to obtain μ.
The curve must be a Koblitz curve, i.e. a Equals
0 or 1 and b Equals
1.
@return μ of the elliptic curve.
@throws ArgumentException if the given ECCurve is not a Koblitz
curve.
Calculates the Lucas Sequence elements Uk-1 and
Uk or Vk-1 and
Vk.
@param mu The parameter μ of the elliptic curve.
@param k The index of the second element of the Lucas Sequence to be
returned.
@param doV If set to true, computes Vk-1 and
Vk, otherwise Uk-1 and
Uk.
@return An array with 2 elements, containing Uk-1
and Uk or Vk-1
and Vk.
Computes the auxiliary value tw. If the width is
4, then for mu = 1, tw = 6 and for
mu = -1, tw = 10
@param mu The parameter μ of the elliptic curve.
@param w The window width of the WTNAF.
@return the auxiliary value tw
Computes the auxiliary values s0 and
s1 used for partial modular reduction.
@param curve The elliptic curve for which to compute
s0 and s1.
@throws ArgumentException if curve is not a
Koblitz curve (Anomalous Binary Curve, ABC).
Partial modular reduction modulo
(τm - 1)/(τ - 1).
@param k The integer to be reduced.
@param m The bitlength of the underlying finite field.
@param a The parameter a of the elliptic curve.
@param s The auxiliary values s0 and
s1.
@param mu The parameter μ of the elliptic curve.
@param c The precision (number of bits of accuracy) of the partial
modular reduction.
@return ρ := k partmod (τm - 1)/(τ - 1)
Multiplies a {@link org.bouncycastle.math.ec.AbstractF2mPoint AbstractF2mPoint}
by a BigInteger using the reduced τ-adic
NAF (RTNAF) method.
@param p The AbstractF2mPoint to Multiply.
@param k The BigInteger by which to Multiply p.
@return k * p
Multiplies a {@link org.bouncycastle.math.ec.AbstractF2mPoint AbstractF2mPoint}
by an element λ of Z[τ]
using the τ-adic NAF (TNAF) method.
@param p The AbstractF2mPoint to Multiply.
@param lambda The element λ of
Z[τ].
@return λ * p
Multiplies a {@link org.bouncycastle.math.ec.AbstractF2mPoint AbstractF2mPoint}
by an element λ of Z[τ]
using the τ-adic NAF (TNAF) method, given the TNAF
of λ.
@param p The AbstractF2mPoint to Multiply.
@param u The the TNAF of λ..
@return λ * p
Computes the [τ]-adic window NAF of an element
λ of Z[τ].
@param mu The parameter μ of the elliptic curve.
@param lambda The element λ of
Z[τ] of which to compute the
[τ]-adic NAF.
@param width The window width of the resulting WNAF.
@param pow2w 2width.
@param tw The auxiliary value tw.
@param alpha The αu's for the window width.
@return The [τ]-adic window NAF of
λ.
Does the precomputation for WTNAF multiplication.
@param p The ECPoint for which to do the precomputation.
@param a The parameter a of the elliptic curve.
@return The precomputation array for p.
Class representing an element of Z[τ]. Let
λ be an element of Z[τ]. Then
λ is given as λ = u + vτ. The
components u and v may be used directly, there
are no accessor methods.
Immutable class.
The "real" part of λ.
The "τ-adic" part of λ.
Constructor for an element λ of
Z[τ].
@param u The "real" part of λ.
@param v The "τ-adic" part of
λ.
return a sqrt root - the routine verifies that the calculation returns the right value - if
none exists it returns null.
return a sqrt root - the routine verifies that the calculation returns the right value - if
none exists it returns null.
return a sqrt root - the routine verifies that the calculation returns the right value - if
none exists it returns null.
return a sqrt root - the routine verifies that the calculation returns the right value - if
none exists it returns null.
return a sqrt root - the routine verifies that the calculation returns the right value - if
none exists it returns null.
return a sqrt root - the routine verifies that the calculation returns the right value - if
none exists it returns null.
return a sqrt root - the routine verifies that the calculation returns the right value - if
none exists it returns null.
return a sqrt root - the routine verifies that the calculation returns the right value - if
none exists it returns null.
return a sqrt root - the routine verifies that the calculation returns the right value - if
none exists it returns null.
return a sqrt root - the routine verifies that the calculation returns the right value - if
none exists it returns null.
return a sqrt root - the routine verifies that the calculation returns the right value - if
none exists it returns null.
return a sqrt root - the routine verifies that the calculation returns the right value - if
none exists it returns null.
return a sqrt root - the routine verifies that the calculation returns the right value - if
none exists it returns null.
Simple shift-and-add multiplication. Serves as reference implementation to verify (possibly
faster) implementations, and for very small scalars. CAUTION: This implementation is NOT
constant-time in any way. It is only intended to be used for diagnostics.
@param p
The point to multiply.
@param k
The multiplier.
@return The result of the point multiplication kP.
Base class for an elliptic curve.
Compute a PreCompInfo for a point on this curve, under a given name. Used by
ECMultipliers to save the precomputation for this ECPoint for use
by subsequent multiplication.
@param point
The ECPoint to store precomputations for.
@param name
A String used to index precomputations of different types.
@param callback
Called to calculate the PreCompInfo.
Normalization ensures that any projective coordinate is 1, and therefore that the x, y
coordinates reflect those of the equivalent point in an affine coordinate system. Where more
than one point is to be normalized, this method will generally be more efficient than
normalizing each point separately.
@param points
An array of points that will be updated in place with their normalized versions,
where necessary
Normalization ensures that any projective coordinate is 1, and therefore that the x, y
coordinates reflect those of the equivalent point in an affine coordinate system. Where more
than one point is to be normalized, this method will generally be more efficient than
normalizing each point separately. An (optional) z-scaling factor can be applied; effectively
each z coordinate is scaled by this value prior to normalization (but only one
actual multiplication is needed).
@param points
An array of points that will be updated in place with their normalized versions,
where necessary
@param off
The start of the range of points to normalize
@param len
The length of the range of points to normalize
@param iso
The (optional) z-scaling factor - can be null
Create a cache-safe lookup table for the specified sequence of points. All the points MUST
belong to this ECCurve instance, and MUST already be normalized.
Sets the default ECMultiplier, unless already set.
We avoid locking for performance reasons, so there is no uniqueness guarantee.
Decode a point on this curve from its ASN.1 encoding. The different
encodings are taken account of, including point compression for
Fp (X9.62 s 4.2.1 pg 17).
@return The decoded point.
Elliptic curve over Fp
The auxiliary values s0 and
s1 used for partial modular reduction for
Koblitz curves.
Solves a quadratic equation z2 + z = beta(X9.62
D.1.6) The other solution is z + 1.
@param beta
The value to solve the quadratic equation for.
@return the solution for z2 + z = beta or
null if no solution exists.
@return the auxiliary values s0 and
s1 used for partial modular reduction for
Koblitz curves.
Returns true if this is a Koblitz curve (ABC curve).
@return true if this is a Koblitz curve (ABC curve), false otherwise
Elliptic curves over F2m. The Weierstrass equation is given by
y2 + xy = x3 + ax2 + b.
The exponent m of F2m.
TPB: The integer k where xm +
xk + 1 represents the reduction polynomial
f(z).
PPB: The integer k1 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
TPB: Always set to 0
PPB: The integer k2 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
TPB: Always set to 0
PPB: The integer k3 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
The point at infinity on this curve.
Constructor for Trinomial Polynomial Basis (TPB).
@param m The exponent m of
F2m.
@param k The integer k where xm +
xk + 1 represents the reduction
polynomial f(z).
@param a The coefficient a in the Weierstrass equation
for non-supersingular elliptic curves over
F2m.
@param b The coefficient b in the Weierstrass equation
for non-supersingular elliptic curves over
F2m.
Constructor for Trinomial Polynomial Basis (TPB).
@param m The exponent m of
F2m.
@param k The integer k where xm +
xk + 1 represents the reduction
polynomial f(z).
@param a The coefficient a in the Weierstrass equation
for non-supersingular elliptic curves over
F2m.
@param b The coefficient b in the Weierstrass equation
for non-supersingular elliptic curves over
F2m.
@param order The order of the main subgroup of the elliptic curve.
@param cofactor The cofactor of the elliptic curve, i.e.
#Ea(F2m) = h * n.
Constructor for Pentanomial Polynomial Basis (PPB).
@param m The exponent m of
F2m.
@param k1 The integer k1 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
@param k2 The integer k2 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
@param k3 The integer k3 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
@param a The coefficient a in the Weierstrass equation
for non-supersingular elliptic curves over
F2m.
@param b The coefficient b in the Weierstrass equation
for non-supersingular elliptic curves over
F2m.
Constructor for Pentanomial Polynomial Basis (PPB).
@param m The exponent m of
F2m.
@param k1 The integer k1 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
@param k2 The integer k2 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
@param k3 The integer k3 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
@param a The coefficient a in the Weierstrass equation
for non-supersingular elliptic curves over
F2m.
@param b The coefficient b in the Weierstrass equation
for non-supersingular elliptic curves over
F2m.
@param order The order of the main subgroup of the elliptic curve.
@param cofactor The cofactor of the elliptic curve, i.e.
#Ea(F2m) = h * n.
Return true if curve uses a Trinomial basis.
@return true if curve Trinomial, false otherwise.
return the field name for this field.
@return the string "Fp".
return a sqrt root - the routine verifies that the calculation
returns the right value - if none exists it returns null.
Class representing the Elements of the finite field
F2m in polynomial basis (PB)
representation. Both trinomial (Tpb) and pentanomial (Ppb) polynomial
basis representations are supported. Gaussian normal basis (GNB)
representation is not supported.
Indicates gaussian normal basis representation (GNB). Number chosen
according to X9.62. GNB is not implemented at present.
Indicates trinomial basis representation (Tpb). Number chosen
according to X9.62.
Indicates pentanomial basis representation (Ppb). Number chosen
according to X9.62.
Tpb or Ppb.
The exponent m of F2m.
The LongArray holding the bits.
Constructor for Ppb.
@param m The exponent m of
F2m.
@param k1 The integer k1 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
@param k2 The integer k2 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
@param k3 The integer k3 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
@param x The BigInteger representing the value of the field element.
Constructor for Tpb.
@param m The exponent m of
F2m.
@param k The integer k where xm +
xk + 1 represents the reduction
polynomial f(z).
@param x The BigInteger representing the value of the field element.
Checks, if the ECFieldElements a and b
are elements of the same field F2m
(having the same representation).
@param a field element.
@param b field element to be compared.
@throws ArgumentException if a and b
are not elements of the same field
F2m (having the same
representation).
@return the representation of the field
F2m, either of
{@link F2mFieldElement.Tpb} (trinomial
basis representation) or
{@link F2mFieldElement.Ppb} (pentanomial
basis representation).
@return the degree m of the reduction polynomial
f(z).
@return Tpb: The integer k where xm +
xk + 1 represents the reduction polynomial
f(z).
Ppb: The integer k1 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
@return Tpb: Always returns 0
Ppb: The integer k2 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
@return Tpb: Always set to 0
Ppb: The integer k3 where xm +
xk3 + xk2 + xk1 + 1
represents the reduction polynomial f(z).
base class for points on elliptic curves.
Returns the affine x-coordinate after checking that this point is normalized.
@return The affine x-coordinate of this point
@throws IllegalStateException if the point is not normalized
Returns the affine y-coordinate after checking that this point is normalized
@return The affine y-coordinate of this point
@throws IllegalStateException if the point is not normalized
Returns the x-coordinate.
Caution: depending on the curve's coordinate system, this may not be the same value as in an
affine coordinate system; use Normalize() to get a point where the coordinates have their
affine values, or use AffineXCoord if you expect the point to already have been normalized.
@return the x-coordinate of this point
Returns the y-coordinate.
Caution: depending on the curve's coordinate system, this may not be the same value as in an
affine coordinate system; use Normalize() to get a point where the coordinates have their
affine values, or use AffineYCoord if you expect the point to already have been normalized.
@return the y-coordinate of this point
Normalization ensures that any projective coordinate is 1, and therefore that the x, y
coordinates reflect those of the equivalent point in an affine coordinate system.
@return a new ECPoint instance representing the same point, but with normalized coordinates
return the field element encoded with point compression. (S 4.3.6)
Multiplies this ECPoint by the given number.
@param k The multiplicator.
@return k * this.
Elliptic curve points over Fp
Create a point which encodes without point compression.
@param curve the curve to use
@param x affine x co-ordinate
@param y affine y co-ordinate
Elliptic curve points over F2m
@param curve base curve
@param x x point
@param y y point
Interface for classes encapsulating a point multiplication algorithm
for ECPoints.
Multiplies the ECPoint p by k, i.e.
p is added k times to itself.
@param p The ECPoint to be multiplied.
@param k The factor by which p is multiplied.
@return p multiplied by k.
Class holding precomputation data for fixed-point multiplications.
Lookup table for the precomputed ECPoints used for a fixed point multiplication.
The width used for the precomputation. If a larger width precomputation
is already available this may be larger than was requested, so calling
code should refer to the actual width.
Interface for classes storing precomputation data for multiplication
algorithms. Used as a Memento (see GOF patterns) for
WNafMultiplier.
Class implementing the WNAF (Window Non-Adjacent Form) multiplication
algorithm.
Multiplies this by an integer k using the
Window NAF method.
@param k The integer by which this is multiplied.
@return A new ECPoint which equals this
multiplied by k.
Class holding precomputation data for the WNAF (Window Non-Adjacent Form)
algorithm.
Array holding the precomputed ECPoints used for a Window
NAF multiplication.
Array holding the negations of the precomputed ECPoints used
for a Window NAF multiplication.
Holds an ECPoint representing Twice(this). Used for the
Window NAF multiplication to create or extend the precomputed values.
Computes the Window NAF (non-adjacent Form) of an integer.
@param width The width w of the Window NAF. The width is
defined as the minimal number w, such that for any
w consecutive digits in the resulting representation, at
most one is non-zero.
@param k The integer of which the Window NAF is computed.
@return The Window NAF of the given width, such that the following holds:
k = ∑i=0l-1 ki2i
, where the ki denote the elements of the
returned byte[].
Determine window width to use for a scalar multiplication of the given size.
@param bits the bit-length of the scalar to multiply by
@return the window size to use
Determine window width to use for a scalar multiplication of the given size.
@param bits the bit-length of the scalar to multiply by
@param maxWidth the maximum window width to return
@return the window size to use
Determine window width to use for a scalar multiplication of the given size.
@param bits the bit-length of the scalar to multiply by
@param windowSizeCutoffs a monotonically increasing list of bit sizes at which to increment the window width
@return the window size to use
Determine window width to use for a scalar multiplication of the given size.
@param bits the bit-length of the scalar to multiply by
@param windowSizeCutoffs a monotonically increasing list of bit sizes at which to increment the window width
@param maxWidth the maximum window width to return
@return the window size to use
Class implementing the WTNAF (Window
τ-adic Non-Adjacent Form) algorithm.
Multiplies a {@link org.bouncycastle.math.ec.AbstractF2mPoint AbstractF2mPoint}
by k using the reduced τ-adic NAF (RTNAF)
method.
@param p The AbstractF2mPoint to multiply.
@param k The integer by which to multiply k.
@return p multiplied by k.
Multiplies a {@link org.bouncycastle.math.ec.AbstractF2mPoint AbstractF2mPoint}
by an element λ of Z[τ] using
the τ-adic NAF (TNAF) method.
@param p The AbstractF2mPoint to multiply.
@param lambda The element λ of
Z[τ] of which to compute the
[τ]-adic NAF.
@return p multiplied by λ.
Multiplies a {@link org.bouncycastle.math.ec.AbstractF2mPoint AbstractF2mPoint}
by an element λ of Z[τ]
using the window τ-adic NAF (TNAF) method, given the
WTNAF of λ.
@param p The AbstractF2mPoint to multiply.
@param u The the WTNAF of λ..
@return λ * p
Class holding precomputation data for the WTNAF (Window
τ-adic Non-Adjacent Form) algorithm.
Array holding the precomputed AbstractF2mPoints used for the
WTNAF multiplication in
{@link org.bouncycastle.math.ec.multiplier.WTauNafMultiplier.multiply()
WTauNafMultiplier.multiply()}.
Utility methods for generating primes and testing for primality.
Used to return the output from the
{@linkplain Primes#enhancedMRProbablePrimeTest(BigInteger, SecureRandom, int) Enhanced
Miller-Rabin Probabilistic Primality Test}
Used to return the output from the {@linkplain Primes#generateSTRandomPrime(Digest, int, byte[]) Shawe-Taylor Random_Prime Routine}
FIPS 186-4 C.6 Shawe-Taylor Random_Prime Routine
Construct a provable prime number using a hash function.
@param hash
the {@link Digest} instance to use (as "Hash()"). Cannot be null.
@param length
the length (in bits) of the prime to be generated. Must be at least 2.
@param inputSeed
the seed to be used for the generation of the requested prime. Cannot be null or
empty.
@return an {@link STOutput} instance containing the requested prime.
FIPS 186-4 C.3.2 Enhanced Miller-Rabin Probabilistic Primality Test
Run several iterations of the Miller-Rabin algorithm with randomly-chosen bases. This is an
alternative to {@link #isMRProbablePrime(BigInteger, SecureRandom, int)} that provides more
information about a composite candidate, which may be useful when generating or validating
RSA moduli.
@param candidate
the {@link BigInteger} instance to test for primality.
@param random
the source of randomness to use to choose bases.
@param iterations
the number of randomly-chosen bases to perform the test for.
@return an {@link MROutput} instance that can be further queried for details.
A fast check for small divisors, up to some implementation-specific limit.
@param candidate
the {@link BigInteger} instance to test for division by small factors.
@return true if the candidate is found to have any small factors,
false otherwise.
FIPS 186-4 C.3.1 Miller-Rabin Probabilistic Primality Test
Run several iterations of the Miller-Rabin algorithm with randomly-chosen bases.
@param candidate
the {@link BigInteger} instance to test for primality.
@param random
the source of randomness to use to choose bases.
@param iterations
the number of randomly-chosen bases to perform the test for.
@return false if any witness to compositeness is found amongst the chosen bases
(so candidate is definitely NOT prime), or else true
(indicating primality with some probability dependent on the number of iterations
that were performed).
FIPS 186-4 C.3.1 Miller-Rabin Probabilistic Primality Test (to a fixed base).
Run a single iteration of the Miller-Rabin algorithm against the specified base.
@param candidate
the {@link BigInteger} instance to test for primality.
@param baseValue
the base value to use for this iteration.
@return false if the specified base is a witness to compositeness (so
candidate is definitely NOT prime), or else true.
Create and auto-seed an instance based on the given algorithm.
Equivalent to GetInstance(algorithm, true)
e.g. "SHA256PRNG"
Create an instance based on the given algorithm, with optional auto-seeding
e.g. "SHA256PRNG"
If true, the instance will be auto-seeded.
To replicate existing predictable output, replace with GetInstance("SHA1PRNG", false), followed by SetSeed(seed)
Use the specified instance of IRandomGenerator as random source.
This constructor performs no seeding of either the IRandomGenerator or the
constructed SecureRandom. It is the responsibility of the client to provide
proper seed material as necessary/appropriate for the given IRandomGenerator
implementation.
The source to generate all random bytes from.
General array utilities.
Are two arrays equal.
Left side.
Right side.
True if equal.
A constant time equals comparison - does not terminate early if
test will fail.
first array
second array
true if arrays equal, false otherwise.
Make a copy of a range of bytes from the passed in data array. The range can
extend beyond the end of the input array, in which case the return array will
be padded with zeroes.
@param data the array from which the data is to be copied.
@param from the start index at which the copying should take place.
@param to the final index of the range (exclusive).
@return a new byte array containing the range given.
BigInteger utilities.
Return the passed in value as an unsigned byte array.
@param value value to be converted.
@return a byte array without a leading zero byte if present in the signed encoding.
Return the passed in value as an unsigned byte array of specified length, zero-extended as necessary.
@param length desired length of result array.
@param n value to be converted.
@return a byte array of specified length, with leading zeroes as necessary given the size of n.
Return a random BigInteger not less than 'min' and not greater than 'max'
@param min the least value that may be generated
@param max the greatest value that may be generated
@param random the source of randomness
@return a random BigInteger value in the range [min,max]
Return a positive BigInteger in the range of 0 to 2**bitLength - 1.
@param bitLength maximum bit length for the generated BigInteger.
@param random a source of randomness.
@return a positive BigInteger
Return the number of milliseconds since the Unix epoch (1 Jan., 1970 UTC) for a given DateTime value.
A UTC DateTime value not before epoch.
Number of whole milliseconds after epoch.
'dateTime' is before epoch.
Create a DateTime value from the number of milliseconds since the Unix epoch (1 Jan., 1970 UTC).
Number of milliseconds since the epoch.
A UTC DateTime value
Return the current number of milliseconds since the Unix epoch (1 Jan., 1970 UTC).
encode the input data producing a base 64 encoded byte array.
@return a byte array containing the base 64 encoded data.
encode the input data producing a base 64 encoded byte array.
@return a byte array containing the base 64 encoded data.
Encode the byte data to base 64 writing it to the given output stream.
@return the number of bytes produced.
Encode the byte data to base 64 writing it to the given output stream.
@return the number of bytes produced.
decode the base 64 encoded input data. It is assumed the input data is valid.
@return a byte array representing the decoded data.
decode the base 64 encoded string data - whitespace will be ignored.
@return a byte array representing the decoded data.
decode the base 64 encoded string data writing it to the given output stream,
whitespace characters will be ignored.
@return the number of bytes produced.
encode the input data producing a base 64 output stream.
@return the number of bytes produced.
decode the base 64 encoded byte data writing it to the given output stream,
whitespace characters will be ignored.
@return the number of bytes produced.
decode the base 64 encoded string data writing it to the given output stream,
whitespace characters will be ignored.
@return the number of bytes produced.
A buffering class to allow translation from one format to another to
be done in discrete chunks.
Create a buffered Decoder.
The translater to use.
The size of the buffer.
Process one byte of data.
Data in.
Byte array for the output.
The offset in the output byte array to start writing from.
The amount of output bytes.
Process data from a byte array.
The input data.
Start position within input data array.
Amount of data to process from input data array.
Array to store output.
Position in output array to start writing from.
The amount of output bytes.
A class that allows encoding of data using a specific encoder to be processed in chunks.
Create.
The translator to use.
Size of the chunks.
Process one byte of data.
The byte.
An array to store output in.
Offset within output array to start writing from.
Process data from a byte array.
Input data Byte array containing data to be processed.
Start position within input data array.
Amount of input data to be processed.
Output data array.
Offset within output data array to start writing to.
The amount of data written.
Class to decode and encode Hex.
encode the input data producing a Hex encoded byte array.
@return a byte array containing the Hex encoded data.
encode the input data producing a Hex encoded byte array.
@return a byte array containing the Hex encoded data.
Hex encode the byte data writing it to the given output stream.
@return the number of bytes produced.
Hex encode the byte data writing it to the given output stream.
@return the number of bytes produced.
decode the Hex encoded input data. It is assumed the input data is valid.
@return a byte array representing the decoded data.
decode the Hex encoded string data - whitespace will be ignored.
@return a byte array representing the decoded data.
decode the Hex encoded string data writing it to the given output stream,
whitespace characters will be ignored.
@return the number of bytes produced.
Decode the hexadecimal-encoded string strictly i.e. any non-hexadecimal characters will be
considered an error.
@return a byte array representing the decoded data.
Decode the hexadecimal-encoded string strictly i.e. any non-hexadecimal characters will be
considered an error.
@return a byte array representing the decoded data.
encode the input data producing a Hex output stream.
@return the number of bytes produced.
decode the Hex encoded byte data writing it to the given output stream,
whitespace characters will be ignored.
@return the number of bytes produced.
decode the Hex encoded string data writing it to the given output stream,
whitespace characters will be ignored.
@return the number of bytes produced.
A hex translator.
Return encoded block size.
2
Encode some data.
Input data array.
Start position within input data array.
The amount of data to process.
The output data array.
The offset within the output data array to start writing from.
Amount of data encoded.
Returns the decoded block size.
1
Decode data from a byte array.
The input data array.
Start position within input data array.
The amounty of data to process.
The output data array.
The position within the output data array to start writing from.
The amount of data written.
Encode and decode byte arrays (typically from binary to 7-bit ASCII
encodings).
Translator interface.
Convert binary data to and from UrlBase64 encoding. This is identical to
Base64 encoding, except that the padding character is "." and the other
non-alphanumeric characters are "-" and "_" instead of "+" and "/".
The purpose of UrlBase64 encoding is to provide a compact encoding of binary
data that is safe for use as an URL parameter. Base64 encoding does not
produce encoded values that are safe for use in URLs, since "/" can be
interpreted as a path delimiter; "+" is the encoded form of a space; and
"=" is used to separate a name from the corresponding value in an URL
parameter.
Encode the input data producing a URL safe base 64 encoded byte array.
@return a byte array containing the URL safe base 64 encoded data.
Encode the byte data writing it to the given output stream.
@return the number of bytes produced.
Decode the URL safe base 64 encoded input data - white space will be ignored.
@return a byte array representing the decoded data.
decode the URL safe base 64 encoded byte data writing it to the given output stream,
whitespace characters will be ignored.
@return the number of bytes produced.
decode the URL safe base 64 encoded string data - whitespace will be ignored.
@return a byte array representing the decoded data.
Decode the URL safe base 64 encoded string data writing it to the given output stream,
whitespace characters will be ignored.
@return the number of bytes produced.
Convert binary data to and from UrlBase64 encoding. This is identical to
Base64 encoding, except that the padding character is "." and the other
non-alphanumeric characters are "-" and "_" instead of "+" and "/".
The purpose of UrlBase64 encoding is to provide a compact encoding of binary
data that is safe for use as an URL parameter. Base64 encoding does not
produce encoded values that are safe for use in URLs, since "/" can be
interpreted as a path delimiter; "+" is the encoded form of a space; and
"=" is used to separate a name from the corresponding value in an URL
parameter.
Produce a copy of this object with its configuration and in its current state.
The returned object may be used simply to store the state, or may be used as a similar object
starting from the copied state.
Restore a copied object state into this object.
Implementations of this method should try to avoid or minimise memory allocation to perform the reset.
an object originally {@link #copy() copied} from an object of the same type as this instance.
if the provided object is not of the correct type.
if the other parameter is in some other way invalid.
A generic PEM object type.
Base constructor.
The type of the PEM object.
The byte content it contains.
Constructor with headers.
The type of the PEM object.
A list of headers in the object.
The byte content it contains.
Return the type of the PEM object.
Return a list of the headers in the PEM object.
Return the raw content in the object.
The content of the PEM object.
Generate a PemObject from this one.
this
A
A
A
A
A generic PEM writer, based on RFC 1421
Base constructor.
@param out output stream to use.
Return the number of bytes or characters required to contain the
passed in object if it is PEM encoded.
@param obj pem object to be output
@return an estimate of the number of bytes
Write the full contents of inStr to the destination stream outStr.
Source stream.
Destination stream.
In case of IO failure.
Write the full contents of inStr to the destination stream outStr.
Source stream.
Destination stream.
The size of temporary buffer to use.
In case of IO failure.
Pipe all bytes from inStr to outStr, throwing StreamFlowException if greater
than limit bytes in inStr.
A
A
A
The number of bytes actually transferred, if not greater than limit
Interface a selector from a store should conform to.
the type stored in the store.
Match the passed in object, returning true if it would be selected by this selector, false otherwise.
the object to be matched.
if the object is a match for this selector, false otherwise.
A generic interface describing a simple store of objects.
the object type stored.
Exception to be thrown on a failure to reset an object implementing Memoable.
The exception extends InvalidCastException to enable users to have a single handling case,
only introducing specific handling of this one if required.
Basic Constructor.
@param msg message to be associated with this exception.
Validate the given IPv4 or IPv6 address.
@param address the IP address as a string.
@return true if a valid address, false otherwise
Validate the given IPv4 or IPv6 address and netmask.
@param address the IP address as a string.
@return true if a valid address with netmask, false otherwise
Validate the given IPv4 address.
@param address the IP address as a string.
@return true if a valid IPv4 address, false otherwise
Validate the given IPv6 address.
@param address the IP address as a string.
@return true if a valid IPv4 address, false otherwise
Utility method for accessing system properties.
Return true if the environment variable propertyName has the value "true".
The name of the property to check
true if the environment variable propertyName is "true", false otherwise.
General string utilities.
A secure random that returns pre-seeded data to calls of NextBytes() or GenerateSeed().
Base class for sources of fixed "Randomness".
Data Source - in this case we just expect requests for byte arrays.
BigInteger Source - in this case we expect requests for data that will be used
for BigIntegers. The FixedSecureRandom will attempt to compensate for platform differences here.
A fixed secure random designed to return data for someone needing to create a single BigInteger.
Constructor from a base 10 represention of a BigInteger.
A base 10 represention of a BigInteger.
Constructor from a base radix represention of a BigInteger.
A String BigInteger of base radix.
The radix to use.
Constructor based on a byte array.
A 2's complement representation of the BigInteger.
Constructor from a Hex encoding of the data.
@param encoding a Hex encoding of the data to be returned.
Constructor from an array of bytes.
@param encoding a byte array representing the data to be returned.
Create a test entropy source provider.
@param isPredictionResistant boolean indicating if the SecureRandom is based on prediction resistant entropy or not (true if it is).
Return an entropy source that will create bitsRequired bits of entropy on
each invocation of getEntropy().
@param bitsRequired size (in bits) of entropy to be created by the provided source.
@return an EntropySource that generates bitsRequired bits of entropy on each call to its getEntropy() method.