+ 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.
++ 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.
+1.3.6.1.4.1.22554
+1.3.6.1.4.1.22554.1
+1.3.6.1.4.1.22554.1.1
+
+ LinkedCertificate := SEQUENCE {
+ digest DigestInfo, -- digest of PQC certificate
+ certLocation GeneralName, -- location of PQC certificate
+ certIssuer [0] Name OPTIONAL, -- issuer of PQC cert (if different from current certificate)
+ cACerts [1] GeneralNames OPTIONAL, -- CA certificates for PQC cert (one of more locations)
+ }
+
+
+ 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.
+
+ 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. +
+ 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.
+
+ 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)
+
+ + PkiFreeText ::= SEQUENCE SIZE (1..MAX) OF UTF8String ++
+ 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.
+
+ 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. +
+ 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. +
+ Attribute ::= SEQUENCE {
+ attrType OBJECT IDENTIFIER,
+ attrValues SET OF AttributeValue
+ }
+
+ + Attributes ::= + SET SIZE(1..MAX) OF Attribute -- according to RFC 5652 ++ @return +
+ 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
+
+
+ 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
+
+
+ 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 }
+
+
+ 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 }
+
+
+ CompressedData ::= Sequence {
+ version CMSVersion,
+ compressionAlgorithm CompressionAlgorithmIdentifier,
+ encapContentInfo EncapsulatedContentInfo
+ }
+
+
+ CompressedData ::= SEQUENCE {
+ version CMSVersion,
+ compressionAlgorithm CompressionAlgorithmIdentifier,
+ encapContentInfo EncapsulatedContentInfo
+ }
+
+
+ ContentInfo ::= Sequence {
+ contentType ContentType,
+ content
+ [0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
+
+
+ ContentInfo ::= SEQUENCE {
+ contentType ContentType,
+ content
+ [0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
+
+
+ MQVuserKeyingMaterial ::= SEQUENCE {
+ ephemeralPublicKey OriginatorPublicKey,
+ addedukm [0] EXPLICIT UserKeyingMaterial OPTIONAL }
+
+
+ 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.
+
+ EnvelopedData ::= Sequence {
+ version CMSVersion,
+ originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
+ recipientInfos RecipientInfos,
+ encryptedContentInfo EncryptedContentInfo,
+ unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL
+ }
+
+
+ EnvelopedData ::= SEQUENCE {
+ version CMSVersion,
+ originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
+ recipientInfos RecipientInfos,
+ encryptedContentInfo EncryptedContentInfo,
+ unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL
+ }
+
+
+ KekIdentifier ::= Sequence {
+ keyIdentifier OCTET STRING,
+ date GeneralizedTime OPTIONAL,
+ other OtherKeyAttribute OPTIONAL
+ }
+
+
+ KekRecipientInfo ::= Sequence {
+ version CMSVersion, -- always set to 4
+ kekID KekIdentifier,
+ keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
+ encryptedKey EncryptedKey
+ }
+
+
+ KeyAgreeRecipientIdentifier ::= CHOICE {
+ issuerAndSerialNumber IssuerAndSerialNumber,
+ rKeyId [0] IMPLICIT RecipientKeyIdentifier
+ }
+
+
+ * KeyAgreeRecipientInfo ::= Sequence {
+ * version CMSVersion, -- always set to 3
+ * originator [0] EXPLICIT OriginatorIdentifierOrKey,
+ * ukm [1] EXPLICIT UserKeyingMaterial OPTIONAL,
+ * keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
+ * recipientEncryptedKeys RecipientEncryptedKeys
+ * }
+ *
+ * UserKeyingMaterial ::= OCTET STRING
+ *
+
+ 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
+
+ OriginatorIdentifierOrKey ::= CHOICE {
+ issuerAndSerialNumber IssuerAndSerialNumber,
+ subjectKeyIdentifier [0] SubjectKeyIdentifier,
+ originatorKey [1] OriginatorPublicKey
+ }
+
+ SubjectKeyIdentifier ::= OCTET STRING
+
+
+ OriginatorInfo ::= Sequence {
+ certs [0] IMPLICIT CertificateSet OPTIONAL,
+ crls [1] IMPLICIT CertificateRevocationLists OPTIONAL
+ }
+
+
+ OriginatorPublicKey ::= Sequence {
+ algorithm AlgorithmIdentifier,
+ publicKey BIT STRING
+ }
+
+
+ OtherKeyAttribute ::= Sequence {
+ keyAttrId OBJECT IDENTIFIER,
+ keyAttr ANY DEFINED BY keyAttrId OPTIONAL
+ }
+
+
+ OtherRecipientInfo ::= Sequence {
+ oriType OBJECT IDENTIFIER,
+ oriValue ANY DEFINED BY oriType }
+
+
+ OtherRevocationInfoFormat ::= SEQUENCE {
+ otherRevInfoFormat OBJECT IDENTIFIER,
+ otherRevInfo ANY DEFINED BY otherRevInfoFormat }
+
+
+ PasswordRecipientInfo ::= Sequence {
+ version CMSVersion, -- Always set to 0
+ keyDerivationAlgorithm [0] KeyDerivationAlgorithmIdentifier
+ OPTIONAL,
+ keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
+ encryptedKey EncryptedKey }
+
+
+ RecipientEncryptedKey ::= SEQUENCE {
+ rid KeyAgreeRecipientIdentifier,
+ encryptedKey EncryptedKey
+ }
+
+
+ RecipientIdentifier ::= CHOICE {
+ issuerAndSerialNumber IssuerAndSerialNumber,
+ subjectKeyIdentifier [0] SubjectKeyIdentifier
+ }
+
+ SubjectKeyIdentifier ::= OCTET STRING
+
+
+ RecipientInfo ::= CHOICE {
+ ktri KeyTransRecipientInfo,
+ kari [1] KeyAgreeRecipientInfo,
+ kekri [2] KekRecipientInfo,
+ pwri [3] PasswordRecipientInfo,
+ ori [4] OtherRecipientInfo }
+
+
+ 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.
+
+ 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
+ }
+
+
+ SignerIdentifier ::= CHOICE {
+ issuerAndSerialNumber IssuerAndSerialNumber,
+ subjectKeyIdentifier [0] SubjectKeyIdentifier
+ }
+
+ SubjectKeyIdentifier ::= OCTET STRING
+
+
+ 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
+
+
+ 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. +
+ 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.
+
+ 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.
+
+ 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 }
+
+
+ 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.
+
+ 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.
+
+ 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.
+
+ Gost28147-89-Parameters ::=
+ SEQUENCE {
+ iv Gost28147-89-IV,
+ encryptionParamSet OBJECT IDENTIFIER
+ }
+
+ Gost28147-89-IV ::= OCTET STRING (SIZE (8))
+
+ 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.
+ 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
+ 0 single-ASN1-type1 OCTET STRING2 BIT STRING+ 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.
+ + @param time the time string.
++ 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.
+
+ CertificateValues ::= SEQUENCE OF Certificate
+
+
+ CommitmentTypeIndication ::= SEQUENCE {
+ commitmentTypeId CommitmentTypeIdentifier,
+ commitmentTypeQualifier SEQUENCE SIZE (1..MAX) OF
+ CommitmentTypeQualifier OPTIONAL }
+
+
+ CommitmentTypeQualifier ::= SEQUENCE {
+ commitmentTypeIdentifier CommitmentTypeIdentifier,
+ qualifier ANY DEFINED BY commitmentTypeIdentifier OPTIONAL }
+
+ CommitmentTypeQualifier instance.
+
+ @param commitmentTypeIdentifier a CommitmentTypeIdentifier value
+ CommitmentTypeQualifier instance.
+
+ @param commitmentTypeIdentifier a CommitmentTypeIdentifier value
+ @param qualifier the qualifier, defined by the above field.
+ CommitmentTypeQualifier instance.
+
+ @param as CommitmentTypeQualifier structure
+ encoded as an Asn1Sequence.
+ Asn1Object value
+
+ CompleteCertificateRefs ::= SEQUENCE OF OtherCertID
+
+
+ CompleteRevocationRefs ::= SEQUENCE OF CrlOcspRef
+
+
+ CrlIdentifier ::= SEQUENCE
+ {
+ crlissuer Name,
+ crlIssuedTime UTCTime,
+ crlNumber INTEGER OPTIONAL
+ }
+
+
+ CRLListID ::= SEQUENCE
+ {
+ crls SEQUENCE OF CrlValidatedID
+ }
+
+
+ CrlOcspRef ::= SEQUENCE {
+ crlids [0] CRLListID OPTIONAL,
+ ocspids [1] OcspListID OPTIONAL,
+ otherRev [2] OtherRevRefs OPTIONAL
+ }
+
+
+ CrlValidatedID ::= SEQUENCE {
+ crlHash OtherHash,
+ crlIdentifier CrlIdentifier OPTIONAL}
+
+
+ OcspIdentifier ::= SEQUENCE {
+ ocspResponderID ResponderID,
+ -- As in OCSP response data
+ producedAt GeneralizedTime
+ -- As in OCSP response data
+ }
+
+
+ OcspListID ::= SEQUENCE {
+ ocspResponses SEQUENCE OF OcspResponsesID
+ }
+
+
+ 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
+
+
+ OtherHashAlgAndValue ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ hashValue OtherHashValue
+ }
+
+ OtherHashValue ::= OCTET STRING
+
+
+ OtherRevRefs ::= SEQUENCE
+ {
+ otherRevRefType OtherRevRefType,
+ otherRevRefs ANY DEFINED BY otherRevRefType
+ }
+
+ OtherRevRefType ::= OBJECT IDENTIFIER
+
+
+ OtherRevVals ::= SEQUENCE
+ {
+ otherRevValType OtherRevValType,
+ otherRevVals ANY DEFINED BY otherRevValType
+ }
+
+ OtherRevValType ::= OBJECT IDENTIFIER
+
+
+ OtherSigningCertificate ::= SEQUENCE {
+ certs SEQUENCE OF OtherCertID,
+ policies SEQUENCE OF PolicyInformation OPTIONAL
+ }
+
+
+ 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.
+
+
+ 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
+
+
+ ContentHints ::= SEQUENCE {
+ contentDescription UTF8String (SIZE (1..MAX)) OPTIONAL,
+ contentType ContentType }
+
+ + 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 } +
+ 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
+ }
+
+
+ OtherCertID ::= SEQUENCE {
+ otherCertHash OtherHash,
+ issuerSerial IssuerSerial OPTIONAL }
+
+ OtherHash ::= CHOICE {
+ sha1Hash OCTET STRING,
+ otherHash OtherHashAlgAndValue }
+
+ OtherHashAlgAndValue ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ hashValue OCTET STRING }
+
+
+
+ OtherSigningCertificate ::= SEQUENCE {
+ certs SEQUENCE OF OtherCertID,
+ policies SEQUENCE OF PolicyInformation OPTIONAL
+ }
+
+ id-aa-ets-otherSigCert OBJECT IDENTIFIER ::= { iso(1)
+ member-body(2) us(840) rsadsi(113549) pkcs(1) pkcs9(9)
+ smime(16) id-aa(2) 19 }
+
+ 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 }
+
+ 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 }
+ + If you use this interface your class should also implement the getInstance + pattern which takes a tag object and the tagging mode used. +
+
+ CscaMasterList ::= SEQUENCE {
+ version CscaMasterListVersion,
+ certList SET OF Certificate }
+
+ CscaMasterListVersion :: INTEGER {v0(0)}
+
+
+ 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) }
+
+
+
+ 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
+ + DateOfCertGenSyntax ::= GeneralizedTime ++
+ ICCSNSyntax ::= OCTET STRING (SIZE(8..20)) ++
+ PKReferenceSyntax ::= OCTET STRING (SIZE(20)) ++
+ RestrictionSyntax ::= DirectoryString (SIZE(1..1024)) ++ + @see Org.BouncyCastle.Asn1.IsisMtt.X509.Restriction +
+ RetrieveIfAllowed ::= BOOLEAN ++
+ CertInDirSince ::= GeneralizedTime ++
+ NameAtBirth ::= DirectoryString(SIZE(1..64) ++ + Used in + {@link Org.BouncyCastle.Asn1.X509.SubjectDirectoryAttributes SubjectDirectoryAttributes} +
+ AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048)) ++ + @see Org.BouncyCastle.Asn1.IsisMtt.X509.AdditionalInformationSyntax +
+ LiabilityLimitationFlagSyntax ::= BOOLEAN ++
+ CertHash ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ certificateHash OCTET STRING
+ }
+
+
+ CertHash ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ certificateHash OCTET STRING
+ }
+
+
+ @param seq The ASN.1 sequence.
+
+ CertHash ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ certificateHash OCTET STRING
+ }
+
+
+ @return an Asn1Object
+
+ RequestedCertificate ::= CHOICE {
+ Certificate Certificate,
+ publicKeyCertificate [0] EXPLICIT OCTET STRING,
+ attributeCertificate [1] EXPLICIT OCTET STRING
+ }
+
+ null.
+
+ @param certificate Given as Certificate
+
+ RequestedCertificate ::= CHOICE {
+ Certificate Certificate,
+ publicKeyCertificate [0] EXPLICIT OCTET STRING,
+ attributeCertificate [1] EXPLICIT OCTET STRING
+ }
+
+
+ @return an Asn1Object
+ + AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048)) ++
+ AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048)) ++ + @return an Asn1Object +
+ 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
+
+ Admissions ::= SEQUENCE
+ {
+ admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
+ namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
+ professionInfos SEQUENCE OF ProfessionInfo
+ }
+
+
+ @param seq The ASN.1 sequence.
+ professionInfos is mandatory.
+
+ @param admissionAuthority The admission authority.
+ @param namingAuthority The naming authority.
+ @param professionInfos The profession infos.
+
+ Admissions ::= SEQUENCE
+ {
+ admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
+ namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
+ professionInfos SEQUENCE OF ProfessionInfo
+ }
+
+
+
+ @return an Asn1Object
+
+ 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:
+
+ 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.
+
+ 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
+
+ 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.
+
+ 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
+
+ MonetaryLimitSyntax ::= SEQUENCE
+ {
+ currency PrintableString (SIZE(3)),
+ amount INTEGER,
+ exponent INTEGER
+ }
+
+
+ currency must be the ISO code.
+
+ value = amount�10*exponent
+
+ MonetaryLimitSyntax ::= SEQUENCE
+ {
+ currency PrintableString (SIZE(3)),
+ amount INTEGER,
+ exponent INTEGER
+ }
+
+
+ @return an Asn1Object
+
+ NamingAuthority ::= SEQUENCE
+ {
+ namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
+ namingAuthorityUrl IA5String OPTIONAL,
+ namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
+ }
+
+ @see Org.BouncyCastle.Asn1.IsisMtt.X509.AdmissionSyntax
+
+
+ NamingAuthority ::= SEQUENCE
+ {
+ namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
+ namingAuthorityUrl IA5String OPTIONAL,
+ namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
+ }
+
+
+ @param seq The ASN.1 sequence.
+
+ NamingAuthority ::= SEQUENCE
+ {
+ namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
+ namingAuthorityUrl IA5String OPTIONAL,
+ namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
+ }
+
+
+ @return an Asn1Object
+ + 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
+ }
+
+
+
+ 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.
+ 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.
+ 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.
+
+ 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
+
+ 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
+
+ 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.
+ 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.
+
+ 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
+ + RestrictionSyntax ::= DirectoryString (SIZE(1..1024)) ++
+ RestrictionSyntax ::= DirectoryString (SIZE(1..1024)) ++ + @param restriction A IAsn1String. +
+ RestrictionSyntax ::= DirectoryString (SIZE(1..1024)) + ++ + @return an Asn1Object +
+ cast5CBCParameters ::= Sequence {
+ iv OCTET STRING DEFAULT 0,
+ -- Initialization vector
+ keyLength Integer
+ -- Key length, in bits
+ }
+
+
+ IDEA-CBCPar ::= Sequence {
+ iv OCTET STRING OPTIONAL -- exactly 8 octets
+ }
+
+
+ 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) }
+
+
+ PublicKeyAndChallenge ::= SEQUENCE {
+ spki SubjectPublicKeyInfo,
+ challenge IA5STRING
+ }
+
+
+
+ BasicOcspResponse ::= Sequence {
+ tbsResponseData ResponseData,
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING,
+ certs [0] EXPLICIT Sequence OF Certificate OPTIONAL }
+
+
+ CertID ::= Sequence {
+ hashAlgorithm AlgorithmIdentifier,
+ issuerNameHash OCTET STRING, -- Hash of Issuer's DN
+ issuerKeyHash OCTET STRING, -- Hash of Issuers public key
+ serialNumber CertificateSerialNumber }
+
+
+ CertStatus ::= CHOICE {
+ good [0] IMPLICIT Null,
+ revoked [1] IMPLICIT RevokedInfo,
+ unknown [2] IMPLICIT UnknownInfo }
+
+
+ CrlID ::= Sequence {
+ crlUrl [0] EXPLICIT IA5String OPTIONAL,
+ crlNum [1] EXPLICIT Integer OPTIONAL,
+ crlTime [2] EXPLICIT GeneralizedTime OPTIONAL }
+
+
+ OcspRequest ::= Sequence {
+ tbsRequest TBSRequest,
+ optionalSignature [0] EXPLICIT Signature OPTIONAL }
+
+
+ OcspResponse ::= Sequence {
+ responseStatus OcspResponseStatus,
+ responseBytes [0] EXPLICIT ResponseBytes OPTIONAL }
+
+
+ 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
+ }
+
+
+ Request ::= Sequence {
+ reqCert CertID,
+ singleRequestExtensions [0] EXPLICIT Extensions OPTIONAL }
+
+
+ ResponderID ::= CHOICE {
+ byName [1] Name,
+ byKey [2] KeyHash }
+
+
+ ResponseBytes ::= Sequence {
+ responseType OBJECT IDENTIFIER,
+ response OCTET STRING }
+
+
+ ResponseData ::= Sequence {
+ version [0] EXPLICIT Version DEFAULT v1,
+ responderID ResponderID,
+ producedAt GeneralizedTime,
+ responses Sequence OF SingleResponse,
+ responseExtensions [1] EXPLICIT Extensions OPTIONAL }
+
+
+ RevokedInfo ::= Sequence {
+ revocationTime GeneralizedTime,
+ revocationReason [0] EXPLICIT CRLReason OPTIONAL }
+
+
+ ServiceLocator ::= Sequence {
+ issuer Name,
+ locator AuthorityInfoAccessSyntax OPTIONAL }
+
+
+ Signature ::= Sequence {
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING,
+ certs [0] EXPLICIT Sequence OF Certificate OPTIONAL}
+
+
+ SingleResponse ::= Sequence {
+ certID CertID,
+ certStatus CertStatus,
+ thisUpdate GeneralizedTime,
+ nextUpdate [0] EXPLICIT GeneralizedTime OPTIONAL,
+ singleExtensions [1] EXPLICIT Extensions OPTIONAL }
+
+
+ TBSRequest ::= Sequence {
+ version [0] EXPLICIT Version DEFAULT v1,
+ requestorName [1] EXPLICIT GeneralName OPTIONAL,
+ requestList Sequence OF Request,
+ requestExtensions [2] EXPLICIT Extensions OPTIONAL }
+
+
+ Attr ::= Sequence {
+ attrType OBJECT IDENTIFIER,
+ attrValues Set OF AttributeValue
+ }
+
+
+ CertificationRequest ::= Sequence {
+ certificationRequestInfo CertificationRequestInfo,
+ signatureAlgorithm AlgorithmIdentifier{{ SignatureAlgorithms }},
+ signature BIT STRING
+ }
+
+
+ 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})
+ }
+
+
+ ContentInfo ::= Sequence {
+ contentType ContentType,
+ content
+ [0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
+
+
+ EncryptedData ::= Sequence {
+ version Version,
+ encryptedContentInfo EncryptedContentInfo
+ }
+
+
+ EncryptedContentInfo ::= Sequence {
+ contentType ContentType,
+ contentEncryptionAlgorithm ContentEncryptionAlgorithmIdentifier,
+ encryptedContent [0] IMPLICIT EncryptedContent OPTIONAL
+ }
+
+ EncryptedContent ::= OCTET STRING
+
+
+ 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.
+
+ id-alg-AEADChaCha20Poly1305 OBJECT IDENTIFIER ::=
+ { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1)
+ pkcs9(9) smime(16) alg(3) 18 }
+
+ AEADChaCha20Poly1305Nonce ::= OCTET STRING (SIZE(12))
+
+
+ [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 } }
+
+
+ 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.
+
+ 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.
+
+ 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.
+
+ SignedData ::= Sequence {
+ version Version,
+ digestAlgorithms DigestAlgorithmIdentifiers,
+ contentInfo ContentInfo,
+ certificates
+ [0] IMPLICIT ExtendedCertificatesAndCertificates
+ OPTIONAL,
+ crls
+ [1] IMPLICIT CertificateRevocationLists OPTIONAL,
+ signerInfos SignerInfos }
+
+
+ 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
+
+ + SMIMECapabilities ::= Sequence OF SMIMECapability ++
+ SMIMECapability ::= Sequence {
+ capabilityID OBJECT IDENTIFIER,
+ parameters ANY DEFINED BY capabilityID OPTIONAL
+ }
+
+
+ SmimeEncryptionKeyPreference ::= CHOICE {
+ issuerAndSerialNumber [0] IssuerAndSerialNumber,
+ receipentKeyId [1] RecipientKeyIdentifier,
+ subjectAltKeyIdentifier [2] SubjectKeyIdentifier
+ }
+
+
+ Accuracy ::= SEQUENCE {
+ seconds INTEGER OPTIONAL,
+ millis [0] INTEGER (1..999) OPTIONAL,
+ micros [1] INTEGER (1..999) OPTIONAL
+ }
+
+
+ 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 }
+
+
+
+ AttributeTypeAndValue ::= SEQUENCE {
+ type OBJECT IDENTIFIER,
+ value ANY DEFINED BY type }
+
+ @return 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)) }
+
+
+ * RelativeDistinguishedName ::=
+ * SET OF AttributeTypeAndValue
+
+ * AttributeTypeAndValue ::= SEQUENCE {
+ * type AttributeType,
+ * value AttributeValue }
+ *
+ * @return this object as its ASN1Primitive type
+
+ AccessDescription ::= SEQUENCE {
+ accessMethod OBJECT IDENTIFIER,
+ accessLocation GeneralName }
+
+
+ AlgorithmIdentifier ::= Sequence {
+ algorithm OBJECT IDENTIFIER,
+ parameters ANY DEFINED BY algorithm OPTIONAL }
+
+
+ AttCertIssuer ::= CHOICE {
+ v1Form GeneralNames, -- MUST NOT be used in this
+ -- profile
+ v2Form [0] V2Form -- v2 only
+ }
+
+
+ AttCertValidityPeriod ::= Sequence {
+ notBeforeTime GeneralizedTime,
+ notAfterTime GeneralizedTime
+ }
+
+
+ Attr ::= Sequence {
+ attrType OBJECT IDENTIFIER,
+ attrValues Set OF AttributeValue
+ }
+
+
+ AttributeCertificate ::= Sequence {
+ acinfo AttributeCertificateInfo,
+ signatureAlgorithm AlgorithmIdentifier,
+ signatureValue BIT STRING
+ }
+
+
+ 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) }
+
+
+ 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 }
+
+
+ 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
+
+
+ + * SubjectPublicKeyInfo apki = new SubjectPublicKeyInfo((ASN1Sequence)new ASN1InputStream( + * publicKey.getEncoded()).readObject()); + * AuthorityKeyIdentifier aki = new AuthorityKeyIdentifier(apki); + *+ * + * +
+ BasicConstraints := Sequence {
+ cA Boolean DEFAULT FALSE,
+ pathLenConstraint Integer (0..MAX) OPTIONAL
+ }
+
+
+ CertificateList ::= Sequence {
+ tbsCertList TbsCertList,
+ signatureAlgorithm AlgorithmIdentifier,
+ signatureValue BIT STRING }
+
+
+ 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 -- }
+
+
+ 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.
+
+ CertificatePair ::= SEQUENCE {
+ forward [0] Certificate OPTIONAL,
+ reverse [1] Certificate OPTIONAL,
+ -- at least one of the pair shall be present -- }
+
+
+ @return a DERObject
+
+ CertificatePolicies ::= SEQUENCE SIZE {1..MAX} OF PolicyInformation
+
+ + CertPolicyId ::= OBJECT IDENTIFIER ++
+ CrlDistPoint ::= Sequence SIZE {1..MAX} OF DistributionPoint
+
+ + CRLNumber::= Integer(0..MAX) ++
+ CRLReason ::= Enumerated {
+ unspecified (0),
+ keyCompromise (1),
+ cACompromise (2),
+ affiliationChanged (3),
+ superseded (4),
+ cessationOfOperation (5),
+ certificateHold (6),
+ removeFromCRL (8),
+ privilegeWithdrawn (9),
+ aACompromise (10)
+ }
+
+
+ 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
+ DisplayTextMaximumSize here.
+
+ DisplayText instance.
+
+ @param type the desired encoding type for the text.
+ @param text the text to store. Strings longer than 200
+ characters are truncated.
+ DisplayText instance.
+
+ @param text the text to encapsulate. Strings longer than 200
+ characters are truncated.
+ DisplayText instance.
+ Useful when reading back a DisplayText class
+ from it's Asn1Encodable form.
Asn1Encodable instance.
+ string object.
+
+ @return the stored text as a string.
+
+ DistributionPoint ::= Sequence {
+ distributionPoint [0] DistributionPointName OPTIONAL,
+ reasons [1] ReasonFlags OPTIONAL,
+ cRLIssuer [2] GeneralNames OPTIONAL
+ }
+
+
+ DistributionPointName ::= CHOICE {
+ fullName [0] GeneralNames,
+ nameRelativeToCRLIssuer [1] RDN
+ }
+
+ + extendedKeyUsage ::= Sequence SIZE (1..MAX) OF KeyPurposeId ++
+ 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 }
+
+ + This constructor can handle: +
+ 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. +
+ GeneralNames ::= Sequence SIZE {1..MAX} OF GeneralName
+
+
+
+ GeneralSubtree ::= SEQUENCE
+ {
+ baseName GeneralName,
+ minimum [0] BaseDistance DEFAULT 0,
+ maximum [1] BaseDistance OPTIONAL
+ }
+
+
+ @see org.bouncycastle.asn1.x509.NameConstraints
+
+
+ If minimum is null, zero is assumed, if
+ maximum is null, maximum is absent.
+ GeneralSubtree ::= SEQUENCE
+ {
+ baseName GeneralName,
+ minimum [0] BaseDistance DEFAULT 0,
+ maximum [1] BaseDistance OPTIONAL
+ }
+
+
+ @return a DERObject
+ + 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
+
+
+
+ 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
+ }
+
+ IetfAttrSyntax as specified by RFC3281.
+
+
+ IetfAttrSyntax ::= Sequence {
+ policyAuthority [0] GeneralNames OPTIONAL,
+ values Sequence OF CHOICE {
+ octets OCTET STRING,
+ oid OBJECT IDENTIFIER,
+ string UTF8String
+ }
+ }
+
+
+
+ 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 }
+
+ true then the CRL contains revocation
+ information about certificates ssued by other CAs.
+ @param onlyContainsAttributeCerts Covers revocation information for attribute certificates.
+ + KeyPurposeID ::= OBJECT IDENTIFIER ++
+ 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) }
+
+ 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
+ NoticeReference instance.
+
+ @param organization a String value
+ @param numbers a Vector value
+ NoticeReference instance.
+
+ @param organization a String value
+ @param noticeNumbers an ASN1EncodableVector value
+ NoticeReference instance.
+
+ @param organization displayText
+ @param noticeNumbers an ASN1EncodableVector value
+ NoticeReference instance.
+ Useful for reconstructing a NoticeReference
+ instance from its encodable/encoded form.
Asn1Sequence value obtained from either
+ calling @{link ToAsn1Object()} for a NoticeReference
+ instance or from parsing it from a Der-encoded stream.
+ ToAsn1Object method here.
+
+ @return a Asn1Object value
+
+
+ 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
+ }
+
+
+
+
+ If digestedObjectType is not {@link #publicKeyCert} or
+ {@link #publicKey} otherObjectTypeID must be given,
+ otherwise it is ignored.
otherObjectDigest.
+ @param digestAlgorithm The algorithm identifier for the hash.
+ @param objectDigest The hash value.
+
+
+ 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
+ }
+
+
+
+ OtherName ::= SEQUENCE {
+ type-id OBJECT IDENTIFIER,
+ value [0] EXPLICIT ANY DEFINED BY type-id }
+
+
+ OtherName. It must be an instance of OtherName
+ or ASN1Sequence.
+ @return the instance of OtherName built from the
+ supplied object.
+ @throws java.lang.IllegalArgumentException if the object passed
+ to the factory is not an instance of OtherName or something that
+ can be converted into an appropriate ASN1Sequence.
+
+ PolicyMappings ::= Sequence SIZE (1..MAX) OF Sequence {
+ issuerDomainPolicy CertPolicyId,
+ subjectDomainPolicy CertPolicyId }
+
+
+ @see RFC 3280, section 4.2.1.6
+ PolicyMappings instance.
+
+ @param seq an Asn1Sequence constructed as specified
+ in RFC 3280
+ PolicyMappings instance.
+
+ @param mappings a HashMap value that maps
+ string oids
+ to other string oids.
+
+ 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 )
+
+
+ PolicyQualifierInfo ::= Sequence {
+ policyQualifierId PolicyQualifierId,
+ qualifier ANY DEFINED BY policyQualifierId }
+
+ PolicyQualifierInfo instance.
+
+ @param policyQualifierId a PolicyQualifierId value
+ @param qualifier the qualifier, defined by the above field.
+ PolicyQualifierInfo containing a
+ cPSuri qualifier.
+
+ @param cps the CPS (certification practice statement) uri as a
+ string.
+ PolicyQualifierInfo instance.
+
+ @param as PolicyQualifierInfo X509 structure
+ encoded as an Asn1Sequence.
+ Asn1Object value
+
+ PrivateKeyUsagePeriod ::= SEQUENCE
+ {
+ notBefore [0] GeneralizedTime OPTIONAL,
+ notAfter [1] GeneralizedTime OPTIONAL }
+
+
+ BiometricData ::= SEQUENCE {
+ typeOfBiometricData TypeOfBiometricData,
+ hashAlgorithm AlgorithmIdentifier,
+ biometricDataHash OCTET STRING,
+ sourceDataUri IA5String OPTIONAL }
+
+
+ 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
+
+
+ MonetaryValue ::= SEQUENCE {
+ currency Iso4217CurrencyCode,
+ amount INTEGER,
+ exponent INTEGER }
+ -- value = amount * 10^exponent
+
+
+ QCStatement ::= SEQUENCE {
+ statementId OBJECT IDENTIFIER,
+ statementInfo ANY DEFINED BY statementId OPTIONAL}
+
+
+ SemanticsInformation ::= SEQUENCE {
+ semanticsIdentifier OBJECT IDENTIFIER OPTIONAL,
+ nameRegistrationAuthorities NameRegistrationAuthorities
+ OPTIONAL }
+ (WITH COMPONENTS {..., semanticsIdentifier PRESENT}|
+ WITH COMPONENTS {..., nameRegistrationAuthorities PRESENT})
+
+ NameRegistrationAuthorities ::= SEQUENCE SIZE (1..MAX) OF
+ GeneralName
+
+
+ TypeOfBiometricData ::= CHOICE {
+ predefinedBiometricType PredefinedBiometricType,
+ biometricDataOid OBJECT IDENTIFIER }
+
+ PredefinedBiometricType ::= INTEGER {
+ picture(0),handwritten-signature(1)}
+ (picture|handwritten-signature)
+
+
+ ReasonFlags ::= BIT STRING {
+ unused(0),
+ keyCompromise(1),
+ cACompromise(2),
+ affiliationChanged(3),
+ superseded(4),
+ cessationOfOperation(5),
+ certficateHold(6)
+ }
+
+
+ RoleSyntax ::= SEQUENCE {
+ roleAuthority [0] GeneralNames OPTIONAL,
+ roleName [1] GeneralName
+ }
+
+
+ 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.
+ new RoleSyntax(null, roleName).
+ @param roleName the role name of this RoleSyntax.
+ string argument representing
+ the role name, builds a GeneralName to hold the role name
+ and calls the constructor that takes a GeneralName.
+ @param roleName
+ 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.
+ GeneralNames holding the
+ role authority of this RoleSyntax.
+ GeneralName holding the
+ role name of this RoleSyntax.
+ java.lang.string object.
+ @return the role name of this RoleSyntax represented as a
+ string object.
+ string[] object.
+ @return the role authority of this RoleSyntax represented as a
+ string[] array.
+ ToAsn1Object as
+ required by the superclass ASN1Encodable.
+
+
+ RoleSyntax ::= SEQUENCE {
+ roleAuthority [0] GeneralNames OPTIONAL,
+ roleName [1] GeneralName
+ }
+
+
+ RSAPublicKey ::= Sequence {
+ modulus Integer, -- n
+ publicExponent Integer, -- e
+ }
+
+
+ NameOrPseudonym ::= CHOICE {
+ surAndGivenName SEQUENCE {
+ surName DirectoryString,
+ givenName SEQUENCE OF DirectoryString
+ },
+ pseudonym DirectoryString
+ }
+
+
+ @see org.bouncycastle.asn1.x509.sigi.PersonalData
+
+
+ NameOrPseudonym ::= CHOICE {
+ surAndGivenName SEQUENCE {
+ surName DirectoryString,
+ givenName SEQUENCE OF DirectoryString
+ },
+ pseudonym DirectoryString
+ }
+
+ @param pseudonym pseudonym value to use.
+
+ NameOrPseudonym ::= CHOICE {
+ surAndGivenName SEQUENCE {
+ surName DirectoryString,
+ givenName SEQUENCE OF DirectoryString
+ },
+ pseudonym DirectoryString
+ }
+
+
+ @param seq The ASN.1 sequence.
+
+ NameOrPseudonym ::= CHOICE {
+ surAndGivenName SEQUENCE {
+ surName DirectoryString,
+ givenName SEQUENCE OF DirectoryString
+ },
+ pseudonym DirectoryString
+ }
+
+
+ @return an Asn1Object
+
+ 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
+
+ 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.
+
+ 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
+
+ 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.X509Name for AttributeType ObjectIdentifiers.
+
+ 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.
+
+ 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
+ + SubjectKeyIdentifier::= OCTET STRING ++
+ (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. +
+ (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 GetEncoded() method in the public keys in the JCE produces a DER + encoded one of these.
+
+ SubjectPublicKeyInfo ::= Sequence {
+ algorithm AlgorithmIdentifier,
+ publicKey BIT STRING }
+
+
+ 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.
+
+ obj can be a Target or a {@link Asn1TaggedObject}
+ Exactly one of the parameters must be not null.
+ Target ::= CHOICE {
+ targetName [0] GeneralName,
+ targetGroup [1] GeneralName,
+ targetCert [2] TargetCert
+ }
+
+
+ @return an Asn1Object
+ + SEQUENCE OF Targets ++ +
+ obj can be a TargetInformation or a {@link Asn1Sequence}
+ The ArrayList is cloned before it is returned.
+ + @return Returns the targets. ++ 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 ::= 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
+
+ obj can be a Targets or a {@link Asn1Sequence}
+ The ArrayList is copied.
+ + @param targets AnArrayList of {@link Target}s.
+ @see Target
+ @throws ArgumentException if the ArrayList contains not only Targets.
+ ArrayList.
+ + The ArrayList is cloned before it is returned.
+ + @return Returns the targets. ++ Targets ::= SEQUENCE OF Target ++ + @return an Asn1Object +
+ 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.
+
+ 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
+ }
+
+
+ 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
+ UserNotice instance.
+
+ @param noticeRef a NoticeReference value
+ @param explicitText a DisplayText value
+ UserNotice instance.
+
+ @param noticeRef a NoticeReference value
+ @param str the explicitText field as a string.
+ 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.
+ TbsCertificate ::= Sequence {
+ version [ 0 ] Version DEFAULT v1(0),
+ serialNumber CertificateSerialNumber,
+ signature AlgorithmIdentifier,
+ issuer Name,
+ validity Validity,
+ subject Name,
+ subjectPublicKeyInfo SubjectPublicKeyInfo,
+ }
+
+
+
+ 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
+ }
+
+
+
+ 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
+ }
+
+
+ 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
+
+ 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
+ }
+
+
+
+ Certificate ::= Sequence {
+ tbsCertificate TbsCertificate,
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING
+ }
+
+ + it's is assumed the table contains Oid/string pairs.
++ It's is assumed the table contains Oid/string pairs.
++ it's is assumed the table contains Oid/string pairs.
++ It's is assumed the table contains Oid/string pairs.
+
+ Extensions ::= SEQUENCE SIZE (1..MAX) OF Extension
+
+ Extension ::= SEQUENCE {
+ extnId EXTENSION.&id ({ExtensionSet}),
+ critical BOOLEAN DEFAULT FALSE,
+ extnValue OCTET STRING }
+
+
+ RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
+
+ RelativeDistinguishedName ::= SET SIZE (1..MAX) OF AttributeTypeAndValue
+
+ AttributeTypeAndValue ::= SEQUENCE {
+ type OBJECT IDENTIFIER,
+ value ANY }
+
+ Note: if you're trying to be ultra orthodox, don't use this! It shouldn't be in here.
++ it's is assumed the table contains OID/string pairs, and the contents + of the table are copied into an internal table as part of the + construction process. The ordering ArrayList should contain the OIDs + in the order they are meant to be encoded or printed in ToString.
++ it's is assumed the table contains OID/string pairs, and the contents + of the table are copied into an internal table as part of the + construction process. The ordering ArrayList should contain the OIDs + in the order they are meant to be encoded or printed in ToString.
++ The passed in converter will be used to convert the strings into their + ASN.1 counterparts.
++ The passed in converter will be used to convert the strings into their + ASN.1 counterparts.
++ * An example of an encoder look like below: + *
+ * public class X509DirEntryConverter
+ * : X509NameEntryConverter
+ * {
+ * public Asn1Object GetConvertedValue(
+ * DerObjectIdentifier oid,
+ * string value)
+ * {
+ * if (str.Length() != 0 && str.charAt(0) == '#')
+ * {
+ * return ConvertHexEncoded(str, 1);
+ * }
+ * if (oid.Equals(EmailAddress))
+ * {
+ * return new DerIA5String(str);
+ * }
+ * else if (CanBePrintable(str))
+ * {
+ * return new DerPrintableString(str);
+ * }
+ * else if (CanBeUTF8(str))
+ * {
+ * return new DerUtf8String(str);
+ * }
+ * else
+ * {
+ * return new DerBmpString(str);
+ * }
+ * }
+ * }
+ *
+ *
+
+ KeySpecificInfo ::= Sequence {
+ algorithm OBJECT IDENTIFIER,
+ counter OCTET STRING SIZE (4..4)
+ }
+
+
+ OtherInfo ::= Sequence {
+ keyInfo KeySpecificInfo,
+ partyAInfo [0] OCTET STRING OPTIONAL,
+ suppPubInfo [2] OCTET STRING
+ }
+
+
+ Parameters ::= CHOICE {
+ ecParameters ECParameters,
+ namedCurve CURVES.&id({CurveNames}),
+ implicitlyCA Null
+ }
+
+
+ Curve ::= Sequence {
+ a FieldElement,
+ b FieldElement,
+ seed BIT STRING OPTIONAL
+ }
+
+
+ ECParameters ::= Sequence {
+ version Integer { ecpVer1(1) } (ecpVer1),
+ fieldID FieldID {{FieldTypes}},
+ curve X9Curve,
+ base X9ECPoint,
+ order Integer,
+ cofactor Integer OPTIONAL
+ }
+
+ + ECPoint ::= OCTET STRING ++
+ Octet string produced using ECPoint.GetEncoded().
++ FieldElement ::= OCTET STRING ++
+
F2.
+ @param primeP The prime p defining the prime field.
+ F2m.
+ @param m The exponent m of
+ F2m.
+ @param k1 The integer k1 where xm +
+ xk1 + 1
+ represents the reduction polynomial f(z).
+ 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)..
+
+ FieldID ::= Sequence {
+ fieldType FIELD-ID.&id({IOSet}),
+ parameters FIELD-ID.&Type({IOSet}{@fieldType})
+ }
+
+ + Return an output stream which will save the data being written to + the compressed object. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Return an output stream which will compress the data as it is written to it. + The stream will be written out in chunks according to the size of the passed in buffer. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Note: if the buffer is not a power of 2 in length only the largest power of 2 + bytes worth of the buffer will be used. +
++ Note: using this may break compatibility with RFC 1991 compliant tools. + Only recent OpenPGP implementations are capable of accepting these streams. +
++ If buffer is non null stream assumed to be partial, otherwise the length will be used + to output a fixed length packet. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Return an output stream which will encrypt the data as it is written to it. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Return an output stream which will encrypt the data as it is written to it. + The stream will be written out in chunks according to the size of the passed in buffer. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Note: if the buffer is not a power of 2 in length only the largest power of 2 + bytes worth of the buffer will be used. +
++ Close off the encrypted object - this is equivalent to calling Close() on the stream + returned by the Open() method. +
++ Note: This does not close the underlying output stream, only the stream on top of + it created by the Open() method. +
++ A word for the unwary, the KeyId for an OpenPGP public key is calculated from + a hash that includes the time of creation, if you pass a different date to the + constructor below with the same public private key pair the KeyIs will not be the + same as for previous generations of the key, so ideally you only want to do + this once. +
++ Open a literal data packet, returning a stream to store the data inside the packet. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Open a literal data packet, returning a stream to store the data inside the packet, + as an indefinite length stream. The stream is written out as a series of partial + packets with a chunk size determined by the size of the passed in buffer. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Note: if the buffer is not a power of 2 in length only the largest power of 2 + bytes worth of the buffer will be used.
+
+ Open a literal data packet for the passed in
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Note: if this class finds a PgpPublicKey or a PgpSecretKey it + will create a PgpPublicKeyRing, or a PgpSecretKeyRing for each + key found. If all you are trying to do is read a key ring file use + either PgpPublicKeyRingBundle or PgpSecretKeyRingBundle.
+
+ Often PGP keyring files consist of multiple master keys, if you are trying to process
+ or construct one of these you should use the
+ Often PGP keyring files consist of multiple master keys, if you are trying to process
+ or construct one of these you should use the
+ Note: this overrides the generation of a creation time when the signature + is generated.
++ Format documented here: + http://git.gnupg.org/cgi-bin/gitweb.cgi?p=gnupg.git;a=blob;f=agent/keyformat.txt;h=42c4b1f06faf1bbe71ffadc2fee0fad6bec91a97;hb=refs/heads/master +
++ CMSAuthenticatedDataGenerator fact = new CMSAuthenticatedDataGenerator(); + + fact.addKeyTransRecipient(cert); + + CMSAuthenticatedData data = fact.generate(content, algorithm, "BC"); ++
+ Note: that because we are in a streaming mode only one recipient can be tried and it is important + that the methods on the parser are called in the appropriate order. +
++ Example of use - assuming the first recipient matches the private key we have. +
+ CMSAuthenticatedDataParser ad = new CMSAuthenticatedDataParser(inputStream);
+
+ RecipientInformationStore recipients = ad.getRecipientInfos();
+
+ Collection c = recipients.getRecipients();
+ Iterator it = c.iterator();
+
+ if (it.hasNext())
+ {
+ RecipientInformation recipient = (RecipientInformation)it.next();
+
+ CMSTypedStream recData = recipient.getContentStream(privateKey, "BC");
+
+ processDataStream(recData.getContentStream());
+
+ if (!Arrays.equals(ad.getMac(), recipient.getMac())
+ {
+ System.err.println("Data corrupted!!!!");
+ }
+ }
+
+ Note: this class does not introduce buffering - if you are processing large files you should create
+ the parser with:
+ + CMSAuthenticatedDataParser ep = new CMSAuthenticatedDataParser(new BufferedInputStream(inputStream, bufSize)); ++ where bufSize is a suitably large buffer size. + +
+ A simple example of usage. +
+ CMSAuthenticatedDataStreamGenerator edGen = new CMSAuthenticatedDataStreamGenerator(); + + edGen.addKeyTransRecipient(cert); + + ByteArrayOutputStream bOut = new ByteArrayOutputStream(); + + OutputStream out = edGen.open( + bOut, CMSAuthenticatedDataGenerator.AES128_CBC, "BC");* + out.write(data); + + out.close(); ++ +
+ * A simple example of usage.
+ *+ *
+ * CMSCompressedDataGenerator fact = new CMSCompressedDataGenerator(); + * CMSCompressedData data = fact.Generate(content, algorithm); + *+ * +
+ CMSCompressedDataParser cp = new CMSCompressedDataParser(inputStream); + + process(cp.GetContent().GetContentStream()); ++ Note: this class does not introduce buffering - if you are processing large files you should create + the parser with: +
+ CMSCompressedDataParser ep = new CMSCompressedDataParser(new BufferedInputStream(inputStream, bufSize)); ++ where bufSize is a suitably large buffer size. +
+ A simple example of usage. +
++ CMSCompressedDataStreamGenerator gen = new CMSCompressedDataStreamGenerator(); + + Stream cOut = gen.Open(outputStream, CMSCompressedDataStreamGenerator.ZLIB); + + cOut.Write(data); + + cOut.Close(); ++
+ CmsEnvelopedDataGenerator fact = new CmsEnvelopedDataGenerator(); + + fact.AddKeyTransRecipient(cert); + + CmsEnvelopedData data = fact.Generate(content, algorithm); ++
+ Note: that because we are in a streaming mode only one recipient can be tried and it is important + that the methods on the parser are called in the appropriate order. +
++ Example of use - assuming the first recipient matches the private key we have. +
+ CmsEnvelopedDataParser ep = new CmsEnvelopedDataParser(inputStream);
+
+ RecipientInformationStore recipients = ep.GetRecipientInfos();
+
+ Collection c = recipients.getRecipients();
+ Iterator it = c.iterator();
+
+ if (it.hasNext())
+ {
+ RecipientInformation recipient = (RecipientInformation)it.next();
+
+ CMSTypedStream recData = recipient.getContentStream(privateKey);
+
+ processDataStream(recData.getContentStream());
+ }
+
+ Note: this class does not introduce buffering - if you are processing large files you should create
+ the parser with:
+ + CmsEnvelopedDataParser ep = new CmsEnvelopedDataParser(new BufferedInputStream(inputStream, bufSize)); ++ where bufSize is a suitably large buffer size. + +
+ A simple example of usage. +
+ CmsEnvelopedDataStreamGenerator edGen = new CmsEnvelopedDataStreamGenerator(); + + edGen.AddKeyTransRecipient(cert); + + MemoryStream bOut = new MemoryStream(); + + Stream out = edGen.Open( + bOut, CMSEnvelopedDataGenerator.AES128_CBC);* + out.Write(data); + + out.Close(); ++ +
+ CMSEnvelopedDataGenerator fact = new CMSEnvelopedDataGenerator(); + + fact.addKeyTransRecipient(cert); + + CMSEnvelopedData data = fact.generate(content, algorithm, "BC"); ++
+ IX509Store certs = s.GetCertificates();
+ SignerInformationStore signers = s.GetSignerInfos();
+
+ foreach (SignerInformation signer in signers.GetSigners())
+ {
+ ArrayList certList = new ArrayList(certs.GetMatches(signer.SignerID));
+ X509Certificate cert = (X509Certificate) certList[0];
+
+ if (signer.Verify(cert.GetPublicKey()))
+ {
+ verified++;
+ }
+ }
+
+ + * A simple example of usage. + * + *
+ * IX509Store certs... + * IX509Store crls... + * CmsSignedDataGenerator gen = new CmsSignedDataGenerator(); + * + * gen.AddSigner(privKey, cert, CmsSignedGenerator.DigestSha1); + * gen.AddCertificates(certs); + * gen.AddCrls(crls); + * + * CmsSignedData data = gen.Generate(content); + *+ * +
+ Note: that because we are in a streaming mode only one signer can be tried and it is important + that the methods on the parser are called in the appropriate order. +
++ A simple example of usage for an encapsulated signature. +
++ Two notes: first, in the example below the validity of + the certificate isn't verified, just the fact that one of the certs + matches the given signer, and, second, because we are in a streaming + mode the order of the operations is important. +
+
+ CmsSignedDataParser sp = new CmsSignedDataParser(encapSigData);
+
+ sp.GetSignedContent().Drain();
+
+ IX509Store certs = sp.GetCertificates();
+ SignerInformationStore signers = sp.GetSignerInfos();
+
+ foreach (SignerInformation signer in signers.GetSigners())
+ {
+ ArrayList certList = new ArrayList(certs.GetMatches(signer.SignerID));
+ X509Certificate cert = (X509Certificate) certList[0];
+
+ Console.WriteLine("verify returns: " + signer.Verify(cert));
+ }
+
+ Note also: this class does not introduce buffering - if you are processing large files you should create
+ the parser with:
+ + CmsSignedDataParser ep = new CmsSignedDataParser(new BufferedInputStream(encapSigData, bufSize)); ++ where bufSize is a suitably large buffer size. +
+ The output stream is returned unclosed. +
+ @param original the signed data stream to be used as a base. + @param signerInformationStore the new signer information store to use. + @param out the stream to Write the new signed data object to. + @return out. ++ The output stream is returned unclosed. +
+ @param original the signed data stream to be used as a base. + @param certsAndCrls the new certificates and CRLs to be used. + @param out the stream to Write the new signed data object to. + @return out. + @exception CmsException if there is an error processing the CertStore ++ A simple example of usage. +
+
+ IX509Store certs...
+ CmsSignedDataStreamGenerator gen = new CmsSignedDataStreamGenerator();
+
+ gen.AddSigner(privateKey, cert, CmsSignedDataStreamGenerator.DIGEST_SHA1);
+
+ gen.AddCertificates(certs);
+
+ Stream sigOut = gen.Open(bOut);
+
+ sigOut.Write(Encoding.UTF8.GetBytes("Hello World!"));
+
+ sigOut.Close();
+
+ + note: This uses MTI/A0 key agreement in order to make the key agreement + secure against passive attacks. If you're doing Diffie-Hellman and both + parties have long term public keys you should look at using this. For + further information have a look at RFC 2631.
++ It's possible to extend this to more than two parties as well, for the moment + that is left as an exercise for the reader.
++ 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.
++ 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!).
++ 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. +
++ NOTE: This algorithm is only included for backwards compatibility + with legacy applications, it's not secure, don't use it for anything new!
+Implementation of RipeMD256.
+Note: this algorithm offers the same level of security as RipeMD128.
+Implementation of RipeMD 320.
+Note: this algorithm offers the same level of security as RipeMD160.
++ 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 ++
+ block word digest + SHA-1 512 32 160 + SHA-256 512 32 256 + SHA-384 1024 64 384 + SHA-512 1024 64 512 ++
+ block word digest + SHA-1 512 32 160 + SHA-256 512 32 256 + SHA-384 1024 64 384 + SHA-512 1024 64 512 ++
+ block word digest + SHA-1 512 32 160 + SHA-256 512 32 256 + SHA-384 1024 64 384 + SHA-512 1024 64 512 ++
null to use no parameters.
+ null to use no parameters.
+ + The static property is checked during construction of the encoding object, it is set to + true by default. +
++ 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. +
++ 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 fast version with 8Kbytes of static tables for round precomputation +
++ 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 slowest performance version with no static tables + for round precomputation, but it has the smallest foot print. +
++ * Note: + *
+ http://www.ecrypt.eu.org/stream/p3ciphers/hc/hc128_p3.pdf +
+ It is a third phase candidate in the eStream contest, and is patent-free. + No attacks are known as of today (April 2007). See + + http://www.ecrypt.eu.org/stream/hcp3.html +
++ http://www.ecrypt.eu.org/stream/p3ciphers/hc/hc256_p3.pdf +
+ Its brother, HC-128, is a third phase candidate in the eStream contest. + The algorithm is patent-free. No attacks are known as of today (April 2007). + See + + http://www.ecrypt.eu.org/stream/hcp3.html +
++ This implementation is based on the "HOWTO: INTERNATIONAL DATA ENCRYPTION ALGORITHM" + implementation summary by Fauzan Mirza (F.U.Mirza@sheffield.ac.uk). (barring 1 typo at the + end of the MulInv function!). +
++ It can be found at ftp://ftp.funet.fi/pub/crypt/cryptography/symmetric/idea/ +
++ Note: This algorithm was patented in the USA, Japan and Europe. These patents expired in 2011/2012. +
++ i.e. x * MulInv(x) == 1 (modulo BASE) +
++ i.e. x + AddInv(x) == 0 +
+RC5 Encryption Algorithm
+ publication in RSA CryptoBytes, Spring of 1995.
+ http://www.rsasecurity.com/rsalabs/cryptobytes.
+ + This implementation has a word size of 32 bits.
+RC5 Encryption Algorithm
+ publication in RSA CryptoBytes, Spring of 1995.
+ http://www.rsasecurity.com/rsalabs/cryptobytes.
+ + This implementation is set to work with a 64 bit word size.
++ Note: this implementation is based on information prior to readonly NIST publication. +
++ * 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 + *
+null to use the current key.
+ the 2 word (128 bit) tweak, or null to use the current tweak.
+ + Tnepres is based on Serpent which was designed by Ross Anderson, Eli Biham and Lars Knudsen as a + candidate algorithm for the NIST AES Quest. Unfortunately there was an endianness issue + with test vectors in the AES submission and the resulting confusion lead to the Tnepres cipher + as well, which is a byte swapped version of Serpent. +
++ For full details see The Serpent home page +
++ *
+ * G(x) = x^4 + (a+1/a)x^3 + ax^2 + (a+1/a)x + 1 + *+ * where a = primitive root of field generator 0x14D + * +
+ This implementation does not correspondent to the 1999 published paper + "A Future-Adaptable Password Scheme" of Niels Provos and David Mazières, + see: https://www.usenix.org/legacy/events/usenix99/provos/provos_html/node1.html. + In contrast to the paper, the order of key setup and salt setup is reversed: + state <- ExpandKey(state, 0, key) + state %lt;- ExpandKey(state, 0, salt) + This corresponds to the OpenBSD reference implementation of Bcrypt. +
+ Note: + There is no successful cryptanalysis (status 2015), but + the amount of memory and the band width of Bcrypt + may be insufficient to effectively prevent attacks + with custom hardware like FPGAs, ASICs +
+ This implementation uses some parts of Bouncy Castle's BlowfishEngine. +
++ This implements the raw bcrypt function as defined in the bcrypt specification, not + the crypt encoded version implemented in OpenBSD. +
+ @param password the password bytes (up to 72 bytes) to use for this invocation. + @param salt the 128 bit salt to use for this invocation. + @param cost the bcrypt cost parameter. The cost of the bcrypt function grows as +2^cost. Legal values are 4..31 inclusive.
+ @return the output of the raw bcrypt operation: a 192 bit (24 byte) hash.
+ + Note: can take a while...
++ This Generates keys consistent for use with ElGamal as described in + page 164 of "Handbook of Applied Cryptography".
++ * Note: can take a while... + *
++ The scheme is a simple extension of PKCS 5 V2.0 Scheme 1 using MD5 with an + iteration count of 1. +
++ The document this implementation is based on can be found at + + RSA's Pkcs12 Page +
++ The document this implementation is based on can be found at + + RSA's Pkcs5 Page +
++ The document this implementation is based on can be found at + + RSA's Pkcs5 Page
+k[0] ... k[15], r[0] ... r[15] with the required bits in r cleared
+ as per r (second 16 bytes) portion of the key.k[0] ... k[15], r[0] ... r[15]
+ k[0] ... k[15], r[0] ... r[15] with the required bits in r cleared
+ as per r portion of the key.2^(128 * r / 8).
+ the block size, must be >= 1.
+ Parallelization parameter. Must be a positive integer less than or equal to
+ Int32.MaxValue / (128 * r * 8).
+ the length of the key to generate.
+ + 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. ++ 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. ++ 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. ++ 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 cfbBitSize the size of an output block produced by the CFB mode. + @param macSizeInBits the size of the MAC in bits, must be a multiple of 8. ++ 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 cfbBitSize the size of an output block produced by the CFB mode. + @param macSizeInBits the size of the MAC in bits, must be a multiple of 8. + @param padding a padding to be used. ++ 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. +
++ 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. ++ 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. +null to use no parameters.
+ + Note: this mode is a packet mode - it needs all the data up front. +
++License for + Open-Source Software Implementations of OCB (Jan 9, 2013) - 'License 1'
+ Under this license, you are authorized to make, use, and distribute open-source software + implementations of OCB. This license terminates for you if you sue someone over their open-source + software implementation of OCB claiming that you have a patent covering their implementation. ++ This is a non-binding summary of a legal document (the link above). The parameters of the license + are specified in the license document and that document is controlling.
+ * For further info see RFC 2440. + *
++ This padding pads the block out compliment of the last bit + of the plain text. +
++ Note: this assumes that the last block of plain text is always + passed to it inside in. i.e. if inOff is zero, indicating the + entire block is to be overwritten with padding the value of in + should be the same as the last block of plain text. +
++ See "Applied + Cryptography" by Bruce Schneier for more information. +
+ @return true if the given DES key material is weak or semi-weak, + false otherwise. +null if not
+ set.
+ null if not set.
+ null if not set.
+ null if not set.
+ null if
+ not set.
+ YYYYMMDD email@address distinguisher, encoded to a byte
+ sequence using UTF-8 encoding.
+ null to use the current key.null to use the current tweak.+ Internal access to the digest is synchronized so a single one of these can be shared. +
++ 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). ++ 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). ++ 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). ++ Access to internals is synchronized so a single one of these can be shared. +
++ 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. +
++ Any SecureRandom created from a builder constructed like this will make use of input passed to SecureRandom.setSeed() if + the passed in SecureRandom does for its generateSeed() call. +
+ @param entropySource + @param predictionResistant ++ Note: If this constructor is used any calls to setSeed() in the resulting SecureRandom will be ignored. +
+ @param entropySourceProvider a provider of EntropySource objects. ++ Based on an idea from Marcus Lippert. +
++ If fast is set to true, the code should be round about 8 times faster when + generating a long sequence of random bytes. 20 bytes of random values using + the fast mode take less than half a second on a Nokia e70. If fast is set to false, + it takes round about 2500 ms. +
+ @param numBytes the number of bytes to generate + @param fast true if fast mode should be used +
+ // First 1850 fractional digit of Pi number.
+ byte[] key = new BigInteger("14159265358979323846...5068006422512520511").ToByteArray();
+ s = 0;
+ P = new byte[256];
+ for (int i = 0; i < 256; i++)
+ {
+ P[i] = (byte) i;
+ }
+ for (int m = 0; m < 768; m++)
+ {
+ s = P[(s + P[m & 0xff] + key[m % key.length]) & 0xff];
+ byte temp = P[m & 0xff];
+ P[m & 0xff] = P[s & 0xff];
+ P[s & 0xff] = temp;
+ }
+ + 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. +
++ Any SecureRandom created from a builder constructed like this will make use of input passed to SecureRandom.setSeed() if + the passed in SecureRandom does for its generateSeed() call. +
+ @param entropySource + @param predictionResistant ++ Note: If this constructor is used any calls to setSeed() in the resulting SecureRandom will be ignored. +
+ @param entropySourceProvider a provider of EntropySource objects. ++ Note: the usual length for the salt is the length of the hash + function used in bytes.
++ Note: the usual value for the salt length is the number of + bytes in the hash function.
++ 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. +
+ This file could be more optimized. +
+
+ opaque ASN.1Cert<2^24-1>;
+
+ struct {
+ ASN.1Cert certificate_list<0..2^24-1>;
+ } Certificate;
+
+
+ @see Org.BouncyCastle.Asn1.X509.X509CertificateStructure
+ true if this certificate chain contains no certificates, or
+ false otherwise.
+
+ struct {
+ ClientCertificateType certificate_types<1..2^8-1>;
+ DistinguishedName certificate_authorities<3..2^16-1>
+ } CertificateRequest;
+
+
+ @see ClientCertificateType
+ @see X509Name
+ close_notify warning alert.
+ true if the handshake should be aborted when the peer does not negotiate the
+ extended_master_secret extension, or false to support legacy interoperability.
+ true if the current time should be used in the gmt_unix_time field of
+ Random, or false if gmt_unix_time should contain a cryptographically
+ random value.
+ OfferInput(input, 0, input.length)
+ @see TlsProtocol#OfferInput(byte[], int, int)
+ @param input The input buffer to offer
+ @throws IOException If an error occurs while decrypting or processing a record
+ From Knuth Vol 2, pg 395.
+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.
+ 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.
+ SimpleBigDecimal. The value of the
+ constructed SimpleBigDecimal Equals bigInt /
+ 2scale.
+ @param bigInt The bigInt value parameter.
+ @param scale The scale of the constructed SimpleBigDecimal.
+ α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
+ αu's for a=0 as an array
+ of ZTauElements.
+ αu's for a=0 as an array
+ of TNAFs.
+ αu's for a=1 as an array
+ of ZTauElements.
+ αu's for a=1 as an array
+ of TNAFs.
+ λ of
+ Z[τ].
+ @param mu The parameter μ of the elliptic curve.
+ @param lambda The element λ of
+ Z[τ].
+ @return The norm of λ.
+ λ 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 λ.
+ λ 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.
+ 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.
+ τ-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 λ.
+ τ() to an
+ AbstractF2mPoint.
+ @param p The AbstractF2mPoint to which τ() is applied.
+ @return τ(p)
+ μ 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.
+ 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.
+ 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
+ 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).
+ (τ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)
+ 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
+ λ of Z[τ]
+ using the τ-adic NAF (TNAF) method.
+ @param p The AbstractF2mPoint to Multiply.
+ @param lambda The element λ of
+ Z[τ].
+ @return λ * p
+ λ 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
+ [τ]-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
+ λ.
+ ECPoint for which to do the precomputation.
+ @param a The parameter a of the elliptic curve.
+ @return The precomputation array for p.
+ 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.
+ λ.
+ τ-adic" part of λ.
+ λ of
+ Z[τ].
+ @param u The "real" part of λ.
+ @param v The "τ-adic" part of
+ λ.
+ kP.
+ 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.
+ ECCurve instance, and MUST already be normalized.
+ ECMultiplier, unless already set.
+
+ We avoid locking for performance reasons, so there is no uniqueness guarantee.
+ Fp (X9.62 s 4.2.1 pg 17).
+ @return The decoded point.
+ s0 and
+ s1 used for partial modular reduction for
+ Koblitz curves.
+ 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.
+ s0 and
+ s1 used for partial modular reduction for
+ Koblitz curves.
+ y2 + xy = x3 + ax2 + b.
+ m of F2m.
+ k where xm +
+ xk + 1 represents the reduction polynomial
+ f(z).k1 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).0k2 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).0k3 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).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.
+ 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.
+ 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.
+ 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.
+ 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.
+ m of F2m.
+ LongArray holding the bits.
+ 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.
+ 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.
+ 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).
+ F2m, either of
+ {@link F2mFieldElement.Tpb} (trinomial
+ basis representation) or
+ {@link F2mFieldElement.Ppb} (pentanomial
+ basis representation).
+ m of the reduction polynomial
+ f(z).
+ k where xm +
+ xk + 1 represents the reduction polynomial
+ f(z).k1 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).0k2 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).0k3 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).ECPoint by the given number.
+ @param k The multiplicator.
+ @return k * this.
+ ECPoints.
+ 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.
+ ECPoints used for a fixed point multiplication.
+ WNafMultiplier.
+ 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.
+ ECPoints used for a Window
+ NAF multiplication.
+ ECPoints used
+ for a Window NAF multiplication.
+ ECPoint representing Twice(this). Used for the
+ Window NAF multiplication to create or extend the precomputed values.
+ 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[].
+ τ-adic Non-Adjacent Form) algorithm.
+ 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.
+ λ 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 λ.
+ λ 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
+ τ-adic Non-Adjacent Form) algorithm.
+ AbstractF2mPoints used for the
+ WTNAF multiplication in
+ {@link org.bouncycastle.math.ec.multiplier.WTauNafMultiplier.multiply()
+ WTauNafMultiplier.multiply()}.
+ true if the candidate is found to have any small factors,
+ false otherwise.
+ 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).
+ false if the specified base is a witness to compositeness (so
+ candidate is definitely NOT prime), or else true.
+
+ BasicOcspResponse ::= SEQUENCE {
+ tbsResponseData ResponseData,
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING,
+ certs [0] EXPLICIT SEQUENCE OF Certificate OPTIONAL
+ }
+
+
+ OcspRequest ::= SEQUENCE {
+ tbsRequest TBSRequest,
+ optionalSignature [0] EXPLICIT Signature OPTIONAL }
+
+ TBSRequest ::= SEQUENCE {
+ version [0] EXPLICIT Version DEFAULT v1,
+ requestorName [1] EXPLICIT GeneralName OPTIONAL,
+ requestList SEQUENCE OF Request,
+ requestExtensions [2] EXPLICIT Extensions OPTIONAL }
+
+ Signature ::= SEQUENCE {
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING,
+ certs [0] EXPLICIT SEQUENCE OF Certificate OPTIONAL}
+
+ Version ::= INTEGER { v1(0) }
+
+ Request ::= SEQUENCE {
+ reqCert CertID,
+ singleRequestExtensions [0] EXPLICIT Extensions OPTIONAL }
+
+ CertID ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ issuerNameHash OCTET STRING, -- Hash of Issuer's DN
+ issuerKeyHash OCTET STRING, -- Hash of Issuers public key
+ serialNumber CertificateSerialNumber }
+
+ + In the case of PKCS7 objects the reader will return a CMS ContentInfo object. Keys and + Certificates will be returned using the appropriate java.security type.
+
+ CertificationRequest ::= Sequence {
+ certificationRequestInfo CertificationRequestInfo,
+ signatureAlgorithm AlgorithmIdentifier{{ SignatureAlgorithms }},
+ signature BIT STRING
+ }
+
+ 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})
+ }
+
+ see
+
+ CertificationRequest ::= Sequence {
+ certificationRequestInfo CertificationRequestInfo,
+ signatureAlgorithm AlgorithmIdentifier{{ SignatureAlgorithms }},
+ signature BIT STRING
+ }
+
+ 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})
+ }
+
+ see
+ Set of X.509 attribute certificate
+ extensions that this PkixAttrCertChecker supports or
+ null if no extensions are supported.
+
+ Each element of the set is a String representing the
+ Object Identifier (OID) of the X.509 extension that is supported.
+
+ All X.509 attribute certificate extensions that a
+ PkixAttrCertChecker might possibly be able to process
+ should be included in the set.
+
Set of X.509 extension OIDs (in
+ String format) supported by this
+ PkixAttrCertChecker, or null if no
+ extensions are supported
+ unresolvedCritExts
+ collection.
+
+ @param attrCert The attribute certificate to be checked.
+ @param certPath The certificate path which belongs to the attribute
+ certificate issuer public key certificate.
+ @param holderCertPath The certificate path which belongs to the holder
+ certificate.
+ @param unresolvedCritExts a Collection of OID strings
+ representing the current set of unresolved critical extensions
+ @throws CertPathValidatorException if the specified attribute certificate
+ does not pass the check.
+ PkixAttrCertChecker
+
+ params must be an instance of
+ ExtendedPkixParameters.
+
+ The target constraints in the params must be an
+ X509AttrCertStoreSelector with at least the attribute
+ certificate criterion set. Obey that also target informations may be
+ necessary to correctly validate this attribute certificate.
+
+ The attribute certificate issuer must be added to the trusted attribute + issuers with {@link ExtendedPkixParameters#setTrustedACIssuers(Set)}. +
+ @param certPath The certificate path which belongs to the attribute + certificate issuer public key certificate. + @param params The PKIX parameters. + @return APKIXCertPathValidatorResult of the result of
+ validating the certPath.
+ @throws InvalidAlgorithmParameterException if params is
+ inappropriate for this validator.
+ @throws CertPathValidatorException if the verification fails.
+ PkixBuilderParameters.
+
+ This method can be used to get a copy from other
+ PKIXBuilderParameters, PKIXParameters,
+ and ExtendedPKIXParameters instances.
+
PkixBuilderParameters instance.
+ ISet is null an
+ empty set is assumed.
+ ExtendedPKIXBuilderParameters and
+ PKIXBuilderParameters.
+
+ @param params Parameters to set.
+ @see org.bouncycastle.x509.ExtendedPKIXParameters#setParams(java.security.cert.PKIXParameters)
+ PKIXParameters object. Changes to the
+ copy will not affect the original and vice versa.
+
+ @return a copy of this PKIXParameters object
+ PKIXCertPathChecker.
+ *
+ * The forward flag specifies the order that certificates
+ * will be passed to the {@link #check check} method (forward or reverse). A
+ * PKIXCertPathChecker must support reverse checking
+ * and may support forward checking.
+ *
check method. If true,
+ * certificates are presented from target to most-trusted CA
+ * (forward); if false, from most-trusted CA to
+ * target (reverse).
+ * @exception CertPathValidatorException
+ * if this PKIXCertPathChecker is unable to
+ * check certificates in the specified order; it should never
+ * be thrown if the forward flag is false since reverse
+ * checking must be supported
+ PKIXCertPathChecker to perform its
+ checks when certificates are presented to the check method
+ in the forward direction (from target to most-trusted CA).
+
+ @return true if forward checking is supported,
+ false otherwise
+ Set of X.509 certificate extensions
+ * that this PKIXCertPathChecker supports (i.e. recognizes,
+ * is able to process), or null if no extensions are
+ * supported.
+ *
+ * Each element of the set is a String representing the
+ * Object Identifier (OID) of the X.509 extension that is supported. The OID
+ * is represented by a set of nonnegative integers separated by periods.
+ *
+ * All X.509 certificate extensions that a PKIXCertPathChecker
+ * might possibly be able to process should be included in the set.
+ *
Set of X.509 extension OIDs (in
+ * String format) supported by this
+ * PKIXCertPathChecker, or null if no
+ * extensions are supported
+ init method.
+
+ @param cert
+ the Certificate to be checked
+ @param unresolvedCritExts
+ a Collection of OID strings representing the
+ current set of unresolved critical extensions
+ @exception CertPathValidatorException
+ if the specified certificate does not pass the check
+ Object.clone()
+ method. All subclasses which maintain state must support and override
+ this method, if necessary.
+
+ @return a copy of this PKIXCertPathChecker
+ CertPathValidator implementations must include a class (the
+ SPI class) that extends this class (CertPathValidatorSpi)
+ and implements all of its methods. In general, instances of this class
+ should only be accessed through the CertPathValidator class.
+ For details, see the Java Cryptography Architecture.CertPathValidatorSpi instance concurrently should synchronize
+ amongst themselves and provide the necessary locking before calling the
+ wrapping CertPathValidator object.CertPathValidatorSpi may still
+ encounter concurrency issues, since multiple threads each
+ manipulating a different CertPathValidatorSpi instance need not
+ synchronize.
+ CertPathValidatorException provides support for wrapping
+ exceptions. The {@link #getCause getCause} method returns the throwable,
+ if any, that caused this exception to be thrown. CertPathValidatorException may also include the
+ certification path that was being validated when the exception was thrown
+ and the index of the certificate in the certification path that caused the
+ exception to be thrown. Use the {@link #getCertPath getCertPath} and
+ {@link #getIndex getIndex} methods to retrieve this information.PkixCertPathValidatorException with the given detail
+ message. A detail message is a String that describes this
+ particular exception.
+ PkixCertPathValidatorException with the specified
+ detail message and cause.
+ null
+ value is permitted, and indicates that the cause is
+ nonexistent or unknown.)
+ PkixCertPathValidatorException with the specified
+ detail message, cause, certification path, and index.
+ null if none)
+ the cause (or null if none)
+ the certification path that was in the process of being
+ validated when the error was encountered
+ the index of the certificate in the certification path that *
+ CertPathValidatorException.
+ null if neither the message nor cause were specifiedCertPath that was being validated when the
+ exception was thrown (or null if not specified)
+ CertPath is zero based. If no index has been set, -1 is
+ returned.
+
+ @return the index that has been set, or -1 if none has been set
+ TrustAnchor object if found or
+ null if not.
+ X500Principal.
+ This methods inherits DSA parameters from the indexed certificate or
+ previous certificates in the certificate chain to the returned
+ PublicKey. The list is searched upwards, meaning the end
+ certificate is at position 0 and previous certificates are following.
+
+ If the indexed certificate does not contain a DSA key this method simply + returns the public key. If the DSA key already contains DSA parameters + the key is also only returned. +
+ + @param certs The certification path. + @param index The index of the certificate which contains the public key + which should be extended with DSA parameters. + @return The public key of the certificate in list position +index extended with DSA parameters if applicable.
+ @throws Exception if DSA parameters cannot be inherited.
+ null.selector.
+
+ The issuerPrincipals are a collection with a single
+ X500Principal for X509Certificates. For
+ {@link X509AttributeCertificate}s the issuer may contain more than one
+ X500Principal.
+
issuerPrincipals does not
+ contain only X500Principals.
+ X509Certificate or
+ {@link org.bouncycastle.x509.X509AttributeCertificate} for
+ which the CRL should be searched.
+ @param currentDate The date for which the delta CRLs must be valid.
+ @param paramsPKIX The extended PKIX parameters.
+ @return A Set of X509CRLs with complete
+ CRLs.
+ @throws Exception if an exception occurs while picking the CRLs
+ or no CRLs are found.
+ Set of X509CRLs with delta CRLs.
+ @throws Exception if an exception occurs while picking the delta
+ CRLs.
+ Collection object containing the issuer
+ X509Certificates. Never null.
+
+ @exception Exception
+ if an error occurs.
+ null.
+ permitted with ip.
+
+ @param permitted A Set of permitted IP addresses with
+ their subnet mask as byte arrays.
+ @param ips The IP address with its subnet mask.
+ @return The Set of permitted IP ranges intersected with
+ ip.
+ excluded
+ with ip.
+
+ @param excluded A Set of excluded IP addresses with their
+ subnet mask as byte arrays.
+ @param ip The IP address with its subnet mask.
+ @return The Set of excluded IP ranges unified with
+ ip as byte arrays.
+ Set with the union of both addresses.
+ Set with the single IP address with its subnet
+ mask as a byte array or an empty Set.
+ ip is constrained by
+ constraint.
+
+ @param constraint The constraint. This is an IP address concatenated with
+ its subnetmask.
+ @param ip The IP address.
+ @return true if constrained, false
+ otherwise.
+ ip is included in the permitted ISet
+ permitted.
+
+ @param permitted A Set of permitted IP addresses with
+ their subnet mask as byte arrays.
+ @param ip The IP address.
+ @throws PkixNameConstraintValidatorException
+ if the IP is not permitted.
+ ip is included in the excluded ISet
+ excluded.
+
+ @param excluded A Set of excluded IP addresses with their
+ subnet mask as byte arrays.
+ @param ip The IP address.
+ @throws PkixNameConstraintValidatorException
+ if the IP is excluded.
+ email1 and email2 is
+ added to the union union. If email1 and
+ email2 have nothing in common they are added both.
+
+ @param email1 Email address constraint 1.
+ @param email2 Email address constraint 2.
+ @param union The union.
+ email1 and
+ email2 is added to the intersection intersect.
+
+ @param email1 Email address constraint 1.
+ @param email2 Email address constraint 2.
+ @param intersect The intersection.
+ name
+ name is
+ excluded.
+ ip1 with ip2. If ip1
+ is equal to ip2 0 is returned. If ip1 is bigger 1 is returned, -1
+ otherwise.
+
+ @param ip1 The first IP address.
+ @param ip2 The second IP address.
+ @return 0 if ip1 is equal to ip2, 1 if ip1 is bigger, -1 otherwise.
+ ip1 and
+ ip2.
+
+ @param ip1 The first IP address.
+ @param ip2 The second IP address.
+ @return The OR of ip1 and ip2.
+ (trustAnchors.isEmpty() == true)
+ @exception NullPointerException
+ if the specified Set is null
+ @exception ClassCastException
+ if any of the elements in the Set are not of type
+ java.security.cert.TrustAnchor
+ null, no constraints are defined.null)
+
+ @see #setTargetCertConstraints(CertSelector)
+ null)
+
+ @see #getTargetCertConstraints()
+ Set, which is
+ interpreted as meaning that any policy would be acceptable.
+
+ @return an immutable Set of initial policy OIDs in String
+ format, or an empty Set (implying any policy is
+ acceptable). Never returns null.
+
+ @see #setInitialPolicies(java.util.Set)
+ Set of initial policy identifiers (OID strings),
+ indicating that any one of these policies would be acceptable to the
+ certificate user for the purposes of certification path processing. By
+ default, any policy is acceptable (i.e. all policies), so a user that
+ wants to allow any policy as acceptable does not need to call this
+ method, or can call it with an empty Set (or
+ null).null)
+
+ @exception ClassCastException
+ if any of the elements in the set are not of type String
+
+ @see #getInitialPolicies()
+ List of additional certification path checkers. If
+ the specified List contains an object that is not a PKIXCertPathChecker,
+ it is ignored.PKIXCertPathChecker specified implements additional
+ checks on a certificate. Typically, these are checks to process and
+ verify private extensions contained in certificates. Each
+ PKIXCertPathChecker should be instantiated with any
+ initialization parameters needed to execute the check.CertPathValidator or CertPathBuilder. Each
+ of the specified PKIXCertPathCheckers will be called, in turn, by a PKIX
+ CertPathValidator or CertPathBuilder for
+ each certificate processed or validated.CertPathValidator or CertPathBuilder
+ must perform all of the required PKIX checks on each certificate. The one
+ exception to this rule is if the RevocationEnabled flag is set to false
+ (see the {@link #setRevocationEnabled(boolean) setRevocationEnabled}
+ method).java.security.cert.PKIXCertPathChecker
+ @see #getCertPathCheckers()
+ null)
+
+ @see #setCertPathCheckers(java.util.List)
+ PKIXCertPathChecker to the list of certification
+ path checkers. See the {@link #setCertPathCheckers setCertPathCheckers}
+ method for more details.
+
+ Note that the PKIXCertPathChecker is cloned to protect
+ against subsequent modifications.
PKIXCertPathChecker to add to the list of
+ checks. If null, the checker is ignored (not added to list).
+ Clone() under J2ME.
+ super.Clone() does not exist and fields are not copied.
+
+ @param params Parameters to set. If this are
+ ExtendedPkixParameters they are copied to.
+ false.
+
+ The IList is cloned.
+
stores is not
+ a {@link Store}.
+ + This method should be used to add local stores, like collection based + X.509 stores, if available. Local stores should be considered first, + before trying to use additional (remote) locations, because they do not + need possible additional network traffic. +
+ If store is null it is ignored.
+
+ You should not use this method. This method is used for adding additional + X.509 stores, which are used to add (remote) locations, e.g. LDAP, found + during X.509 object processing, e.g. in certificates or CRLs. This method + is used in PKIX certification path processing. +
+ If store is null it is ignored.
+
IList of additional Bouncy Castle
+ Stores used for finding CRLs, certificates, attribute
+ certificates or cross certificates.
+
+ @return an immutable IList of additional Bouncy Castle
+ Stores. Never null.
+
+ @see #addAddionalStore(Store)
+ IList of Bouncy Castle
+ Stores used for finding CRLs, certificates, attribute
+ certificates or cross certificates.
+
+ @return an immutable IList of Bouncy Castle
+ Stores. Never null.
+
+ @see #setStores(IList)
+ true if additional stores are used.
+ true if additional stores are used.
+ IX509Selector. If null, no constraints are
+ defined.
+
+ + The target certificate in a PKIX path may be a certificate or an + attribute certificate. +
+ Note that the IX509Selector returned is cloned to protect
+ against subsequent modifications.
+
IX509Selector specifying the constraints on the
+ target certificate or attribute certificate (or null)
+ @see #setTargetConstraints
+ @see X509CertStoreSelector
+ @see X509AttributeCertStoreSelector
+ IX509Selector. If null, no constraints are
+ defined.
+ + The target certificate in a PKIX path may be a certificate or an + attribute certificate. +
+ Note that the IX509Selector specified is cloned to protect
+ against subsequent modifications.
+
IX509Selector specifying the constraints on
+ the target certificate or attribute certificate (or
+ null)
+ @see #getTargetConstraints
+ @see X509CertStoreSelector
+ @see X509AttributeCertStoreSelector
+
+ The returned ISet consists of TrustAnchors.
+
+ The returned ISet is immutable. Never null
+
+ The trustedACIssuers must be a ISet of
+ TrustAnchor
+
+ The given set is cloned. +
+ + @param trustedACIssuers The trusted AC issuers to set. Is never +null.
+ @throws ClassCastException if an element of stores is not
+ a TrustAnchor.
+
+ The returned ISet is immutable and contains
+ Strings with the OIDs.
+
+ The ISet must contain Strings with the
+ OIDs.
+
+ The set is cloned. +
+ + @param necessaryACAttributes The necessary AC attributes to set. + @throws ClassCastException if an element of +necessaryACAttributes is not a
+ String.
+
+ The returned ISet is immutable and contains
+ Strings with the OIDs.
+
null.
+
+ The ISet must contain Strings with the
+ OIDs.
+
+ The set is cloned. +
+ + @param prohibitedACAttributes The prohibited AC attributes to set. + @throws ClassCastException if an element of +prohibitedACAttributes is not a
+ String.
+ null.
+
+ All elements in the ISet must a {@link PKIXAttrCertChecker}.
+
+ The given set is cloned. +
+ + @param attrCertCheckers The attribute certificate checkers to set. Is + nevernull.
+ @throws ClassCastException if an element of attrCertCheckers
+ is not a PKIXAttrCertChecker.
+ true if this reasons mask contains all possible
+ reasons.
+ + (i) If the distribution point name is present in the IDP CRL extension + and the distribution field is present in the DP, then verify that one of + the names in the IDP matches one of the names in the DP. If the + distribution point name is present in the IDP CRL extension and the + distribution field is omitted from the DP, then verify that one of the + names in the IDP matches one of the names in the cRLIssuer field of the + DP. +
++ (ii) If the onlyContainsUserCerts boolean is asserted in the IDP CRL + extension, verify that the certificate does not include the basic + constraints extension with the cA boolean asserted. +
++ (iii) If the onlyContainsCACerts boolean is asserted in the IDP CRL + extension, verify that the certificate includes the basic constraints + extension with the cA boolean asserted. +
++ (iv) Verify that the onlyContainsAttributeCerts boolean is not asserted. +
+ + @param dp The distribution point. + @param cert The certificate. + @param crl The CRL. + @throws AnnotatedException if one of the conditions is not met or an error occurs. +cert.
+ @throws AnnotatedException if one of the above conditions does not apply or an error
+ occurs.
+ cert.
+ @param cert The attribute certificate or certificate to check if it is
+ revoked.
+ @param defaultCRLSignCert The issuer certificate of the certificate cert.
+ @param defaultCRLSignKey The public key of the issuer certificate
+ defaultCRLSignCert.
+ @param paramsPKIX paramsPKIX PKIX parameters.
+ @param certPathCerts The certificates on the certification path.
+ @return A Set with all keys of possible CRL issuer
+ certificates.
+ @throws AnnotatedException if the CRL is not valid or the status cannot be checked or
+ some error occurs.
+ cert.
+
+ @param dp The distribution point to consider.
+ @param paramsPKIX PKIX parameters.
+ @param cert Certificate to check if it is revoked.
+ @param validDate The date when the certificate revocation status should be
+ checked.
+ @param defaultCRLSignCert The issuer certificate of the certificate cert.
+ @param defaultCRLSignKey The public key of the issuer certificate
+ defaultCRLSignCert.
+ @param certStatus The current certificate revocation status.
+ @param reasonMask The reasons mask which is already checked.
+ @param certPathCerts The certificates of the certification path.
+ @throws AnnotatedException if the certificate is revoked or the status cannot be checked
+ or some error occurs.
+ cert.
+ @param workingPublicKey The public key of the issuer certificate sign.
+ @param certPathCerts The certificates of the certification path.
+ @throws AnnotatedException if the certificate is revoked or the status cannot be checked
+ or some error occurs.
+ attrCert.
+ @param validDate The date when the certificate revocation status should
+ be checked.
+ @param certPathCerts The certificates of the certification path to be
+ checked.
+
+ @throws CertPathValidatorException if the certificate is revoked or the
+ status cannot be checked or some error occurs.
+ attrCert.
+
+ @param dp The distribution point to consider.
+ @param attrCert The attribute certificate which should be checked.
+ @param paramsPKIX PKIX parameters.
+ @param validDate The date when the certificate revocation status should
+ be checked.
+ @param issuerCert Certificate to check if it is revoked.
+ @param reasonMask The reasons mask which is already checked.
+ @param certPathCerts The certificates of the certification path to be
+ checked.
+ @throws Exception if the certificate is revoked or the status
+ cannot be checked or some error occurs.
+
+ NameConstraints ::= SEQUENCE {
+ permittedSubtrees [0] GeneralSubtrees OPTIONAL,
+ excludedSubtrees [1] GeneralSubtrees OPTIONAL }
+
+ GeneralSubtrees ::= SEQUENCE SIZE (1..MAX) OF GeneralSubtree
+
+ GeneralSubtree ::= SEQUENCE {
+ base GeneralName,
+ minimum [0] BaseDistance DEFAULT 0,
+ maximum [1] BaseDistance OPTIONAL }
+
+ BaseDistance ::= INTEGER (0..MAX)
+
+ 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}
+
+
+ Note that the name constraints byte array supplied is cloned to protect
+ against subsequent modifications.
+ + Name constraints are an optional parameter, and are intended to be used + as additional constraints when validating an X.509 certification path. +
+ The name constraints are specified as a byte array. This byte array + contains the DER encoded form of the name constraints, as they + would appear in the NameConstraints structure defined in RFC 2459 + and X.509. The ASN.1 notation for this structure is supplied in the + documentation for the other constructors. +
+ Note that the name constraints byte array supplied here is cloned to + protect against subsequent modifications. +
+TrustAnchor where the most-trusted
+ CA is specified as a distinguished name and public key. Name constraints
+ are an optional parameter, and are intended to be used as additional
+ constraints when validating an X.509 certification path.
+ TrustAnchor.
+ TrustAnchor+ If genTime is null a timeNotAvailable error response will be returned. + + @param request the request this response is for. + @param serialNumber serial number for the response token. + @param genTime generation time for the response token. + @param provider provider to use for signature calculation. + @return + @throws NoSuchAlgorithmException + @throws NoSuchProviderException + @throws TSPException +
++ To be valid the token must be signed by the passed in certificate and + the certificate must be the one referred to by the SigningCertificate + attribute included in the hashed attributes of the token. The + certificate must also have the ExtendedKeyUsageExtension with only + KeyPurposeID.IdKPTimeStamping and have been valid at the time the + timestamp was created. +
++ A successful call to validate means all the above are true. +
++ If a failure code is associated with the exception it can be retrieved using + the getFailureCode() method.
+buf at which the data is written.
+ @param len
+ the fixed length of data written (possibly padded with leading zeros).
+ + 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. +
++ 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. +
++ The exception extends InvalidCastException to enable users to have a single handling case, + only introducing specific handling of this one if required. +
+
+ 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
+ }
+
+
+ digestedObjectType can be one of the following:
+
otherObjectTypeID must not be empty.This cannot be used if a v1 attribute certificate is used.
+ + @param digestedObjectType The digest object type. + @param digestAlgorithm The algorithm identifier for the hash. + @param otherObjectTypeID The object type ID if +digestedObjectType is
+ otherObjectDigest.
+ @param objectDigest The hash value.
+ +
otherObjectTypeID must not be empty.null if no object
+ digest info is set.
+ null if no object digest info is set.
+ null if no object
+ digest info is set.
+ + Use this in preference to trying to recreate a principal from a string, not all + DNs are what they should be, so it's best to leave them encoded where they + can be.
+Selector like implementation to select
+ attribute certificates from a given set of criteria.
+
+ @see org.bouncycastle.x509.X509AttributeCertificate
+ @see org.bouncycastle.x509.X509Store
+ true if the object matches this selector.X509AttributeCertificate
+ must contain at least one of the specified target names.
+ + Each attribute certificate may contain a target information extension + limiting the servers where this attribute certificate can be used. If + this extension is not present, the attribute certificate is not targeted + and may be accepted by any server. +
+ + @param name The name as a GeneralName (notnull)
+ X509AttributeCertificate
+ must contain at least one of the specified target names.
+ + Each attribute certificate may contain a target information extension + limiting the servers where this attribute certificate can be used. If + this extension is not present, the attribute certificate is not targeted + and may be accepted by any server. +
+ + @param name a byte array containing the name in ASN.1 DER encoded form of a GeneralName + @throws IOException if a parsing error occurs. +null is
+ given any will do.
+ + The collection consists of either GeneralName objects or byte[] arrays representing + DER encoded GeneralName structures. +
+ + @param names A collection of target names. + @throws IOException if a parsing error occurs. + @see #AddTargetName(byte[]) + @see #AddTargetName(GeneralName) +Lists
+ made up of an Integer in the first entry and a DER encoded
+ byte array or a String in the second entry.
+ The returned collection is immutable.
+ + @return The collection of target names + @see #setTargetNames(Collection) +X509AttributeCertificate
+ must contain at least one of the specified target groups.
+ + Each attribute certificate may contain a target information extension + limiting the servers where this attribute certificate can be used. If + this extension is not present, the attribute certificate is not targeted + and may be accepted by any server. +
+ + @param group The group as GeneralName form (notnull)
+ X509AttributeCertificate
+ must contain at least one of the specified target groups.
+ + Each attribute certificate may contain a target information extension + limiting the servers where this attribute certificate can be used. If + this extension is not present, the attribute certificate is not targeted + and may be accepted by any server. +
+ + @param name a byte array containing the group in ASN.1 DER encoded form of a GeneralName + @throws IOException if a parsing error occurs. +null is
+ given any will do.
+
+ The collection consists of GeneralName objects or byte[]
+ representing DER encoded GeneralNames.
+
Lists
+ made up of an Integer in the first entry and a DER encoded
+ byte array or a String in the second entry.
+ The returned collection is immutable.
+ + @return The collection of target groups. + @see #setTargetGroups(Collection) +IX509Selector implementation to select
+ certificate pairs, which are e.g. used for cross certificates. The set of
+ criteria is given from two X509CertStoreSelector objects,
+ each of which, if present, must match the respective component of a pair.
+ X509CertificatePair, this method
+ returns false.
+ X509CertificatePair to be tested.
+ true if the object matches this selector.ISet of DerObjectIdentifier objects.
+ X509Stores.+ The collection is copied. +
+ICollection.ICollection of X509Name objects
+ null is specified, then no such
+ optional information is provided.
+
+ @param attrCert the IX509AttributeCertificate being checked (or
+ null)
+ @see #getAttrCertificateChecking()
+ true only complete CRLs are returned. Defaults to
+ false.
+
+ @return true if only complete CRLs are returned.
+ false.
+
+ @return Returns true if only CRLs with the delta CRL
+ indicator extension are selected.
+ + The issuing distribution point extension is a CRL extension which + identifies the scope and the distribution point of a CRL. The scope + contains among others information about revocation reasons contained in + the CRL. Delta CRLs and complete CRLs must have matching issuing + distribution points.
++ The byte array is cloned to protect against subsequent modifications.
++ You must also enable or disable this criteria with + {@link #setIssuingDistributionPointEnabled(bool)}.
+ + @param issuingDistributionPoint The issuing distribution point to set. + This is the DER encoded OCTET STRING extension value. + @see #getIssuingDistributionPoint() +false.
+ + You may also set the issuing distribution point criteria if not a missing + issuing distribution point should be assumed.
+ + @return Returns if the issuing distribution point check is enabled. +null.
+
+ @return Returns the maximum base CRL number.
+ @see #setMaxBaseCRLNumber(BigInteger)
+ + At the moment this will deal with "-----BEGIN CERTIFICATE-----" to "-----END CERTIFICATE-----" + base 64 encoded certs, as well as the BER binaries of certificates and some classes of PKCS#7 + objects.
+isIndirect
+ is false {@link #getCertificateIssuer()} will always
+ return null, previousCertificateIssuer is
+ ignored. If this isIndirect is specified and this CrlEntry
+ has no certificate issuer CRL entry extension
+ previousCertificateIssuer is returned by
+ {@link #getCertificateIssuer()}.
+
+ @param c
+ TbsCertificateList.CrlEntry object.
+ @param isIndirect
+ true if the corresponding CRL is a indirect
+ CRL.
+ @param previousCertificateIssuer
+ Certificate issuer of the previous CrlEntry.
+
+ 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) }
+
+ getValue. The complete checksum object can also be reset
+ so it can be used again with new data.
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Core;
+ using ICSharpCode.SharpZipLib.GZip;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using (Stream inStream = new GZipInputStream(File.OpenRead(args[0])))
+ using (FileStream outStream = File.Create(Path.GetFileNameWithoutExtension(args[0]))) {
+ byte[] buffer = new byte[4096];
+ StreamUtils.Copy(inStream, outStream, buffer);
+ }
+ }
+ }
+
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.GZip;
+ using ICSharpCode.SharpZipLib.Core;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using (Stream s = new GZipOutputStream(File.Create(args[0] + ".gz")))
+ using (FileStream fs = File.OpenRead(args[0])) {
+ byte[] writeData = new byte[4096];
+ Streamutils.Copy(s, fs, writeData);
+ }
+ }
+ }
+ }
+
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Core;
+ using ICSharpCode.SharpZipLib.LZW;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using (Stream inStream = new LzwInputStream(File.OpenRead(args[0])))
+ using (FileStream outStream = File.Create(Path.GetFileNameWithoutExtension(args[0]))) {
+ byte[] buffer = new byte[4096];
+ StreamUtils.Copy(inStream, outStream, buffer);
+ // OR
+ inStream.Read(buffer, 0, buffer.Length);
+ // now do something with the buffer
+ }
+ }
+ }
+
+ + You should never have a need to access this class directly. + TarBuffers are created by Tar IO Streams. +
++ TarEntries that are created from the header bytes read from + an archive are instantiated with the TarEntry( byte[] ) + constructor. These entries will be used when extracting from + or listing the contents of an archive. These entries have their + header filled in using the header bytes. They also set the File + to null, since they reference an archive entry not a file.
++ TarEntries that are created from files that are to be written + into an archive are instantiated with the CreateEntryFromFile(string) + pseudo constructor. These entries have their header filled in using + the File's information. They also keep a reference to the File + for convenience when writing entries.
++ Finally, TarEntries can be constructed from nothing but a name. + This allows the programmer to construct the entry by hand, for + instance when only an InputStream is available for writing to + the archive, and the header information is constructed from + other information. In this case the header fields are set to + defaults and the File is set to null.
+Read()
+ setInput(input, 0, input.length).
+ setDictionary(dict, 0, dict.Length).
+ NeedsInput()
+ returns true
+
+ strstart + DeflaterConstants.MAX_MATCH <= window.length.
+ prev[index & WMASK] points to the previous index that has the
+ same hash code as the string starting at index. This way
+ entries with the same hash code are in a linked list.
+ Note that the array should really be unsigned short, so you need
+ to and the values with 0xffff.
+ public Inflater(bool noHeader) passing true
+ if there is no Zlib header information
+
+ The usage is as following. First you have to set some input with
+ SetInput(), then Inflate() it. If inflate doesn't
+ inflate any bytes there may be three reasons:
+ SetInput().
+ NOTE: IsNeedingInput() also returns true when, the stream is finished.
+ SetDictionary().def.deflate() until all bytes from the input buffers
+ are processed.
+
+ using System;
+ using System.Text;
+ using System.Collections;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Zip;
+
+ class MainClass
+ {
+ static public void Main(string[] args)
+ {
+ using (ZipFile zFile = new ZipFile(args[0])) {
+ Console.WriteLine("Listing of : " + zFile.Name);
+ Console.WriteLine("");
+ Console.WriteLine("Raw Size Size Date Time Name");
+ Console.WriteLine("-------- -------- -------- ------ ---------");
+ foreach (ZipEntry e in zFile) {
+ if ( e.IsFile ) {
+ DateTime d = e.DateTime;
+ Console.WriteLine("{0, -10}{1, -10}{2} {3} {4}", e.Size, e.CompressedSize,
+ d.ToString("dd-MM-yy"), d.ToString("HH:mm"),
+ e.Name);
+ }
+ }
+ }
+ }
+ }
+
+
+ using System;
+ using System.Text;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Zip;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using ( ZipInputStream s = new ZipInputStream(File.OpenRead(args[0]))) {
+
+ ZipEntry theEntry;
+ const int size = 2048;
+ byte[] data = new byte[2048];
+
+ while ((theEntry = s.GetNextEntry()) != null) {
+ if ( entry.IsFile ) {
+ Console.Write("Show contents (y/n) ?");
+ if (Console.ReadLine() == "y") {
+ while (true) {
+ size = s.Read(data, 0, data.Length);
+ if (size > 0) {
+ Console.Write(new ASCIIEncoding().GetString(data, 0, size));
+ } else {
+ break;
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Core;
+ using ICSharpCode.SharpZipLib.Zip;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ string[] filenames = Directory.GetFiles(args[0]);
+ byte[] buffer = new byte[4096];
+
+ using ( ZipOutputStream s = new ZipOutputStream(File.Create(args[1])) ) {
+
+ s.SetLevel(9); // 0 - store only to 9 - means best compression
+
+ foreach (string file in filenames) {
+ ZipEntry entry = new ZipEntry(file);
+ s.PutNextEntry(entry);
+
+ using (FileStream fs = File.OpenRead(file)) {
+ StreamUtils.Copy(fs, s, buffer);
+ }
+ }
+ }
+ }
+ }
+
+ true if this revocation data Set holds OCSP
+ responses.
+
+ @return true if this revocation data Set holds OCSP
+ responses.
+ true if this revocation data Set holds CRLs.
+
+ @return true if this revocation data Set holds CRLs.
+ true if this revocation data is not empty.
+
+ @return true if this revocation data is not empty.
+ null if a description is not available.
+
+ @return the description, or null.
+ null in case such a download location does not
+ exist.
+
+ @return the download URL, or null.
+ null the signature will be limited to XAdES-T only.
+ null value will trigger an automatically generated signature Id.
+ null value will trigger an automatically generated signature Id.
+ null, the hash algorithm of the main entry
+ null the signature will be limited to XAdES-T only.
+ null the signature will be limited to XAdES-T only.
+ null, defaults to {@link #getDigestAlgo()}
+ 1.3.6.1.4.1.13762.3
+ null the claimed role element is omitted.
+ Defaults to null
+ null the claimed role element is omitted.
+ idSignedProperties
+ null defaults to idSignedProperties
+ true
+ EXCLUSIVE
+ @see javax.xml.Crypto.dsig.CanonicalizationMethod
+ null if not specified)
+ null
+ if not specified)
+ URIReference and returns the
+ dereferenced data.
+
+ @param uriReference the URIReference
+ @param context an XMLCryptoContext that may
+ contain additional useful information for dereferencing the URI. This
+ implementation should dereference the specified
+ URIReference against the context's baseURI
+ parameter, if specified.
+ @return the dereferenced data
+ @throws NullPointerException if uriReference or
+ context are null
+ @throws URIReferenceException if an exception occurs while
+ dereferencing the specified uriReference
+ EventListener interface was registered.
+ @param evt The Event contains contextual information
+ about the event. It also contains the stopPropagation
+ and preventDefault methods which are used in
+ determining the event's flow and default action.
+ This class is the default entry point for XML signatures and can be used for + validating an existing signed office document and signing a office document.
+ +Validating a signed office document
+ ++ OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ); + SignatureConfig sic = new SignatureConfig(); + sic.setOpcPackage(pkg); + SignatureInfo si = new SignatureInfo(); + si.setSignatureConfig(sic); + boolean isValid = si.validate(); + ... ++ +
Signing an office document
+ +
+ // loading the keystore - pkcs12 is used here, but of course jks & co are also valid
+ // the keystore needs to contain a private key and it's certificate having a
+ // 'digitalSignature' key usage
+ char password[] = "test".toCharArray();
+ File file = new File("test.pfx");
+ KeyStore keystore = KeyStore.getInstance("PKCS12");
+ FileInputStream fis = new FileInputStream(file);
+ keystore.load(fis, password);
+ fis.close();
+
+ // extracting private key and certificate
+ String alias = "xyz"; // alias of the keystore entry
+ Key key = keystore.getKey(alias, password);
+ X509Certificate x509 = (X509Certificate)keystore.getCertificate(alias);
+
+ // filling the SignatureConfig entries (minimum fields, more options are available ...)
+ SignatureConfig signatureConfig = new SignatureConfig();
+ signatureConfig.setKey(keyPair.getPrivate());
+ signatureConfig.setSigningCertificateChain(Collections.singletonList(x509));
+ OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ_WRITE);
+ signatureConfig.setOpcPackage(pkg);
+
+ // adding the signature document to the package
+ SignatureInfo si = new SignatureInfo();
+ si.setSignatureConfig(signatureConfig);
+ si.confirmSignature();
+ // optionally verify the generated signature
+ boolean b = si.verifySignature();
+ assert (b);
+ // write the changes back to disc
+ pkg.close();
+
+
+ Implementation notes:
+ +Although there's a XML signature implementation in the Oracle JDKs 6 and higher, + compatibility with IBM JDKs is also in focus (... but maybe not thoroughly tested ...). + Therefore we are using the Apache Santuario libs (xmlsec) instead of the built-in classes, + as the compatibility seems to be provided there.
+ +To use SignatureInfo and its sibling classes, you'll need to have the following libs + in the classpath:
++ Each POIXMLDocumentPart keeps a reference to the underlying a {@link org.apache.poi.openxml4j.opc.PackagePart}. +
+ + @author Yegor Kozlov +null for the root element.
+
+ protected void commit() {
+ PackagePart part = GetPackagePart();
+ Stream out = part.GetStream();
+ XmlObject bean = GetXmlBean(); //the "model" which holds Changes in memory
+ bean.save(out, DEFAULT_XML_OPTIONS);
+ out.close();
+ }
+ POIXMLDocumentPart
+
+ @author Yegor Kozlov
+ null if there isn't one
+
+ @return The Document Thumbnail part or null
+ thumbnail.jpeg, or null if there
+ isn't one.
+
+ @return The thumbnail filename, or null
+ null if there isn't one.
+
+ @return The thumbnail data, or null
+ thumbnail.jpg
+ @param imageData The inputstream to read the thumbnail image from
+ + A workbook may contain thousands of cells Containing string (non-numeric) data. Furthermore this data is very + likely to be repeated across many rows or columns. The goal of implementing a single string table that is shared + across the workbook is to improve performance in opening and saving the file by only Reading and writing the + repetitive information once. +
++ Consider for example a workbook summarizing information for cities within various countries. There may be a + column for the name of the country, a column for the name of each city in that country, and a column + Containing the data for each city. In this case the country name is repetitive, being duplicated in many cells. + In many cases the repetition is extensive, and a tremendous savings is realized by making use of a shared string + table when saving the workbook. When displaying text in the spreadsheet, the cell table will just contain an + index into the string table as the value of a cell, instead of the full string. +
++ The shared string table Contains all the necessary information for displaying the string: the text, formatting + properties, and phonetic properties (for East Asian languages). +
+ + @author Nick Birch + @author Yegor Kozlov +strings arrays
+
+ If the Shared String table already Contains this CT_Rst bean, its index is returned.
+ Otherwise a new entry is aded.
+
fmt in the numberFormats map if the format is not
+ already in the the number format style table.
+ Does nothing if fmt is already in number format style table.
+
+ @param fmt the number format to add to number format style table
+ @return the index of fmt in the number format style table
+ fmt
+ This may be used to override built-in number formats.
+
+ @param index the number format ID
+ @param fmt the number format code
+ sheet
+
+ @param sheet the sheet associated with this auto-size column tracker
+ @since 3.14beta1
+ columns that are already tracked are ignored by this call.
+
+ @param columns the indices of the columns to track
+ @since 3.14beta1
+ column is already tracked, this call does nothing.
+
+ @param column the index of the column to track for auto-sizing
+ @return if column is already tracked, the call does nothing and returns false
+ @since 3.14beta1
+ columns that is not tracked will be ignored by this call.
+
+ @param columns the indices of the columns to track for auto-sizing
+ @return true if one or more columns were untracked as a result of this call
+ @since 3.14beta1
+ column is not tracked, it will be ignored by this call.
+
+ @param column the index of the column to track for auto-sizing
+ @return true if column was tracked prior this call, false if no action was taken
+ @since 3.14beta1
+ .gz
+
+ @return temp file to write sheet data
+ SXSSFRow objects. Two rows are equal if they belong to the same worksheet and
+ their row indexes are equal.
+
+ @param other the SXSSFRow to be compared.
+ @return 0 if the row number of this SXSSFRow is
+ equal to the row number of the argument SXSSFRow
+ 0 if the row number of this this SXSSFRow is
+ numerically less than the row number of the argument SXSSFRow
+ 0 if the row number of this this SXSSFRow is
+ numerically greater than the row number of the argument SXSSFRow
+ + This process can be relatively slow on large sheets, so this should + normally only be called once per column, at the end of your + processing. +
+ You can specify whether the content of merged cells should be considered or ignored. + Default is to ignore merged cells. + ++ Special note about SXSSF implementation: You must register the columns you wish to track with + the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}. + This is needed because the rows needed to compute the column width may have fallen outside the + random access window and been flushed to disk. + Tracking columns is required even if all rows are in the random access window. +
+New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.
+ + @param column the column index to auto-size ++ This process can be relatively slow on large sheets, so this should + normally only be called once per column, at the end of your + processing. +
+ You can specify whether the content of merged cells should be considered or ignored. + Default is to ignore merged cells. + ++ Special note about SXSSF implementation: You must register the columns you wish to track with + the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}. + This is needed because the rows needed to compute the column width may have fallen outside the + random access window and been flushed to disk. + Tracking columns is required even if all rows are in the random access window. +
+New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.
+ + @param column the column index to auto-size + @param useMergedCells whether to use the contents of merged cells when calculating the width of the column +null if not found+ groupRows requires all rows in the group to be in the current window. + This is not always practical. Instead use setRowOutlineLevel to + explicitly set the group level. Level 1 is the top level group, + followed by 2, etc. It is up to the user to ensure that level 2 + groups are correctly nested under level 1, etc. +
+ + @param rownum index of row to update (0-based) + @param level outline level (greater than 0) +column is already tracked, this call does nothing.
+
+ @param column the column to track for autosizing
+ @since 3.14beta1
+ @see #trackColumnsForAutoSizing(Collection)
+ @see #trackAllColumnsForAutoSizing()
+ columns that are already tracked are ignored by this call.
+
+ @param columns the columns to track for autosizing
+ @since 3.14beta1
+ column is not tracked, it will be ignored by this call.
+
+ @param column the index of the column to track for auto-sizing
+ @return true if column was tracked prior to this call, false if no action was taken
+ @since 3.14beta1
+ @see #untrackColumnsForAutoSizing(Collection)
+ @see #untrackAllColumnsForAutoSizing(int)
+ columns that is not tracked will be ignored by this call.
+
+ @param columns the indices of the columns to track for auto-sizing
+ @return true if one or more columns were untracked as a result of this call
+
+ @param columns the columns to track for autosizing
+ @since 3.14beta1
+ + When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. ++ There are three use-cases to use SXSSFWorkbook(XSSFWorkbook) : +
+ When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. ++ When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. + @param compressTmpFiles whether to use gzip compression for temporary files ++ When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param workbook the template workbook + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. + @param compressTmpFiles whether to use gzip compression for temporary files + @param useSharedStringsTable whether to use a shared strings table +
+ SXSSF writes sheet data in temporary files (a temp file per-sheet)
+ and the size of these temp files can grow to to a very large size,
+ e.g. for a 20 MB csv data the size of the temp xml file become few GB large.
+ If the "compress" flag is set to true then the temporary XML is gzipped.
+
+ Please note the the "compress" option may cause performance penalty. +
+ @param compress whether to compress temp files +null
+ + The idea is to parse every formula and render it back to string + with the updated sheet name. This is done by parsing into Ptgs, + looking for ones with sheet references in them, and changing those +
+ + @param sheetIndex the 0-based index of the sheet being changed + @param oldName the old sheet name + @param newName the new sheet name +null if the formula wasn't modified
+ + Autofit specifies that a shape should be auto-fit to fully contain the text described within it. + Auto-fitting is when text within a shape is scaled in order to contain all the text inside +
++ Example: Consider the situation where a user is building a diagram and needs + to have the text for each shape that they are using stay within the bounds of the shape. + An easy way this might be done is by using NORMAL autofit +
++ Example: Consider the situation where a user is building a diagram and needs to have + the text for each shape that they are using stay within the bounds of the shape. + An easy way this might be done is by using SHAPE autofit +
++ Cells can be numeric, formula-based or string-based (text). The cell type + specifies this. String cells cannot conatin numbers and numeric cells cannot + contain strings (at least according to our model). Client apps should do the + conversions themselves. Formula cells have the formula string, as well as + the formula result, which can be numeric or string. +
++ Cells should have their number (0 based) before being Added to a row. Only + cells that have values should be Added. +
++ For strings, numbers, and errors, we throw an exception. For blank cells we return a false. +
+ @return the value of the cell as a bool + @throws InvalidOperationException if the cell type returned by {@link #CellType} + is not CellType.Boolean, CellType.Blank or CellType.Formula ++ For strings we throw an exception. For blank cells we return a 0. + For formulas or error cells we return the precalculated value; +
+ @return the value of the cell as a number + @throws InvalidOperationException if the cell type returned by {@link #CellType} is CellType.String + @exception NumberFormatException if the cell value isn't a parsabledouble.
+ @see DataFormatter for turning this number into a string similar to that which Excel would render this number as.
+ + For numeric cells we throw an exception. For blank cells we return an empty string. + For formulaCells that are not string Formulas, we throw an exception +
+ @return the value of the cell as a string ++ For numeric cells we throw an exception. For blank cells we return an empty string. + For formula cells we return the pre-calculated value if a string, otherwise an exception +
+ @return the value of the cell as a XSSFRichTextString +SUM(C4:E4)
+ + Note, this method only Sets the formula string and does not calculate the formula value. + To Set the precalculated value use {@link #setCellValue(double)} or {@link #setCellValue(String)} +
+ + @param formula the formula to Set, e.g."SUM(C4:E4)".
+ If the argument is null then the current formula is Removed.
+ @throws NPOI.ss.formula.FormulaParseException if the formula has incorrect syntax or is otherwise invalid
+ @throws InvalidOperationException if the operation is not allowed, for example,
+ when the cell is a part of a multi-cell array formula
+ + If the cell Contains a string, then this value is an index into + the shared string table, pointing to the actual string value. Otherwise, + the value of the cell is expressed directly in this element. Cells Containing formulas express + the last calculated result of the formula in this element. +
+ + @return the raw cell value as Contained in the underlying CT_Cell bean, +null for blank cells.
+ -1 means no xf.
+ @param stylesSource Styles Source to work off
+ null if not Set
+ + Note - many cells are actually Filled with a foreground + Fill, not a background fill - see {@link #getFillForegroundColor()} +
+ @see NPOI.xssf.usermodel.XSSFColor#getRgb() + @return XSSFColor - fill color ornull if not Set
+ + Many cells are Filled with this, instead of a + background color ({@link #getFillBackgroundColor()}) +
+ @see IndexedColors + @return fill color, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC} +null if not Set
+ @see NPOI.ss.usermodel.IndexedColors
+ [degrees below horizon] = 90 - textRotation.
+ application/vnd.Openxmlformats-officedocument.Drawingml.chart+xml
+ @param rel the namespace relationship holding this chart,
+ the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/chart
+ + Chart sheet is a special kind of Sheet that Contains only chart and no data. +
+ + @author Yegor Kozlov ++ If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final + ctColor applied. +
++ The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and + 1.0 means 100% lighten. Also, 0.0 means no Change. +
++ In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where + HLSMAX is currently 255. +
+ Here are some examples of how to apply tint to ctColor: +++ + @return the tint value ++ If (tint < 0) + Lum' = Lum * (1.0 + tint) + + For example: Lum = 200; tint = -0.5; Darken 50% + Lum' = 200 * (0.5) => 100 + For example: Lum = 200; tint = -1.0; Darken 100% (make black) + Lum' = 200 * (1.0-1.0) => 0 + If (tint > 0) + Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint)) + For example: Lum = 100; tint = 0.75; Lighten 75% + + Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75)) + = 100 * .25 + (255 - 255 * .25) + = 25 + (255 - 63) = 25 + 192 = 217 + For example: Lum = 100; tint = 1.0; Lighten 100% (make white) + Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1)) + = 100 * 0 + (255 - 255 * 0) + = 0 + (255 - 0) = 255 ++
null
+ null.
+ null otherwise
+ null.
+ null otherwise
+ null.
+ null otherwise
+ + MUST be a constant from {@link NPOI.ss.usermodel.ComparisonOperator} +
+ + @return the conditional format operator ++ If the condition type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}, + this field is the first operand of the comparison. + If type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}, this formula is used + to determine if the conditional formatting is applied. +
++ If comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function +
+ + @return the first formula +fmt
+ This may be used to override built-in number formats.
+
+ @param index the number format ID
+ @param format the number format code
+ null
+ application/vnd.openxmlformats-officedocument.Drawing+xml
+ @param rel the namespace relationship holding this Drawing,
+ the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing
+ + Even page header value. Corresponds to even printed pages. + Even page(s) in the sheet may not be printed, for example, if the print area is specified to be + a range such that it falls outside an even page's scope. + If no even header is specified, then odd header value is assumed for even page headers. +
+ +null
+ for the (conservative) assumption that any cell may have its defInition Changed After
+ Evaluation begins.
+ @param udfFinder pass null for default (AnalysisToolPak only)
+
+ Defined names are descriptive text that is used to represents a cell, range of cells, formula, or constant value.
+ Use easy-to-understand names, such as Products, to refer to hard to understand ranges, such as Sales!C20:C30.
+
+ + @author Nick Burch + @author Yegor Kozlov ++ XSSFWorkbook wb = new XSSFWorkbook(); + XSSFSheet sh = wb.CreateSheet("Sheet1"); + + //applies to the entire workbook + XSSFName name1 = wb.CreateName(); + name1.SetNameName("FMLA"); + name1.SetRefersToFormula("Sheet1!$B$3"); + + //applies to Sheet1 + XSSFName name2 = wb.CreateName(); + name2.SetNameName("SheetLevelName"); + name2.SetComment("This name is scoped to Sheet1"); + name2.SetLocalSheetId(0); + name2.SetRefersToFormula("Sheet1!$B$3"); + +
true indicates the name refers to a function.
+ true if this name refers to a user-defined function
+ true if the argument is XSSFName and the
+ underlying CTDefinedName bean Equals to the CTDefinedName representing this name
+
+ @param o the object to compare this XSSFName against.
+ @return true if the XSSFName are Equal;
+ false otherwise.
+ + Please note, that this method works correctly only for workbooks + with the default font size (Calibri 11pt for .xlsx). + If the default font is Changed the resized image can be streched vertically or horizontally. +
++ Please note, that this method works correctly only for workbooks + with the default font size (Calibri 11pt for .xlsx). + If the default font is changed the resized image can be streched vertically or horizontally. +
+
+ resize(1.0,1.0) keeps the original size,
+ resize(0.5,0.5) resize to 50% of the original,
+ resize(2.0,2.0) resizes to 200% of the original.
+ resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE}) resizes to the dimension of the embedded image.
+
http://schemas.openxmlformats.org/officeDocument/2006/relationships/image
+ @return registered POIXMLRelation or null if not found
+ + Most strings in a workbook have formatting applied at the cell level, that is, the entire string in the cell has the + same formatting applied. In these cases, the formatting for the cell is stored in the styles part, + and the string for the cell can be shared across the workbook. The following code illustrates the example. +
+ +
+
+ cell1.SetCellValue(new XSSFRichTextString("Apache POI"));
+ cell2.SetCellValue(new XSSFRichTextString("Apache POI"));
+ cell3.SetCellValue(new XSSFRichTextString("Apache POI"));
+
+
+ In the above example all three cells will use the same string cached on workbook level.
+
+ + Some strings in the workbook may have formatting applied at a level that is more granular than the cell level. + For instance, specific characters within the string may be bolded, have coloring, italicizing, etc. + In these cases, the formatting is stored along with the text in the string table, and is treated as + a unique entry in the workbook. The following xml and code snippet illustrate this. +
+ +
+
+ XSSFRichTextString s1 = new XSSFRichTextString("Apache POI");
+ s1.ApplyFont(boldArial);
+ cell1.SetCellValue(s1);
+
+ XSSFRichTextString s2 = new XSSFRichTextString("Apache POI");
+ s2.ApplyFont(italicCourier);
+ cell2.SetCellValue(s2);
+
+
+
+
+ @author Yegor Kozlov
+ null if no formatting is required
+
+ Example: The Unicode character 0D is invalid in an XML 1.0 document,
+ so it shall be escaped as _x000D_.
+
+ for(Cell cell : row){
+ ...
+ }
+ XSSFRow objects. Two rows are equal if they belong to the same worksheet and
+ their row indexes are equal.
+
+ @param row the XSSFRow to be compared.
+ @return 0 if the row number of this XSSFRow is
+ equal to the row number of the argument XSSFRow
+ 0 if the row number of this this XSSFRow is
+ numerically less than the row number of the argument XSSFRow
+ 0 if the row number of this this XSSFRow is
+ numerically greater than the row number of the argument XSSFRow
+
+ short minColIx = row.GetFirstCellNum();
+ short maxColIx = row.GetLastCellNum();
+ for(short colIx=minColIx; colIx<maxColIx; colIx++) {
+ XSSFCell cell = row.GetCell(colIx);
+ if(cell == null) {
+ continue;
+ }
+ //... do something with cell
+ }
+
+
+ @return short representing the last logical cell in the row PLUS ONE,
+ or -1 if the row does not contain any cells.
+ + Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work. + The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can + contain text, numbers, dates, and formulas. Cells can also be formatted. +
++ This process can be relatively slow on large sheets, so this should + normally only be called once per column, at the end of your + Processing. +
+ You can specify whether the content of merged cells should be considered or ignored. + Default is to ignore merged cells. + + @param column the column index + @param useMergedCells whether to use the contents of merged cells when calculating the width of the column +null if the drawing was not found and autoCreate=false
+ + If both colSplit and rowSplit are zero then the existing freeze pane is Removed +
+ + @param colSplit Horizonatal position of split. + @param rowSplit Vertical position of split. + @param leftmostColumn Left column visible in right pane. + @param topRow Top row visible in bottom pane +null if not foundnull
+ + Note, the returned value is always gerater that {@link #GetDefaultColumnWidth()} because the latter does not include margins. + Actual column width measured as the number of characters of the maximum digit width of the + numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin + pAdding (two on each side), plus 1 pixel pAdding for the gridlines. +
+ + @param columnIndex - the column to set (0-based) + @return width - the width in units of 1/256th of a character width ++ Please note, that this method works correctly only for workbooks + with the default font size (Calibri 11pt for .xlsx). +
++ Note, this value is different from {@link #GetColumnWidth(int)}. The latter is always greater and includes + 4 pixels of margin pAdding (two on each side), plus 1 pixel pAdding for the gridlines. +
+ @return column width, default value is 8 +true
+ null to remove protection
+ XSSFRow representing the rownumber or null if its not defined on the sheet
+ null
+ + When true a summary row is inserted below the detailed data being summarized and a + new outline level is established on that row. +
++ When false a summary row is inserted above the detailed data being summarized and a new outline level + is established on that row. +
+ @returntrue if row summaries appear below detail in the outline
+ + When true a summary column is inserted to the right of the detailed data being summarized + and a new outline level is established on that column. +
++ When false a summary column is inserted to the left of the detailed data being + summarized and a new outline level is established on that column. +
+ @returntrue if col summaries appear right of the detail in the outline
+ false if the column is visible
+ true if this sheet should display formulas.
+ true if this sheet displays gridlines.
+ @see #isPrintGridlines() to check if printing of gridlines is turned on or off
+ + Row heading are the row numbers to the side of the sheet +
++ Column heading are the letters or numbers that appear above the columns of the sheet +
+ + @returntrue if this sheet should display row and column headings.
+ true if there is a page break at the indicated row
+ sheet.SetColumnBreak(2); breaks the sheet into two parts
+ with columns A,B,C in the first and D,E,... in the second. Simuilar, sheet.SetRowBreak(2);
+ breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
+ and rows starting with rownum=4 in the second.
+
+ @param row the row to break, inclusive
+ true if the sheet displays Automatic Page Breaks.
+ sheet.SetColumnBreak(2); breaks the sheet into two parts
+ with columns A,B,C in the first and D,E,... in the second. Simuilar, sheet.SetRowBreak(2);
+ breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
+ and rows starting with rownum=4 in the second.
+
+ @param column the column to break, inclusive
+ + * The maximum column width for an individual cell is 255 characters. + * This value represents the number of characters that can be displayed + * in a cell that is formatted with the standard font (first font in the workbook). + *
+ * + *
+ * Character width is defined as the maximum digit width
+ * of the numbers 0, 1, 2, ... 9 as rendered
+ * using the default font (first font in the workbook).
+ *
+ * Unless you are using a very special font, the default character is '0' (zero),
+ * this is true for Arial (default font font in HSSF) and Calibri (default font in XSSF)
+ *
+ * Please note, that the width set by this method includes 4 pixels of margin pAdding (two on each side), + * plus 1 pixel pAdding for the gridlines (Section 3.3.1.12 of the OOXML spec). + * This results is a slightly less value of visible characters than passed to this method (approx. 1/2 of a character). + *
+ *+ * To compute the actual number of visible characters, + * Excel uses the following formula (Section 3.3.1.12 of the OOXML spec): + *
+ *
+ * width = TRuncate([{Number of Visible Characters} *
+ * {Maximum Digit Width} + {5 pixel pAdding}]/{Maximum Digit Width}*256)/256
+ *
+ * Using the Calibri font as an example, the maximum digit width of 11 point font size is 7 pixels (at 96 dpi).
+ * If you set a column width to be eight characters wide, e.g. SetColumnWidth(columnIndex, 8*256),
+ * then the actual value of visible characters (the value Shown in Excel) is derived from the following equation:
+ *
+ TRuncate([numChars*7+5]/7*256)/256 = 8;
+ *
+ *
+ * which gives 7.29.
+ *
+ 10 - 10% + 20 - 20% + ... + 100 - 100% + ... + 400 - 400% ++ + Current view can be Normal, Page Layout, or Page Break Preview. + + @param scale window zoom magnification + @throws ArgumentException if scale is invalid +
+ Additionally Shifts merged regions that are completely defined in these + rows (ie. merged 2 cells on a row to be Shifted).
+ @param startRow the row to start Shifting + @param endRow the row to end Shifting + @param n the number of rows to shift ++ Additionally Shifts merged regions that are completely defined in these + rows (ie. merged 2 cells on a row to be Shifted).
+ + @param startRow the row to start Shifting + @param endRow the row to end Shifting + @param n the number of rows to shift + @param copyRowHeight whether to copy the row height during the shift + @param reSetOriginalRowHeight whether to set the original row's height to the default ++ When only 1 sheet is selected and active, this value should be in synch with the activeTab value. + In case of a conflict, the Start Part Setting wins and Sets the active sheet tab. +
+ Note: multiple sheets can be selected, but only one sheet can be active at one time. + + @returntrue if this sheet is selected
+ A1.
+
+ @return the location of the active cell.
+ null if not found
+ +
CTTable.
+ Thus, {@link #updateReferences()} is inexpensive.
+
+ @since POI 3.15 beta 3
+ column.
+ The column index is relative to the left-most column in the table, 0-indexed.
+ Returns -1 if column is not a header name in table.
+
+ Column Header names are case-insensitive
+
+ Note: this function caches column names for performance. To flush the cache (because columns
+ have been moved or column headers have been changed), {@link #updateHeaders()} must be called.
+
+ @since 3.15 beta 2
+ null value means to use the text font color.
+ + Note that the closest properties object to the text is used, therefore if there is + a conflict between the text paragraph properties and the list style properties for + this level then the text paragraph properties will take precedence. +
+ Returns the level of text properties that this paragraph will follow. + + @return the text level of this paragraph (0-based). Default is 0. +null unsets the Typeface attribute from the underlying xml.
+ + The size is specified using a percentage. + Positive values indicate superscript, negative values indicate subscript. +
+ + @param baselineOffset ++ In Excel 2007 VML Drawings are used to describe properties of cell comments, + although the spec says that VML is deprecated: +
++ The VML format is a legacy format originally introduced with Office 2000 and is included and fully defined + in this Standard for backwards compatibility reasons. The DrawingML format is a newer and richer format + Created with the goal of eventually replacing any uses of VML in the Office Open XML formats. VML should be + considered a deprecated format included in Office Open XML for legacy reasons only and new applications that + need a file format for Drawings are strongly encouraged to use preferentially DrawingML +
+ ++ Warning - Excel is known to Put invalid XML into these files! + For example, >br< without being closed or escaped crops up. +
+ + See 6.4 VML - SpreadsheetML Drawing in Office Open XML Part 4 - Markup Language Reference.pdf + + @author Yegor Kozlov +application/vnd.Openxmlformats-officedocument.Drawing+xml
+ @param rel the namespace relationship holding this Drawing,
+ the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/drawing
+ null
+ Package object,
+ see http://poi.apache.org/oxml4j/.
+
+ Once you have finished working with the Workbook, you should close the package
+ by calling pkg.close, to avoid leaving file handles open.
+
+ Creating a XSSFWorkbook from a file-backed OPC Package has a lower memory
+ footprint than an InputStream backed one.
+
+ @param pkg the OpenXML4J OPC Package object.
+
+ OPCPackage pkg = OPCPackage.open(path);
+ XSSFWorkbook wb = new XSSFWorkbook(pkg);
+ // work with the wb object
+ ......
+ pkg.close(); // gracefully closes the underlying zip file
+ + Note that Excel allows sheet names up to 31 chars in length but other applications + (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars, + others - tRuncate such names to 31 character. +
++ POI's SpreadsheetAPI silently tRuncates the input argument to 31 characters. + Example: + +
+ Sheet sheet = workbook.CreateSheet("My very long sheet name which is longer than 31 chars"); // will be tRuncated
+ assert 31 == sheet.SheetName.Length;
+ assert "My very long sheet name which i" == sheet.SheetName;
+ + Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters: +
+ See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} + for a safe way to create valid names +
+ @param sheetname sheetname to set for the sheet. + @return Sheet representing the new sheet. + @throws IllegalArgumentException if the name is null or invalid + or workbook already contains a sheet with this name + @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal) +null is returned no named range could be found.null if it does not exist
+
+ XSSFWorkbook wb = new XSSFWorkbook(package);
+ for(XSSFSheet sheet : wb){
+
+ }
+ + Note that a sheet could instead be Set to be very hidden, which is different + ({@link #isSheetVeryHidden(int)}) +
+ @param sheetIx Number + @returntrue if sheet is hidden
+ + This is different from the normal hidden status + ({@link #isSheetHidden(int)}) +
+ @param sheetIx sheet index to check + @returntrue if sheet is very hidden
+
+ Calling setSheetHidden(sheetIndex, true) is equivalent to
+ setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN).
+
+ Calling setSheetHidden(sheetIndex, false) is equivalent to
+ setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE).
+
Workbook constants:
+ Workbook.SHEET_STATE_VISIBLE,
+ Workbook.SHEET_STATE_HIDDEN, or
+ Workbook.SHEET_STATE_VERY_HIDDEN.
+ @throws ArgumentException if the supplied sheet index or state is invalid
+ + The calculation chain object specifies the order in which the cells in a workbook were last calculated +
+ + @return theCalculationChain object or null if not defined
+ The external links table specifies details of named ranges etc + * that are referenced from other workbooks, along with the last seen + * values of what they point to.
+ * + *Note that Excel uses index 0 for the current workbook, so the first + * External Links in a formula would be '[1]Foo' which corresponds to + * entry 0 in this list.
+ + * @return theExternalLinksTable list, which may be empty
+ + The default instance : the built-in functions with the Excel Analysis Tool Pack. + To Set / Evaluate custom functions you need to register them as follows: + + + +
+ @return wrapped instance of UDFFinder that allows seeking functions both by index and name ++ Typically you want to force formula recalculation when you modify cell formulas or values + of a workbook previously Created by Excel. When Set to true, this flag will tell Excel + that it needs to recalculate all formulas in the workbook the next time the file is opened. +
++ Note, that recalculation updates cached formula results and, thus, modifies the workbook. + Depending on the version, Excel may prompt you with "Do you want to save the Changes in filename?" + on close. +
+ + @param value true if the application will perform a full recalculation of + workbook values when the workbook is opened + @since 3.8 ++ 9 Jan 2010 +
++ // TODO insert Javadoc here! +
+ @author epp + ++ if the border is on the left or right, no border is displayed. +
++ If the current section is not divided into columns, or the column break + occurs in the last column on the current page when displayed, then the + restart location for text shall be the next page in the document. +
+High(ish) level class for working with .docx files.
+ +This class tries to hide some of the complexity + of the underlying file format, but as it's not a + mature and stable API yet, certain parts of the + XML structure come through. You'll therefore almost + certainly need to refer to the OOXML specifications + from + http://www.ecma-international.org/publications/standards/Ecma-376.htm + at some point in your use.
++ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option any +
+ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option ReadOnly +
+ <w:settings ... > + <w:documentProtection w:edit="forms" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option forms +
+ <w:settings ... > + <w:documentProtection w:edit="comments" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option comments +
+ <w:settings ... > + <w:documentProtection w:edit="trackedChanges" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option trackedChanges +
+ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++
+ <w:settings ... > + <w:documentProtection w:edit="forms" w:enforcement="1"/> ++
+ <w:settings ... > + <w:documentProtection w:edit="comments" w:enforcement="1"/> ++
+ <w:settings ... > + <w:documentProtection w:edit="trackedChanges" w:enforcement="1"/> ++
true if revision tracking is turned on
+ A Paragraph within a Document, Table, Header etc.
+ +A paragraph has a lot of styling information, but the + actual text (possibly along with more styling) is held on + the child {@link XWPFRun}s.
++ If the line height (before any Added spacing) is larger than one or more + characters on the line, all characters will be aligned to each other as + specified by this element. +
++ If this element is omitted on a given paragraph, its value is determined + by the Setting previously Set at any level of the style hierarchy (i.e. + that previous Setting remains unChanged). If this Setting is never + specified in the style hierarchy, then the vertical alignment of all + characters on the line shall be automatically determined by the consumer. +
+ + @return the vertical alignment of this paragraph. ++ If this element is omitted on a given paragraph, + its value is determined by the Setting previously Set at any level of the + style hierarchy (i.e. that previous Setting remains unChanged). If this + Setting is never specified in the style hierarchy, then this property + shall not be applied. Since the paragraph is specified to start on a new + page, it begins page two even though it could have fit on page one. +
+ + @return bool - if page break is Set ++ If this attribute is omitted, its value shall be assumed to be zero. + Negative values are defined such that the text is Moved past the text margin, + positive values Move the text inside the text margin. +
+ + @return indentation or null if indentation is not Set ++ If this attribute is omitted, its value shall be assumed to be zero. + Negative values are defined such that the text is Moved past the text margin, + positive values Move the text inside the text margin. +
+ + @return indentation or null if indentation is not Set +
+ Note, that this call might be expensive since all the picture data is copied into a temporary byte array.
+ You can grab the picture data directly from the underlying package part as follows:
+
+
+ InputStream is1 = GetPackagePart().InputStream;
+
+
http://schemas.openxmlformats.org/officeDocument/2006/relationships/image
+ @return registered POIXMLRelation or null if not found
+ null if parent structure (paragraph > document) is not properly Set.
+
+ This formatting property is a toggle property, which specifies that its
+ behavior differs between its use within a style defInition and its use as
+ direct formatting. When used as part of a style defInition, Setting this
+ property shall toggle the current state of that property as specified up
+ to this point in the hierarchy (i.e. applied to not applied, and vice
+ versa). Setting it to false (or an equivalent) shall
+ result in the current Setting remaining unChanged. However, when used as
+ direct formatting, Setting this property to true or false shall Set the
+ absolute state of the resulting property.
+
+ If this element is not present, the default value is to leave the + formatting applied at previous level in the style hierarchy. If this + element is never applied in the style hierarchy, then bold shall not be + applied to non-complex script characters. +
+ + @param valuetrue if the bold property is applied to
+ this run
+ null if not Set
+ true if the italic property is applied
+ true if the strike property is applied
+ + This formatting property is a toggle property, which specifies that its + behavior differs between its use within a style defInition and its use as + direct formatting. When used as part of a style defInition, Setting this + property shall toggle the current state of that property as specified up + to this point in the hierarchy (i.e. applied to not applied, and vice + versa). Setting it to false (or an equivalent) shall result in the + current Setting remaining unChanged. However, when used as direct + formatting, Setting this property to true or false shall Set the absolute + state of the resulting property. +
++ If this element is not present, the default value is to leave the + formatting applied at previous level in the style hierarchy. If this + element is never applied in the style hierarchy, then strikethrough shall + not be applied to the contents of this run. +
+ + @param valuetrue if the strike property is applied to
+ this run
+ true if the double strike property is applied
+ + The behavior of this break character (the + location where text shall be restarted After this break) shall be + determined by its type values. +
+ @see BreakType ++ The behavior of this break character (the + location where text shall be restarted After this break) shall be + determined by its type (in this case is BreakType.TEXT_WRAPPING as default) and clear attribute values. +
+ @see BreakClear ++ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option any +
+ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option ReadOnly +
+ <w:settings ... > + <w:documentProtection w:edit="[passed editValue]" w:enforcement="1"/> ++
Sketch of XWPFTable class. Only table's text is being hold.
+Specifies the contents of a table present in the document. A table is a set + of paragraphs (and other block-level content) arranged in rows and columns.
++ [M2.8]: When adding a new part to a package, the package implementer + shall ensure that a content type for that part is specified in the + Content Types stream; the package implementer shall perform the steps + described in §9.1.2.3: +
+ 1. Get the extension from the part name by taking the substring to the + right of the rightmost occurrence of the dot character (.) from the + rightmost segment. +
+ 2. If a part name has no extension, a corresponding Override element + shall be added to the Content Types stream. +
+ 3. Compare the resulting extension with the values specified for the + Extension attributes of the Default elements in the Content Types stream. + The comparison shall be case-insensitive ASCII. +
+ 4. If there is a Default element with a matching Extension attribute, + then the content type of the new part shall be compared with the value of + the ContentType attribute. The comparison might be case-sensitive and + include every character regardless of the role it plays in the + content-type grammar of RFC 2616, or it might follow the grammar of RFC + 2616. +
+ a. If the content types match, no further action is required. +
+ b. If the content types do not match, a new Override element shall be + added to the Content Types stream. . +
+ 5. If there is no Default element with a matching Extension attribute, a + new Default element or Override element shall be added to the Content + Types stream. +
++ Delete a content type based on the specified part name. If the specified + part name is register with an override content type, then this content + type is remove, else the content type is remove in the default content + type list if it exists and if no part is associated with it yet. +
+ Check rule M2.4: The package implementer shall require that the Content + Types stream contain one of the following for every part in the package: + One matching Default element One matching Override element Both a + matching Default element and a matching Override element, in which case + the Override element takes precedence. +
+ @param partName + The part URI associated with the override content type to + delete. + @exception InvalidOperationException + Throws if +true if the specified content type is already
+ register, then false.
+ + Rule [M2.9]: To get the content type of a part, the package implementer + shall perform the steps described in §9.1.2.4: +
+ 1. Compare the part name with the values specified for the PartName + attribute of the Override elements. The comparison shall be + case-insensitive ASCII. +
+ 2. If there is an Override element with a matching PartName attribute, + return the value of its ContentType attribute. No further action is + required. +
+ 3. If there is no Override element with a matching PartName attribute, + then a. Get the extension from the part name by taking the substring to + the right of the rightmost occurrence of the dot character (.) from the + rightmost segment. b. Check the Default elements of the Content Types + stream, comparing the extension with the value of the Extension + attribute. The comparison shall be case-insensitive ASCII. +
+ 4. If there is a Default element with a matching Extension attribute, + return the value of its ContentType attribute. No further action is + required. +
+ 5. If neither Override nor Default elements with matching attributes are + found for the specified part name, the implementation shall not map this + part name to a part. +
+ @param partName + The URI part to check. + @return The content type associated with the URI (in case of an override + content type) or the extension (in case of default content type), + elsenull.
+
+ @exception OpenXml4NetRuntimeException
+ Throws if the content type manager is not able to find the
+ content from an existing part.
+ true.
+ null.
+ null.
+ null, skip the action.
+ @see #RemovePart(PackagePartName)
+ + A typical scneario to call this method is to rename a template file to the main format, e.g. + ".dotx" to ".docx" + ".dotm" to ".docm" + ".xltx" to ".xlsx" + ".xltm" to ".xlsm" + ".potx" to ".pptx" + ".potm" to ".pptm" +
+ For example, a code converting a .xlsm macro workbook to .xlsx would look as follows: ++
+
+ OPCPackage pkg = OPCPackage.open(new FileInputStream("macro-workbook.xlsm"));
+ pkg.replaceContentType(
+ "application/vnd.ms-excel.sheet.macroEnabled.main+xml",
+ "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml");
+
+ FileOutputStream out = new FileOutputStream("workbook.xlsx");
+ pkg.save(out);
+ out.close();
+
+ + Check rule M1.25: The Relationships part shall not have relationships to + any other part. Package implementers shall enforce this requirement upon + the attempt to create such a relationship and shall treat any such + relationship as invalid. +
+ @param targetPartName + Name of the target part. This one must be relative to the + source root directory of the part. + @param targetMode + Mode [Internal|External]. + @param relationshipType + Type of relationship. + @param id + Relationship unique id. + @return The newly created and added relationship + + @throws InvalidFormatException + If the URI point to a relationship part URI. + @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddRelationship(org.apache.poi.OpenXml4Net.opc.PackagePartName, + org.apache.poi.OpenXml4Net.opc.TargetMode, java.lang.String, java.lang.String) ++ Check rule M1.25: The Relationships part shall not have relationships to + any other part. Package implementers shall enforce this requirement upon + the attempt to create such a relationship and shall treat any such + relationship as invalid. +
+ @param targetURI + URI of the target part. Must be relative to the source root + directory of the part. + @param targetMode + Mode [Internal|External]. + @param relationshipType + Type of relationship. + @param id + Relationship unique id. + @return The newly created and added relationship + + @throws InvalidFormatException + If the URI point to a relationship part URI. + @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddRelationship(org.apache.poi.OpenXml4Net.opc.PackagePartName, + org.apache.poi.OpenXml4Net.opc.TargetMode, java.lang.String, java.lang.String) +null.
+ true except for
+ special URI like '/' which is needed for internal use by
+ OpenXml4Net but is not valid.
+ @throws InvalidFormatException
+ Throw if the specified part name is not conform to Open
+ Packaging Convention specifications.
+ @see java.net.URI
+ true except for
+ special URI like '/' which is needed for internal use by
+ OpenXml4Net but is not valid.
+ @throws InvalidFormatException
+ Throw if the specified part name is not conform to Open
+ Packaging Convention specifications.
+ true if this part name respect the relationship
+ part naming convention else false.
+ true if this part name respect the relationship
+ part naming convention else false.
+
+ The standard specifies a source relations ship for the Core File Properties part as follows:
+ http://schemas.openxmlformats.org/officedocument/2006/relationships/metadata/core-properties.
+
+ Office uses the following source relationship for the Core File Properties part:
+ http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties.
+
null.
+ null.
+ null.
+ @throws InvalidFormatException
+ Throws if the specified Uri is not OPC compliant.
+ null.
+ @throws InvalidFormatException
+ Throws if the specified part name is not OPC compliant.
+ @see #CreatePartName(Uri)
+ null.
+ @throws InvalidFormatException
+ Throws if the specified part name is not OPC compliant.
+ @see #CreatePartName(Uri)
+ null.
+ @throws InvalidFormatException
+ Throws if the specified part name is not OPC compliant.
+ @see #CreatePartName(Uri)
+ Namespace URI to use to represent that there is no Namespace.
+ +Defined by the Namespace specification to be "".
+ + @see + Namespaces in XML, 5.2 Namespace Defaulting +Prefix to use to represent the default XML Namespace.
+ +Defined by the XML specification to be "".
+ + @see + Namespaces in XML, 3. Qualified Names +The official XML Namespace name URI.
+ +Defined by the XML specification to be + "{@code http://www.w3.org/XML/1998/namespace}".
+ + @see + Namespaces in XML, 3. Qualified Names +The official XML attribute used for specifying XML Namespace + declarations, {@link #XMLNS_ATTRIBUTE + XMLConstants.XMLNS_ATTRIBUTE}, Namespace name URI.
+ +Defined by the XML specification to be + "{@code http://www.w3.org/2000/xmlns/}".
+ + @see + Namespaces in XML, 3. Qualified Names + @see + Namespaces in XML Errata +The official XML attribute used for specifying XML Namespace + declarations.
+ +It is NOT valid to use as a + prefix. Defined by the XML specification to be + "{@code xmlns}".
+ + @see + Namespaces in XML, 3. Qualified Names +W3C XML Schema Instance Namespace URI.
+ +Defined to be "{@code http://www.w3.org/2001/XMLSchema-instance}".
+ + @see + XML Schema Part 1: + Structures, 2.6 Schema-Related Markup in Documents Being Validated +W3C XPath Datatype Namespace URI.
+ +Defined to be "{@code http://www.w3.org/2003/11/xpath-datatypes}".
+ + @see XQuery 1.0 and XPath 2.0 Data Model +RELAX NG Namespace URI.
+ +Defined to be "{@code http://relaxng.org/ns/structure/1.0}".
+ + @see RELAX NG Specification +Returns the character count including whitespace, or 0 if the + {@link DocumentSummaryInformation} does not contain this char count.
+ This is the whitespace-including version of {@link SummaryInformation#getCharCount()} + + @return The character count ornull
+ Get if the User Defined Property Set has been updated outside of the + Application.
+If it has (true), the hyperlinks should be updated on document load.
+Gets the version of the Application which wrote the + Property set, stored with the two high order bytes having the major + version number, and the two low order bytes the minor version number.
+This will be 0 if no version is set.
+Returns the VBA digital signature for the VBA project
+ embedded in the document (or null).
Gets the content type of the file (or null).
Gets the content status of the file (or null).
Gets the document language, which is normally unset and empty
+ (or null).
Gets the document version as a string, which is normally unset and empty
+ (or null).
Creates the most specific {@link PropertySet} from an entry + in the specified POIFS Directory. This is preferrably a {@link + DocumentSummaryInformation} or a {@link SummaryInformation}. If + the specified entry does not contain a property Set stream, an + exception is thrown. If no entry is found with the given name, + an exception is thrown.
+ + @param dir The directory to find the PropertySet in + @param name The name of the entry Containing the PropertySet + @return The Created {@link PropertySet}. + @if there is no entry with that name + @if the stream does not + contain a property Set. + @if some I/O problem occurs. + @exception EncoderFallbackException if the specified codepage is not + supported. +To process this data, you may wish to make use of the + {@link Thumbnail} class. The raw data is generally + an image in WMF or Clipboard (BMP?) format
+typedef struct tagCLIPDATA {
+ // cbSize is the size of the buffer pointed To
+ // by pClipData, plus sizeof(ulClipFmt)
+ ULONG cbSize;
+ long ulClipFmt;
+ BYTE* pClipData;
+ } CLIPDATA;
+
+ See
+ msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp.
+ Turns a codepage number into the equivalent character encoding's + name.
+ + @param codepage The codepage number + + @return The character encoding's name. If the codepage number is 65001, + the encoding name is "UTF-8". All other positive numbers are mapped to + "cp" followed by the number, e.g. if the codepage number is 1252 the + returned character encoding name will be "cp1252". + + @exception UnsupportedEncodingException if the specified codepage is + less than zero. +| Value | +Description | +
|---|---|
| 0 | +No restriction | +
| 2 | +Read-only recommended | +
| 4 | +Read-only enforced | +
The highest well-known property ID. Applications are free to use + higher values for custom purposes. (This value is based on Office 12, + earlier versions of Office had lower values)
++ Returns much (but not all) of the textual content of the file, + suitable for indexing by something like Apache Lucene, or used + by Apache Tika, but not really intended for display to the user. +
+null to remove all protection
+ shouldProtectObjects are protected
+ shouldProtectScenarios are protected
+ null
+ null
+ null if the formula cell is not shared/array/table,
+ or if the specified formula is not the the first in the group.
+ null.
+ null.
+ null
+ null
+ @return encoded size of the formula tokens (does not include 2 bytes for ushort length)
+ DConRef Structure
+ [MS-XLS s.
+ 2.4.86], and the contained DConFile structure
+
+ [MS-XLS s. 2.5.69]. This in turn contains a XLUnicodeStringNoCch
+
+ [MS-XLS s. 2.5.296].
+
+ + _______________________________ + | DConRef | + (bytes) +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+ + | ref |cch| stFile | un| + +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+ + | + _________|_____________________ + |DConFile / XLUnicodeStringNoCch| + +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+ + (bits) |h| reserved | rgb | + +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+ ++ Where +
DConFile.h = 0x00 if the characters inrgb are single byte, and
+ DConFile.h = 0x01 if they are double byte. DConRef.un = 2. Otherwise it is 1.DConFile.rgb = (2 * DConRef.cch). Otherwise it is equal to
+ DConRef.cchDConRef.rgb starts with 0x01 if it is an external reference,
+ and with 0x02 if it is a self-reference.sid = {@value}
+ rgb field of a
+ XLUnicodeStringNoCch. Therefore it will contain at least one leading special
+ character (0x01 or 0x02) and probably other ones.
+ @see
+ DConFile [MS-XLS s. 2.5.77] and
+
+ VirtualPath [MS-XLS s. 2.5.69]
+
+ FtPioGrbitSubRecord and
+ fill its data with the default values
+ FtPioGrbitSubRecord and
+ fill its data with the default values
+ null
+ + Most records construct themselves from {@link RecordInputStream}. + This class assumes that a {@link ContinueRecord} record break always occurs at the type boundary, + however, it is not always so. +
+ Two attachments to Bugzilla 50779 + demonstrate that a CONTINUE break can appear right in between two bytes of a unicode character + or between two bytes of ashort. The problematic portion of the data is
+ in a Asian Phonetic Settings Block (ExtRst) of a UnicodeString.
+
+ {@link RecordInputStream} greedily requests the bytes to be read and stumbles on such files with a
+ "Not enough data (1) to read requested (2) bytes" exception. The ContinuableRecordInput
+ class circumvents this "type boundary" rule and Reads data byte-by-byte rolling over CONTINUE if necessary.
+
+ YK: For now (March 2011) this class is only used to read + @link NPOI.HSSF.Record.Common.UnicodeString.ExtRst} blocks of a UnicodeString. + +
+ + @author Yegor Kozlov +| Mask | Description |
|---|---|
| 0x01 | is16bitEncoded |
| 0x04 | hasExtendedData |
| 0x08 | isRichText |
FtCblsSubRecord and
+ fill its data with the default values
+ true, this record represents an error cell value, otherwise this record represents a boolean cell value
+ Description: the default characterset. for the workbook
+REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
+Use {@link CodePageUtil} to turn these values into Java code pages + to encode/decode strings.
+ @version 2.0-pre +null if it is currently unSet.
+ true if drop down arrow should be suppressed when list validation is
+ used, false otherwise
+ + If the type of the SupBook record is same-sheet referencing, Add-In referencing, + DDE data source referencing, or OLE data source referencing, + then no scope is specified and this value MUST be -2. Otherwise, + the scope must be set as follows: +
-2 Workbook-level reference that applies to the entire workbook.-1 Sheet-level reference. >=0 Sheet-level reference. This specifies the first sheet in the reference.
+ + If the SupBook type is unused or external workbook referencing, + then this value specifies the zero-based index of an external sheet name, + see {@link org.apache.poi.hssf.record.SupBookRecord#getSheetNames()}. + This referenced string specifies the name of the first sheet within the external workbook that is in scope. + This sheet MUST be a worksheet or macro sheet. +
++ If the supporting link type is self-referencing, then this value specifies the zero-based index of a + {@link org.apache.poi.hssf.record.BoundSheetRecord} record in the workbook stream that specifies + the first sheet within the scope of this reference. This sheet MUST be a worksheet or a macro sheet. +
+null if the specified record is not interpreted by POI.
+ null
+ if stream was empty
+ null if not present.
+ null if
+ this pass didn't return a record that's
+ suitable for returning (eg was a continue record).
+ null if unknown to POI
+ null if textExpr does not begin with '='
+ null if numberStr is null
+ null if timeStr is null
+ null for default YYYYMMDD
+ @return null if timeStr is null
+ null
+ +
+ One important concept worth considering Is that of font size. One of the + difficulties in Converting Graphics calls into escher Drawing calls Is that + Excel does not have the concept of absolute pixel positions. It measures + it's cell widths in 'Chars' and the cell heights in points. + Unfortunately it's not defined exactly what a type of Char it's + measuring. Presumably this Is due to the fact that the Excel will be + using different fonts on different platforms or even within the same + platform. + + Because of this constraint we've had to calculate the + verticalPointsPerPixel. This the amount the font should be scaled by when + you Issue commands such as DrawString(). A good way to calculate this + Is to use the follow formula: + ++ + @author Glen Stampoultzis (glens at apache.org) ++ multipler = GroupHeightInPoints / heightOfGroup ++ + The height of the Group Is calculated fairly simply by calculating the + difference between the y coordinates of the bounding box of the shape. The + height of the Group can be calculated by using a convenience called +HSSFClientAnchor.GetAnchorHeightInPoints() . +
0 means Context (Default), 1 means Left To Right, + and 2 means Right to Left
+ + @return order - the reading order (0,1,2) +s.
+ null otherwise
+ null otherwise
+ null otherwise
+ null
+ for the (conservative) assumption that any cell may have its definition changed after
+ evaluation begins.
+ null for default (AnalysisToolPak only)
+ null
+ for the (conservative) assumption that any cell may have its definition changed after
+ evaluation begins.
+ @param udfFinder pass null for default (AnalysisToolPak only)
+ + int EvaluatedCellType = evaluator.EvaluateInCell(cell).CellType; ++ Be aware that your cell value will be Changed to hold the + result of the formula. If you simply want the formula + value computed for you, use {@link #EvaluateFormulaCell(HSSFCell)} + @param cell +
+ Please note, that this method works correctly only for workbooks + with default font size (Arial 10pt for .xls). + If the default font is changed the resized image can be streched vertically or horizontally. +
+
+ resize(1.0,1.0) keeps the original size,
+ resize(0.5,0.5) resize to 50% of the original,
+ resize(2.0,2.0) resizes to 200% of the original.
+ resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE}) resizes to the dimension of the embedded image.
+
null to remove protection
+ + 10 - 10% + 20 - 20% + ... + 100 - 100% + ... + 400 - 400% ++ + @param scale window zoom magnification + @throws IllegalArgumentException if scale is invalid +
indexes.
+
+ @param indexes
+ Title: HSSFCellRangeAddress
+Description: + Implementation of the cell range Address lists,like Is described in + OpenOffice.org's Excel Documentation . + In BIFF8 there Is a common way to store absolute cell range Address + lists in several records (not formulas). A cell range Address list + consists of a field with the number of ranges and the list of the range + Addresses. Each cell range Address (called an AddR structure) Contains + 4 16-bit-values.
+Copyright: Copyright (c) 2004
+Company:
+ @author Dragos Buleandra (dragos.buleandra@trade2b.ro) + @version 2.0-pre +-1 means that
+ the scope of the name will be ignored and the parser will match named ranges only by name
+
+ @return the parsed formula tokens
+ null, typically empty array
+ null if there isn't one for the given name.
+ 2.3.4.7 ECMA-376 Document Encryption Key Generation (Standard Encryption)
+ 2.3.4.11 Encryption Key Generation (Agile Encryption)
The encryption key for ECMA-376 document encryption [ECMA-376] using agile + encryption MUST be generated by using the following method, which is derived from PKCS #5: + Password-Based Cryptography Version 2.0 [RFC2898].
+ +Let H() be a hashing algorithm as determined by the PasswordKeyEncryptor.hashAlgorithm + element, H_n be the hash data of the n-th iteration, and a plus sign (+) represent concatenation. + The password MUST be provided as an array of Unicode characters. Limitations on the length of the + password and the characters used by the password are implementation-dependent. + The initial password hash is generated as follows:
+ + +H_0 = H(salt + password)+ +
The salt used MUST be generated randomly. The salt MUST be stored in the + PasswordKeyEncryptor.saltValue element contained within the \EncryptionInfo stream as + specified in section 2.3.4.10. The hash is then iterated by using the following approach:
+ +H_n = H(iterator + H_n-1)+ +
where iterator is an unsigned 32-bit value that is initially set to 0x00000000 and then incremented + monotonically on each iteration until PasswordKey.spinCount iterations have been performed. + The value of iterator on the last iteration MUST be one less than PasswordKey.spinCount.
+ +For POI, H_final will be calculated by {@link #generateKey(byte[],HashAlgorithm,byte[],int)}
+ + @param password + @param hashAlgorithm + @param salt + @param spinCount + @return the hashed password +2.3.4.12 Initialization Vector Generation (Agile Encryption)
+ +Initialization vectors are used in all cases for agile encryption. An initialization vector MUST be + generated by using the following method, where H() is a hash function that MUST be the same as + specified in section 2.3.4.11 and a plus sign (+) represents concatenation:
+2.3.4.11 Encryption Key Generation (Agile Encryption)
+ +The final hash data that is used for an encryption key is then generated by using the following + method:
+ +H_final = H(H_n + blockKey)+ +
where blockKey represents an array of bytes used to prevent two different blocks from encrypting + to the same cipher text.
+ +If the size of the resulting H_final is smaller than that of PasswordKeyEncryptor.keyBits, the key + MUST be padded by appending bytes with a value of 0x36. If the hash value is larger in size than + PasswordKeyEncryptor.keyBits, the key is obtained by truncating the hash value.
+ + @param passwordHash + @param hashAlgorithm + @param blockKey + @param keySize + @return intermediate key ++ Use {@link #getLength()} to Get the size of that data that can be safely read from the stream. + Just Reading to the end of the input stream is not sufficient because there are + normally pAdding bytes that must be discarded +
+ + @param dir the node to read from + @return decrypted stream ++ The length variable is Initialized in {@link #getDataStream(NPOI.POIFS.FileSystem.DirectoryNode)}, + an attempt to call GetLength() prior to GetDataStream() will result in InvalidOperationException. +
+ + @return length of the encrypted data + @throws InvalidOperationException if {@link #getDataStream(NPOI.POIFS.FileSystem.DirectoryNode)} + was not called +true always
+ Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream. The File will be opened read-only
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ + @param file the File from which to read the data + + @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream.
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ + @param file the File from which to read or read/write the data + @param readOnly whether the POIFileSystem will only be used in read-only mode + + @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from an open FileChannel. This uses + * less memory than creating from an InputStream. The stream will + * be used in read-only mode.
+ * + *Note that with this constructor, you will need to call {@link #close()} + * when you're done to have the underlying Channel closed, as the channel is + * kept open during normal operation to read the data out.
+ * + * @param channel the FileChannel from which to read the data + * + * @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from an open FileChannel. This uses + less memory than creating from an InputStream.
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying Channel closed, as the channel is + kept open during normal operation to read the data out.
+ + @param channel the FileChannel from which to read or read/write the data + @param readOnly whether the POIFileSystem will only be used in read-only mode + + @exception IOException on errors reading, or on invalid data +true
+ for markSupported()). In the unlikely case that the caller has such a stream
+ and needs to use it After this constructor completes, a work around is to wrap the
+ stream in order to trap the close() call. A convenience method (
+ CreateNonClosingInputStream()) has been provided for this purpose:
+ + InputStream wrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is); + HSSFWorkbook wb = new HSSFWorkbook(wrappedStream); + is.Reset(); + doSomethingElse(is); ++ Note also the special case of MemoryStream for which the close() + method does nothing. +
+ MemoryStream bais = ... + HSSFWorkbook wb = new HSSFWorkbook(bais); // calls bais.Close() ! + bais.Reset(); // no problem + doSomethingElse(bais); ++ + @param stream the InputStream from which to read the data + + @exception IOException on errors Reading, or on invalid data +
false if an exception is currently being thrown in the calling method
+ null.
+
+ @return the dataSize
+ null
+ if no data was embedded. Note that an embedding may provide information about
+ the data, but the actual data is not included. (So label, filename etc. are
+ available, but this method returns null.)
+
+ @return the dataBuffer
+ Returns the last name in the document path's name sequence. + If the document path's name sequence is empty, then the empty string is returned.
+ + @since 2016-04-09 + @return The last name in the document path's name sequence, or empty string if this is the root path +Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream.
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ @param readOnly whether the POIFileSystem will only be used in read-only mode + + @param file the File from which to read the data + + @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream. The File will be opened read-only
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ + @param file the File from which to read the data + + @exception IOException on errors reading, or on invalid data +A class describing attributes of the Big Block Size
+read() method if
+ the current position is less than the limit.
+ Creates a {@link ClassID} from a human-readable representation of the Class ID in standard
+ format "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}".
The value returned by this method is equal to the value that would + be returned by Arrays.asList(a).toString(), unless a + is null, in which case "null" is returned.
+ + @param a the array whose string representation to return + @return a string representation of a + @see #deepToString(Object[]) + @since 1.5 +Provides constants for understanding numeric codepages, + along with utilities to translate these into Java Character Sets.
+Codepage 037, a special case
+Codepage for SJIS
+Codepage for GBK, aka MS936
+Codepage for MS949
+Codepage for UTF-16
+Codepage for UTF-16 big-endian
+Codepage for Windows 1250
+Codepage for Windows 1251
+Codepage for Windows 1252
+Codepage for Windows 1253
+Codepage for Windows 1254
+Codepage for Windows 1255
+Codepage for Windows 1256
+Codepage for Windows 1257
+Codepage for Windows 1258
+Codepage for Johab
+Codepage for Macintosh Roman (Java: MacRoman)
+Codepage for Macintosh Japan (Java: unknown - use SJIS, cp942 or + cp943)
+Codepage for Macintosh Chinese Traditional (Java: unknown - use Big5, + MS950, or cp937)
+Codepage for Macintosh Korean (Java: unknown - use EUC_KR or + cp949)
+Codepage for Macintosh Arabic (Java: MacArabic)
+Codepage for Macintosh Hebrew (Java: MacHebrew)
+Codepage for Macintosh Greek (Java: MacGreek)
+Codepage for Macintosh Cyrillic (Java: MacCyrillic)
+Codepage for Macintosh Chinese Simplified (Java: unknown - use + EUC_CN, ISO2022_CN_GB, MS936 or cp935)
+Codepage for Macintosh Romanian (Java: MacRomania)
+Codepage for Macintosh Ukrainian (Java: MacUkraine)
+Codepage for Macintosh Thai (Java: MacThai)
+Codepage for Macintosh Central Europe (Latin-2) + (Java: MacCentralEurope)
+Codepage for Macintosh Iceland (Java: MacIceland)
+Codepage for Macintosh Turkish (Java: MacTurkish)
+Codepage for Macintosh Croatian (Java: MacCroatian)
+Codepage for US-ASCII
+Codepage for KOI8-R
+Codepage for ISO-8859-1
+Codepage for ISO-8859-2
+Codepage for ISO-8859-3
+Codepage for ISO-8859-4
+Codepage for ISO-8859-5
+Codepage for ISO-8859-6
+Codepage for ISO-8859-7
+Codepage for ISO-8859-8
+Codepage for ISO-8859-9
+Codepage for ISO-2022-JP
+Another codepage for ISO-2022-JP
+Yet another codepage for ISO-2022-JP
+Codepage for ISO-2022-KR
+Codepage for EUC-JP
+Codepage for EUC-KR
+Codepage for GB2312
+Codepage for GB18030
+Another codepage for US-ASCII
+Codepage for UTF-8
+Codepage for Unicode
+Turns a codepage number into the equivalent character encoding's + name.
+ + @param codepage The codepage number + + @return The character encoding's name. If the codepage number is 65001, + the encoding name is "UTF-8". All other positive numbers are mapped to + "cp" followed by the number, e.g. if the codepage number is 1252 the + returned character encoding name will be "cp1252". + + @exception UnsupportedEncodingException if the specified codepage is + less than zero. +bytesToDump bytes to an output stream.
+
+ @param in The stream to read from
+ @param out The output stream
+ @param start The index to use as the starting position for the left hand side label
+ @param bytesToDump The number of bytes to output. Use -1 to read until the end of file.
+ If the length of
The first byte read is stored into element
The
+read(b, 0, b.length)
This method blocks until input data is available, end of file is + detected, or an exception is thrown.
+ + If
The first byte read is stored into element
In every case, elements
The
The
Note that while some implementations of {@code InputStream} will return + the total number of bytes in the stream, many will not. It is + never correct to use the return value of this method to allocate + a buffer intended to hold all data in this stream.
+ +A subclass' implementation of this method may choose to throw an + {@link IOException} if this input stream has been closed by + invoking the {@link #close()} method.
+ +The {@code available} method for class {@code InputStream} always + returns {@code 0}.
+ +This method should be overridden by subclasses.
+ The
The
The general contract of
Marking a closed stream should not have any effect on the stream.
+ + The
The general contract of
The method
+ hashCode = 1;
+ Iterator i = list.Iterator();
+ while (i.HasNext()) {
+ Object obj = i.Next();
+ hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
+ }
+
+
+ This ensures that list1.Equals(list2) implies that
+ list1.HashCode()==list2.HashCode() for any two lists, list1 and
+ list2, as required by the general contract of Object.HashCode.
+
+ I am happy is someone wants to re-implement this without using the + internal list and hashmap. If so could you please make sure that + you can add elements half way into the list and have the value-key mappings + update
+byte.length bytes of data from this
+ input stream into an array of bytes. This method blocks until some
+ input is available.
+
+ simulate java FilterInputStream
+ len bytes of data from this input stream
+ into an array of bytes.If len is not zero, the method
+ blocks until some input is available; otherwise, no
+ bytes are read and0 is returned.
+
+ simulate java FilterInputStream
+
+ hashCode = 1;
+ Iterator i = list.Iterator();
+ while (i.HasNext()) {
+ Object obj = i.Next();
+ hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
+ }
+
+
+ This ensures that list1.Equals(list2) implies that
+ list1.HashCode()==list2.HashCode() for any two lists, list1 and
+ list2, as required by the general contract of Object.HashCode.
+ + References: +
epsilon of value, in absolute terms.
+ @param maxDenominator maximum denominator value allowed.
+ @param maxIterations maximum number of convergents
+ @throws RuntimeException if the continued fraction failed to
+ converge.
+ @throws IllegalArgumentException if value > Integer.MAX_VALUE
+ + Syntax: MAXIFS(data_range, criteria_range1, criteria1, [criteria_range2, criteria2]) +
++ Syntax: MINIFS(min_range, criteria_range1, criteria1, [criteria_range2, criteria2]) +
+true if date is weekend, false otherwise.
+ true if date is a holiday, false otherwise.
+ 1 is not a workday, 0 otherwise.
+ true if aDate is between start and end dates, false otherwise.
+ | Value | Days per Month | Days per Year |
|---|---|---|
| 0 (default) | 30 | 360 |
| 1 | actual | actual |
| 2 | actual | 360 |
| 3 | actual | 365 |
| 4 | 30 | 360 |
null signifying that the cell is not present (or blank)
+ @return null if the supplied cell is null or blank
+ + int EvaluatedCellType = Evaluator.EvaluateInCell(cell).CellType; ++ Be aware that your cell value will be Changed to hold the + result of the formula. If you simply want the formula + value computed for you, use {@link #EvaluateFormulaCellEnum(Cell)}} + @param cell + @return the {@code cell} that was passed in, allowing for chained calls +
+ int EvaluatedCellType = Evaluator.EvaluateFormulaCell(cell); ++ Be aware that your cell will hold both the formula, and the result. If you want the cell + Replaced with the result of the formula, use {@link #EvaluateInCell(NPOI.SS.UserModel.Cell)} + @param cell The cell to Evaluate + @return -1 for non-formula cells, or the type of the formula result +
+ ICellType EvaluatedCellType = Evaluator.EvaluateFormulaCellEnum(cell); ++ Be aware that your cell will hold both the formula, + and the result. If you want the cell Replaced with + the result of the formula, use {@link #Evaluate(NPOI.SS.UserModel.Cell)} } + @param cell The cell to Evaluate + @return The type of the formula result (the cell's type remains as CellType.FORMULA however) + If cell is not a formula cell, returns {@link CellType#_NONE} rather than throwing an exception. + @since POI 3.15 beta 3 +
null for default (AnalysisToolPak only)
+ null if the supplied cell is null or blank
+ null (possibly {@link BlankEval}). The specified indexes should be absolute
+ indexes in the sheet and not relative indexes within the area.
+
+ public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
+ // ...
+ Eval arg0 = args[0];
+ if(arg0 is ErrorEval) {
+ return arg0;
+ }
+ if(!(arg0 is AreaEval)) {
+ return ErrorEval.VALUE_INVALID;
+ }
+ double temp = 0;
+ AreaEval area = (AreaEval)arg0;
+ ValueEval[] values = area.LittleEndianConstants.BYTE_SIZE;
+ for (int i = 0; i < values.Length; i++) {
+ ValueEval ve = values[i];
+ if(ve is ErrorEval) {
+ return ve;
+ }
+ if(!(ve is NumericValueEval)) {
+ return ErrorEval.VALUE_INVALID;
+ }
+ temp += ((NumericValueEval)ve).NumberValue;
+ }
+ // ...
+ }
+
+ In this example, if any error is encountered while Processing the arguments, an error is
+ returned immediately. This code is difficult to refactor due to all the points where errors
+ are returned.
+ public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
+ try {
+ // ...
+ AreaEval area = GetAreaArg(args[0]);
+ double temp = sumValues(area.LittleEndianConstants.BYTE_SIZE);
+ // ...
+ } catch (EvaluationException e) {
+ return e.GetErrorEval();
+ }
+ }
+
+ private static AreaEval GetAreaArg(Eval arg0){
+ if (arg0 is ErrorEval) {
+ throw new EvaluationException((ErrorEval) arg0);
+ }
+ if (arg0 is AreaEval) {
+ return (AreaEval) arg0;
+ }
+ throw EvaluationException.InvalidValue();
+ }
+
+ private double sumValues(ValueEval[] values){
+ double temp = 0;
+ for (int i = 0; i < values.Length; i++) {
+ ValueEval ve = values[i];
+ if (ve is ErrorEval) {
+ throw new EvaluationException((ErrorEval) ve);
+ }
+ if (!(ve is NumericValueEval)) {
+ throw EvaluationException.InvalidValue();
+ }
+ temp += ((NumericValueEval) ve).NumberValue;
+ }
+ return temp;
+ }
+
+ It is not mandatory to use EvaluationException, doing so might give the following advantages:null.
+ | A | B | C | D | |
|---|---|---|---|---|
| 1 | 15 | 20 | 25 | |
| 2 | 200 | |||
| 3 | 300 | |||
| 3 | 400 |
| A | B | C | D | |
|---|---|---|---|---|
| 1 | 15 | 20 | 25 | |
| 2 | 1215 | 1220 | #VALUE! | 200 |
| 3 | 1315 | 1320 | #VALUE! | 300 |
| 4 | #VALUE! | #VALUE! | #VALUE! | 400 |
null, possibly empty string.
+
+ Syntax :
+ AverageIfs ( average_range, criteria_range1, criteria1,
+ [criteria_range2, criteria2], ...)
+
criteriaRanges argument contains the same number of rows and columns
+ as the avgRange argument
+
+ @throws EvaluationException if
+ aeAvg
+ @param predicates array of predicates, a predicate for each value in ranges
+ @param aeAvg the range to calculate
+
+ @return the computed value
+ Some utils for Converting from and to any base
+ + @author cedric dot walter @ gmail dot com ++ Syntax: COUNTIFS(criteria_range1, criteria1, [criteria_range2, criteria2]) +
+
+ Syntax:
+ ERROR.TYPE(errorValue)
+ Returns a number corresponding to the error type of the supplied argument.
++
| errorValue | Return Value |
| #NULL! | 1 |
| #DIV/0! | 2 |
| #VALUE! | 3 |
| #REF! | 4 |
| #NAME? | 5 |
| #NUM! | 6 |
| #N/A! | 7 |
| everything else | #N/A! |
double representing periodic payment amount.
+ double representing interest portion of payment.
+
+ @see #pmt(double, int, double, double, int)
+ @see #fv(double, int, double, double, int)
+ double representing principal portion of payment.
+
+ @see #pmt(double, int, double, double, int)
+ @see #ipmt(double, int, int, double, double, bool)
+ double representing future principal value.
+ Returns the modified internal rate of return for a series of periodic cash flows. MIRR considers both the cost + of the investment and the interest received on reinvestment of cash.
+ + Values is an array or a reference to cells that contain numbers. These numbers represent a series of payments (negative values) and income (positive values) occurring at regular periods. +Implementation for Excel Oct2Dec() function.
++ Converts an octal number to decimal. +
+
+ Syntax:
Oct2Dec (number )
+
Implementation for Excel QUOTIENT () function.
+
+ Syntax:
QUOTIENT(Numerator,Denominator)
+
+ Numerator is the dividend. + Denominator is the divisor. + + Returns the integer portion of a division. Use this function when you want to discard the remainder of a division. +
+ + If either enumerator/denominator is non numeric, QUOTIENT returns the #VALUE! error value. + If denominator is Equals to zero, QUOTIENT returns the #DIV/0! error value. + + @author cedric dot walter @ gmail dot com +
+
+ Syntax :
+ AVERAGEIF ( range, criteria, avg_range )
+
| range | The range over which criteria is applied. Also used for included values when the third parameter is not present |
|---|---|
| criteria | The value or expression used to filter rows from range |
| avg_range | Locates the top-left corner of the corresponding range of addends - values to be included (after being selected by the criteria) |
+ Syntax :
+ SUMIFS ( sum_range, criteria_range1, criteria1,
+ [criteria_range2, criteria2], ...)
+
criteria predicate is valid, i.e. not an error
+
+ @throws EvaluationException if there are criteria which resulted in Errors.
+ criteriaRanges argument contains the same number of rows and columns
+ as the sumRange argument
+
+ @throws EvaluationException if
+ aeSum
+ @param predicates array of predicates, a predicate for each value in ranges
+ @param aeSum the range to sum
+
+ @return the computed value
+ + If there are other subtotals within argument refs (or nested subtotals), + these nested subtotals are ignored to avoid double counting. +
+ + @see Subtotal ++ Syntax: COUNTBLANK ( range ) +
| range | is the range of cells to count blanks |
|---|
| range | is the range of cells to be Counted based on the criteria |
|---|---|
| criteria | is used to determine which cells to Count |
null if the arg evaluates to blank.
+ Calculates the number of days between two dates based on a 360-day year + (twelve 30-day months), which is used in some accounting calculations. Use + this function to help compute payments if your accounting system is based on + twelve 30-day months.
+ + {@code DAYS360(start_date,end_date,[method])} + +
+ p(1+r)^n + y(1+rt)((1+r)^n-1)/r + f=0 ...{when r!=0}
+ ny + p + f=0 ...{when r=0}
+
+ null,
+ nor are any of its elements.
+ @param ec primarily used to identify the source cell Containing the formula being Evaluated.
+ may also be used to dynamically create reference evals.
+ @return never null. Possibly an instance of | reference | typically an area reference, possibly a union of areas |
|---|---|
| array | a literal array value (currently not supported) |
| row_num | selects the row within the array or area reference |
| column_num | selects column within the array or area reference. default Is 1 |
| area_num | used when reference Is a union of areas |
null if text cannot be parsed.
+ null if there is a syntax error in any escape sequence
+ (the typical syntax error is a single quote character not followed by another).
+ + Starting with the guess, the method cycles through the calculation until the result + is accurate within 0.00001 percent. If IRR can't find a result that works + after 20 tries, the Double.NaN is returned. +
++ The implementation is inspired by the NewtonSolver from the Apache Commons-Math library, + @see http://commons.apache.org +
+ + @param values the income values. + @param guess the initial guess of irr. + @return the irr value. The method returnsDouble.NaN
+ if the maximum iteration count is exceeded
+
+ @see
+ http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution
+ @see
+ http://en.wikipedia.org/wiki/Newton%27s_method
+ | Input Return | Value | Thrown Error |
|---|---|---|
| 5 | 4 | |
| 2.9 | 2 | |
| "5" | 4 | |
| "2.18e1" | 21 | |
| "-$2" | -3 | * |
| FALSE | -1 | * |
| TRUE | 0 | |
| "TRUE" | #REF! | |
| "abc" | #REF! | |
| "" | #REF! | |
| <blank> | #VALUE! |
| Value | Matching Behaviour |
|---|---|
| 1 | (default) Find the largest value that Is less than or equal to lookup_value. + The lookup_array must be in ascending order*. |
| 0 | Find the first value that Is exactly equal to lookup_value. + The lookup_array can be in any order. |
| -1 | Find the smallest value that Is greater than or equal to lookup_value. + The lookup_array must be in descending order*. |
+
+ Syntax :
+ SUBTOTAL ( functionCode, ref1, ref2 ... )
+
| functionCode | (1-11) Selects the underlying aggregate function to be used (see table below) |
| ref1, ref2 ... | Arguments to be passed to the underlying aggregate function |
| functionCode | Aggregate Function |
|---|---|
| 1 | AVERAGE |
| 2 | COUNT |
| 3 | COUNTA |
| 4 | MAX |
| 5 | MIN |
| 6 | PRODUCT |
| 7 | STDEV |
| 8 | STDEVP * |
| 9 | SUM |
| 10 | VAR * |
| 11 | VARP * |
| 101-111 | * |
+
+ Syntax :
+ SUMIF ( range, criteria, sum_range )
+
| range | The range over which criteria is applied. Also used for addend values when the third parameter is not present |
|---|---|
| criteria | The value or expression used to filter rows from range |
| sum_range | Locates the top-left corner of the corresponding range of addends - values to be added (after being selected by the criteria) |
null if there is any problem converting the text
+ Title: XSSF Area 3D Reference (Sheet + Area)
+Description: Defined an area in an external or different sheet.
+REFERENCE:
+ +This is XSSF only, as it stores the sheet / book references + in String form. The HSSF equivalent using indexes is {@link Area3DPtg}
+This is XSSF only, as it stores the sheet / book references + in String form. The HSSF equivalent using indexes is {@link NameXPtg}
+Title: XSSF 3D Reference
+Description: Defines a cell in an external or different sheet.
+REFERENCE:
+ +This is XSSF only, as it stores the sheet / book references + in String form. The HSSF equivalent using indexes is {@link Ref3DPtg}
+Title: Area 3D Ptg - 3D reference (Sheet + Area)
+Description: Defined an area in Extern Sheet.
+REFERENCE:
+ + This is HSSF only, as it matches the HSSF file format way of + referring to the sheet by an extern index. The XSSF equivalent + is {@link Area3DPxg} +For example, $E5:B$10 becomes B5:$E$10
null if the function name is unknown.
+
+ @param name Name of function.
+ @return Function executor.
+ Return will have no workbook set if it's actually in our own workbook
+Return will have no workbook set if it's actually in our own workbook
+null.
+ nulls OK.
+ @param ptgs may be null
+ @return Never null (Possibly empty if the supplied null)
+ nulls OK.
+
+ @param formula may be null
+ @return possibly null (if the supplied null)
+ null if this formula is not part of an array or shared formula.
+ -1 means that
+ * the scope of the name will be ignored and the parser will match names only by name
+ *
+ * @return array of parsed tokens
+ * @throws FormulaParseException if the formula is unparsable
+ + A$1 + $A$1 : $B1 + A1 ....... C2 + Sheet1 !$A1 + a..b!A1 + 'my sheet'!A1 + .my.sheet!A1 + 'my sheet':'my alt sheet'!A1 + .my.sheet1:.my.sheet2!$B$2 + my.named..range. + 'my sheet'!my.named.range + .my.sheet!my.named.range + foo.bar(123.456, "abc") + 123.456 + "abc" + true + [Foo.xls]!$A$1 + [Foo.xls]'my sheet'!$A$1 + [Foo.xls]!my.named.range ++ +
+ Table1[col] + Table1[[#Totals],[col]] + Table1[#Totals] + Table1[#All] + Table1[#Data] + Table1[#Headers] + Table1[#Totals] + Table1[#This Row] + Table1[[#All],[col]] + Table1[[#Headers],[col]] + Table1[[#Totals],[col]] + Table1[[#All],[col1]:[col2]] + Table1[[#Data],[col1]:[col2]] + Table1[[#Headers],[col1]:[col2]] + Table1[[#Totals],[col1]:[col2]] + Table1[[#Headers],[#Data],[col2]] + Table1[[#This Row], [col1]] + Table1[ [col1]:[col2] ] ++ @param tableName + @return +
+ my.named...range. + foo.bar(123.456, "abc") + 123.456 + "abc" + true ++
null
+ @param part1
+ @param part2 may be null
+ null (and leaves {@link #_pointer} unchanged if a proper range part does not parse out
+ null result
+ @return The sheet name as an identifier null if '!' is not found in the right place
+ null
+ * @return Ptg a null is returned if we're in an IF formula, it needs extreme manipulation and is handled in this Function
+ null if either workbook or sheet is not found
+ null
+ the current workbook is assumed. Note - to Evaluate formulas which use multiple workbooks,
+ a {@link CollaboratingWorkbooksEnvironment} must be set up.
+ @param sheetName the name of the sheet Containing the reference. May be null
+ (when null.
+ @param refStrPart2 the second part of the area reference. For single cell references this
+ parameter must be null
+ @param isA1Style specifies the format for null
+ null or {@link #RefErrorPtg} if no change was made
+
+ @param aptg
+ @return
+ null or {@link #AreaErrPtg} if no change was made
+
+ @param aptg
+ @return null, AreaErrPtg, or modified aptg
+ Ptg
+ tokens into human readable text form. In formula expressions, a sheet name always has a
+ trailing '!' so there is little chance for ambiguity. It doesn't matter too much what this
+ method returns but it is worth noting the likely consumers of these formula text strings:
+ + + @return+
+ Input Result Comments + "A1" true + "a111" true + "AA" false + "aa1" true + "A1A" false + "A1A1" false + "A$1:$C$20" false Not a plain cell reference + "SALES20080101" true +Still needs delimiting even though well out of range
+ In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable. + With this method you can control how POI handles such missing references: +
This defines how to calculate the ranges for a conditional + formatting rule, eg which values Get a Green Traffic Light + icon and which Yellow or Red.
+If you change the range type, you need to + ensure that the Formula and Value parameters + are compatible with it before saving
+ Formula to use to calculate the threshold, + ornull if no formula
+ null is given.
+ Gets the value used for the threshold, or
+ null if there isn't one.
+ + If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final + ctColor applied. +
++ The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and + 1.0 means 100% lighten. Also, 0.0 means no Change. +
++ In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where + HLSMAX is currently 255. +
+ Here are some examples of how to apply tint to ctColor: +++ + @return the tint value ++ If (tint < 0) + Lum' = Lum * (1.0 + tint) + + For example: Lum = 200; tint = -0.5; Darken 50% + Lum' = 200 * (0.5) => 100 + For example: Lum = 200; tint = -1.0; Darken 100% (make black) + Lum' = 200 * (1.0-1.0) => 0 + If (tint > 0) + Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint)) + For example: Lum = 100; tint = 0.75; Lighten 75% + + Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75)) + = 100 * .25 + (255 - 255 * .25) + = 25 + (255 - 63) = 25 + 192 = 217 + For example: Lum = 100; tint = 1.0; Lighten 100% (make white) + Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1)) + = 100 * 0 + (255 - 255 * 0) + = 0 + (255 - 0) = 255 ++
Format class that handles Excel style fractions, such as "# #/#" and "#/###"
+ +As of this writing, this is still not 100% accurate, but it does a reasonable job + of trying to mimic Excel's fraction calculations. It does not currently + maintain Excel's spacing.
+ +This class relies on a method lifted nearly verbatim from org.apache.math.fraction. + If further uses for Commons Math are found, we will consider Adding it as a dependency. + For now, we have in-lined the one method to keep things simple.
+If the new Icon Set has a different number of + icons to the old one, you must update the + thresholds before saving!
+ Should Icon + Value be displayed, or only the Icon? ++ Each element corresponds to a color index (zero-based). When using the default indexed color palette, + the values are not written out, but instead are implied. When the color palette has been modified from default, + then the entire color palette is used. +
+ + @author Yegor Kozlov +XSSFTable.UpdateHeaders() is called to reset the cache.
+ @param columnHeader the column header name to Get the table column index of
+ @return column index corresponding to columnHeader
+ + Filtering data is a quick and easy way to find and work with a subset of data in a range of cells or table. + For example, you can filter to see only the values that you specify, filter to see the top or bottom values, + or filter to quickly see duplicate values. +
+ + TODO YK: For now (Aug 2010) POI only supports Setting a basic autofilter on a range of cells. + In future, when we support more auto-filter functions like custom criteria, sort, etc. we will add + corresponding methods to this interface. +null if there is not a built-in format at that index
+ + Automatically converts "text" to excel's format string to represent text. +
+ @param pFmt string matching a built-in format + @return index of format or -1 if undefined. ++ Cells can be numeric, formula-based or string-based (text). The cell type + specifies this. String cells cannot conatin numbers and numeric cells cannot + contain strings (at least according to our model). Client apps should do the + conversions themselves. Formula cells have the formula string, as well as + the formula result, which can be numeric or string. +
++ Cells should have their number (0 based) before being Added to a row. +
+If the cell currently contains a value, the value will + be converted to match the new type, if possible. Formatting + is generally lost in the process however.
+If what you want to do is get a String value for your + numeric cell, stop!. This is not the way to do it. + Instead, for fetching the string value of a numeric or boolean + or date cell, use {@link DataFormatter} instead.
+"SUM(C4:E4)".
+ A1 style address of this cell
+ @since 3.14beta2
+ null.
+ null.
+ + Specifies that the current drawing shall move and + resize to maintain its row and column anchors (i.e. the + object is anchored to the actual from and to row and column) +
++ Specifies that the current drawing shall move with its + row and column (i.e. the object is anchored to the + actual from row and column), but that the size shall remain absolute. +
++ If Additional rows/columns are Added between the from and to locations of the drawing, + the drawing shall move its to anchors as needed to maintain this same absolute size. +
++ Specifies that the current start and end positions shall + be maintained with respect to the distances from the + absolute start point of the worksheet. +
++ If Additional rows/columns are Added before the + drawing, the drawing shall move its anchors as needed + to maintain this same absolute position. +
++ 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells. +
+ @return the anchor type + @see #MOVE_AND_RESIZE + @see #MOVE_DONT_RESIZE + @see #DONT_MOVE_AND_RESIZE ++ For example, "highlight cells that begin with "M2" and contain "Mountain Gear". +
+ + @author Dmitriy Kumshayev + @author Yegor Kozlov ++ ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index); + newSheet.AddConditionalFormatting(cf); ++ +
+
+ // Define a Conditional Formatting rule, which triggers formatting
+ // when cell's value is greater or equal than 100.0 and
+ // applies patternFormatting defined below.
+ ConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
+ ComparisonOperator.GE,
+ "100.0", // 1st formula
+ null // 2nd formula is not used for comparison operator GE
+ );
+
+ // Create pattern with red background
+ PatternFormatting patternFmt = rule.CretePatternFormatting();
+ patternFormatting.FillBackgroundColor(IndexedColor.RED.Index);
+
+ // Define a region Containing first column
+ Region [] regions =
+ {
+ new Region(1,(short)1,-1,(short)1)
+ };
+
+ // Apply Conditional Formatting rule defined above to the regions
+ sheet.AddConditionalFormatting(regions, rule);
+
+
+ @author Dmitriy Kumshayev
+ @author Yegor Kozlov
+ null
+ null.
+ null otherwise
+ null.
+ null otherwise
+ null.
+ null otherwise
+ null otherwise
+ null otherwise
+ null otherwise
+ + MUST be either {@link #CONDITION_TYPE_CELL_VALUE_IS} or {@link #CONDITION_TYPE_FORMULA} +
+ + @return the type of condition ++ MUST be a constant from {@link ComparisonOperator} +
+ + @return the conditional format operator ++ If the condition type is {@link #CONDITION_TYPE_CELL_VALUE_IS}, + this field is the first operand of the comparison. + If type is {@link #CONDITION_TYPE_FORMULA}, this formula is used + to determine if the conditional formatting is applied. +
++ If comparison type is {@link #CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function +
+ + @return the first formula +null
+ null
+ null
+ null
+ formula1 was comma-separated literal values rather than a range or named range,
+ returns list of literal values.
+ Otherwise returns null.
+ null
+ null
+ excelDate == GetExcelDate(GetJavaDate(excelDate,false))
+ Is not always true. For example if default timezone Is
+ Example: + In the case of SUM(B1 C1), the space between B1 and C1 is treated as the binary + intersection operator, when a comma was intended. end example] +
+Example: + In the case of a function argument, text was expected, but a number was provided +
+Example: + If a formula Contains a reference to a cell, and then the row or column Containing that cell is deleted, + a #REF! error results. If a worksheet does not support 20,001 columns, + OFFSET(A1,0,20000) will result in a #REF! error. +
+Example: + Certain calls to ASIN, ATANH, FACT, and SQRT might result in domain errors. +
+ Intended to indicate that the result of a function cannot be represented in a value of + the specified type, typically due to extreme magnitude. (This is known as a range + error.) +Example: FACT(1000) might result in a range error.
+Example: + Some functions, such as SUMX2MY2, perform a series of operations on corresponding + elements in two arrays. If those arrays do not have the same number of elements, then + for some elements in the longer array, there are no corresponding elements in the + shorter one; that is, one or more values in the shorter array are not available. +
+ This error value can be produced by calling the function NA ++ int EvaluatedCellType = Evaluator.evaluateFormulaCell(cell); ++ Be aware that your cell will hold both the formula, + and the result. If you want the cell Replaced with + the result of the formula, use {@link #EvaluateInCell(Cell)} + @param cell The cell to Evaluate + @return The type of the formula result, i.e. -1 if the cell is not a formula, + or one of Cell.CELL_TYPE_NUMERIC, Cell.CELL_TYPE_STRING, Cell.CELL_TYPE_BOOLEAN, Cell.CELL_TYPE_ERROR + Note: the cell's type remains as Cell.CELL_TYPE_FORMULA however. +
+ int EvaluatedCellType = Evaluator.evaluateInCell(cell).getCellType(); ++ Be aware that your cell value will be Changed to hold the + result of the formula. If you simply want the formula + value comPuted for you, use {@link #EvaluateFormulaCell(Cell)} + @param cell +
+ Additional rules: +
+ When there is also an indent value to apply, both the left and right side of the cell + are pAdded by the indent value. +
+A 'word' is a set of characters with no space character in them.
+Two lines inside a cell are Separated by a carriage return.
+null if it has not been set yet. Never empty string
+ @see #SetRefersToFormula(String)
+ + Please note, that this method works correctly only for workbooks + with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx). + If the default font is changed the resized image can be streched vertically or horizontally. +
+
+ resize(1.0,1.0) keeps the original size,
+ resize(0.5,0.5) resize to 50% of the original,
+ resize(2.0,2.0) resizes to 200% of the original.
+ resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE}) resizes to the dimension of the embedded image.
+
SetCellValue or SetCellType.
+
+ short minColIx = row.GetFirstCellNum();
+ short maxColIx = row.GetLastCellNum();
+ for(short colIx=minColIx; colIx<maxColIx; colIx++) {
+ Cell cell = row.GetCell(colIx);
+ if(cell == null) {
+ continue;
+ }
+ //... do something with cell
+ }
+
+ nullnullnull to remove protection
+ + Sheet1!$1:$1 + Sheet2!$5:$8 ++ The {@link CellRangeAddress} returned contains a column part which spans + all columns, and a row part which specifies the contiguous range of + repeating rows. + + If the Sheet does not have any repeating rows defined, null is returned. +
+ Sheet1!$A:$A + Sheet2!$C:$F ++ The {@link CellRangeAddress} returned contains a row part which spans all + rows, and a column part which specifies the contiguous range of + repeating columns. + + If the Sheet does not have any repeating columns defined, null is + returned. +
A1.
+ + The Created conditional formatting rule Compares a cell value + to a formula calculated result, using the specified operator. + The type of the Created condition is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS} +
+ + @param comparisonOperation - MUST be a constant value from ++
+ When text direction is horizontal: the vertical alignment of lines of text is distributed vertically, + where each line of text inside the cell is evenly distributed across the height of the cell, + with flush top and bottom margins. +
++ When text direction is vertical: similar behavior as horizontal justification. + The alignment is justified (flush top and bottom in this case). For each line of text, each + line of the wrapped text in a cell is aligned to the top and bottom (except the last line). + If no single line of text wraps in the cell, then the text is not justified. +
++ When text direction is horizontal: the vertical alignment of lines of text is distributed vertically, + where each line of text inside the cell is evenly distributed across the height of the cell, + with flush top +
++ When text direction is vertical: behaves exactly as distributed horizontal alignment. + The first words in a line of text (appearing at the top of the cell) are flush + with the top edge of the cell, and the last words of a line of text are flush with the bottom edge of the cell, + and the line of text is distributed evenly from top to bottom. +
++ This is different from the normal hidden status + ({@link #isSheetHidden(int)}) +
+ @param sheetIx sheet index to check + @returntrue if sheet is very hidden
+ + 0 = not hidden + 1 = hidden + 2 = very hidden. ++ @param sheetIx The sheet number + @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden +
This class is a Container for POI usermodel row=0 column=0 cell references. + It is barely a Container for these two coordinates. The implementation + of the Comparable interface sorts by "natural" order top left to bottom right.
+ +Use CellAddress when you want to refer to the location of a cell in a sheet + when the concept of relative/absolute does not apply (such as the anchor location + of a cell comment). Use {@link CellReference} when the concept of + relative/absolute does apply (such as a cell reference in a formula). + CellAddresses do not have a concept of "sheet", while CellReferences do.
+25.4/HorizontalPixelSize
+ and 25.4/VerticalPixelSize. Where 25.4 is the number of mm in inch.
+
+ @return array of two elements: {horisontalPdi, verticalDpi}.
+ {96, 96} is the default.
+ | Result | Comment |
|---|---|
| A1:A1 | Single cell area reference without sheet |
| A1:$C$1 | Multi-cell area reference without sheet |
| Sheet1!A$1:B4 | Standard sheet name |
| 'O''Brien''s Sales'!B5:C6' | Sheet name with special Chars |
Common conversion functions between Excel style A1, C27 style + cell references, and POI usermodel style row=0, column=0 + style references. Handles sheet-based and sheet-free references + as well, eg "Sheet1!A1" and "$B$72"
+ +Use CellReference when the concept of + relative/absolute does apply (such as a cell reference in a formula). + Use {@link CellAddress} when you want to refer to the location of a cell in a sheet + when the concept of relative/absolute does not apply (such as the anchor location + of a cell comment). + CellReferences have a concept of "sheet", while CellAddresses do not.
+| Result | Comment |
|---|---|
| A1 | Cell reference without sheet |
| Sheet1!A1 | Standard sheet name |
| 'O''Brien''s Sales'!A1' | Sheet name with special characters |
+ POI currently targets BIFF8 (Excel 97-2003), so the following behaviour can be observed for + this method: ++
+ Version File Format +Last Column Last Row + 97-2003 BIFF8 "IV" (2^8) 65536 (2^14) + 2007 BIFF12 "XFD" (2^14) 1048576 (2^20)
+ + @param colStr a string of only letter characters + @param rowStr a string of only digit characters + @return+
+ Input +Result + "A", "1" true + "a", "111" true + "A", "65536" true + "A", "65537" false + "iv", "1" true + "IW", "1" false + "AAA", "1" false + "a", "111" true + "Sheet", "1" false
This method attempts to find an existing CellStyle that matches the cell's
+ current style plus styles properties in properties. A new style is created if the
+ workbook does not contain a matching style.
Modifies the cell style of cell without affecting other cells that use the
+ same style.
This is necessary because Excel has an upper limit on the number of styles that it supports.
+ +This function is more efficient than multiple calls to + {@link #setCellStyleProperty(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.usermodel.Workbook, String, Object)} + if adding multiple cell styles.
+ +For performance reasons, if this is the only cell in a workbook that uses a cell style, + this method does NOT remove the old style from the workbook. + +
+ + @param cell The cell to change the style of + @param properties The properties to be added to a cell style, as {propertyName: propertyValue}. + @since POI 3.14 beta 2 +This method attempts to find an existing CellStyle that matches the cell's
+ current style plus a single style property propertyName with value
+ propertyValue.
+ A new style is created if the workbook does not contain a matching style.
Modifies the cell style of cell without affecting other cells that use the
+ same style.
If setting more than one cell style property on a cell, use + {@link #setCellStyleProperties(org.apache.poi.ss.usermodel.Cell, Map)}, + which is faster and does not add unnecessary intermediate CellStyles to the workbook.
+ + @param cell The cell that is to be changed. + @param propertyName The name of the property that is to be changed. + @param propertyValue The value of the property that is to be changed. +This method attempts to find an existing CellStyle that matches the cell's
+ current style plus a single style property propertyName with value
+ propertyValue.
+ A new style is created if the workbook does not contain a matching style.
Modifies the cell style of cell without affecting other cells that use the
+ same style.
If setting more than one cell style property on a cell, use + {@link #setCellStyleProperties(Cell, Map)}, + which is faster and does not add unnecessary intermediate CellStyles to the workbook.
+ + @param workbook The workbook that is being worked with. + @param propertyName The name of the property that is to be changed. + @param propertyValue The value of the property that is to be changed. + @param cell The cell that needs it's style changes +style, so subsequent changes
+ to style will not modify the map, and changes to the returned
+ map will not modify the cell style. The returned map is mutable.
+ @param style cell style
+ @return map of format properties (String -> Object)
+ @see #setFormatProperties(org.apache.poi.ss.usermodel.CellStyle, org.apache.poi.ss.usermodel.Workbook, java.util.Map)
+ | 1 | 2 |
| 3 | 4 |
negative, 0, or positive according to the standard Excel comparison
+ of values isNegative ? -1 : +1
+ java.util.Date or java.util.Calendar
+ instances become date cells.Object.toString()
+ method call.If the cell at the given co-ordinates is a merged cell, this will + return the primary (top-left) most cell of the merged region.
+If the cell at the given co-ordinates is not in a merged region, + then will return the cell itself.
+If there is no cell defined at the given co-ordinates, will return + null.
+
+ The character count
GetMaxRows() - 1
+ GetMaxColumns() - 1
+ IV or XFD).
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+
+ SplashWindow splash = new SplashWindow();
+ return splash;
+
+ true if this revocation data Set holds OCSP
+ responses.
+
+ @return true if this revocation data Set holds OCSP
+ responses.
+ true if this revocation data Set holds CRLs.
+
+ @return true if this revocation data Set holds CRLs.
+ true if this revocation data is not empty.
+
+ @return true if this revocation data is not empty.
+ null if a description is not available.
+
+ @return the description, or null.
+ null in case such a download location does not
+ exist.
+
+ @return the download URL, or null.
+ null the signature will be limited to XAdES-T only.
+ null value will trigger an automatically generated signature Id.
+ null value will trigger an automatically generated signature Id.
+ null, the hash algorithm of the main entry
+ null the signature will be limited to XAdES-T only.
+ null the signature will be limited to XAdES-T only.
+ null, defaults to {@link #getDigestAlgo()}
+ 1.3.6.1.4.1.13762.3
+ null the claimed role element is omitted.
+ Defaults to null
+ null the claimed role element is omitted.
+ idSignedProperties
+ null defaults to idSignedProperties
+ true
+ EXCLUSIVE
+ @see javax.xml.Crypto.dsig.CanonicalizationMethod
+ null if not specified)
+ null
+ if not specified)
+ URIReference and returns the
+ dereferenced data.
+
+ @param uriReference the URIReference
+ @param context an XMLCryptoContext that may
+ contain additional useful information for dereferencing the URI. This
+ implementation should dereference the specified
+ URIReference against the context's baseURI
+ parameter, if specified.
+ @return the dereferenced data
+ @throws NullPointerException if uriReference or
+ context are null
+ @throws URIReferenceException if an exception occurs while
+ dereferencing the specified uriReference
+ EventListener interface was registered.
+ @param evt The Event contains contextual information
+ about the event. It also contains the stopPropagation
+ and preventDefault methods which are used in
+ determining the event's flow and default action.
+ This class is the default entry point for XML signatures and can be used for + validating an existing signed office document and signing a office document.
+ +Validating a signed office document
+ ++ OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ); + SignatureConfig sic = new SignatureConfig(); + sic.setOpcPackage(pkg); + SignatureInfo si = new SignatureInfo(); + si.setSignatureConfig(sic); + boolean isValid = si.validate(); + ... ++ +
Signing an office document
+ +
+ // loading the keystore - pkcs12 is used here, but of course jks & co are also valid
+ // the keystore needs to contain a private key and it's certificate having a
+ // 'digitalSignature' key usage
+ char password[] = "test".toCharArray();
+ File file = new File("test.pfx");
+ KeyStore keystore = KeyStore.getInstance("PKCS12");
+ FileInputStream fis = new FileInputStream(file);
+ keystore.load(fis, password);
+ fis.close();
+
+ // extracting private key and certificate
+ String alias = "xyz"; // alias of the keystore entry
+ Key key = keystore.getKey(alias, password);
+ X509Certificate x509 = (X509Certificate)keystore.getCertificate(alias);
+
+ // filling the SignatureConfig entries (minimum fields, more options are available ...)
+ SignatureConfig signatureConfig = new SignatureConfig();
+ signatureConfig.setKey(keyPair.getPrivate());
+ signatureConfig.setSigningCertificateChain(Collections.singletonList(x509));
+ OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ_WRITE);
+ signatureConfig.setOpcPackage(pkg);
+
+ // adding the signature document to the package
+ SignatureInfo si = new SignatureInfo();
+ si.setSignatureConfig(signatureConfig);
+ si.confirmSignature();
+ // optionally verify the generated signature
+ boolean b = si.verifySignature();
+ assert (b);
+ // write the changes back to disc
+ pkg.close();
+
+
+ Implementation notes:
+ +Although there's a XML signature implementation in the Oracle JDKs 6 and higher, + compatibility with IBM JDKs is also in focus (... but maybe not thoroughly tested ...). + Therefore we are using the Apache Santuario libs (xmlsec) instead of the built-in classes, + as the compatibility seems to be provided there.
+ +To use SignatureInfo and its sibling classes, you'll need to have the following libs + in the classpath:
++ Each POIXMLDocumentPart keeps a reference to the underlying a {@link org.apache.poi.openxml4j.opc.PackagePart}. +
+ + @author Yegor Kozlov +null for the root element.
+
+ protected void commit() {
+ PackagePart part = GetPackagePart();
+ Stream out = part.GetStream();
+ XmlObject bean = GetXmlBean(); //the "model" which holds Changes in memory
+ bean.save(out, DEFAULT_XML_OPTIONS);
+ out.close();
+ }
+ POIXMLDocumentPart
+
+ @author Yegor Kozlov
+ null if there isn't one
+
+ @return The Document Thumbnail part or null
+ thumbnail.jpeg, or null if there
+ isn't one.
+
+ @return The thumbnail filename, or null
+ null if there isn't one.
+
+ @return The thumbnail data, or null
+ thumbnail.jpg
+ @param imageData The inputstream to read the thumbnail image from
+ + A workbook may contain thousands of cells Containing string (non-numeric) data. Furthermore this data is very + likely to be repeated across many rows or columns. The goal of implementing a single string table that is shared + across the workbook is to improve performance in opening and saving the file by only Reading and writing the + repetitive information once. +
++ Consider for example a workbook summarizing information for cities within various countries. There may be a + column for the name of the country, a column for the name of each city in that country, and a column + Containing the data for each city. In this case the country name is repetitive, being duplicated in many cells. + In many cases the repetition is extensive, and a tremendous savings is realized by making use of a shared string + table when saving the workbook. When displaying text in the spreadsheet, the cell table will just contain an + index into the string table as the value of a cell, instead of the full string. +
++ The shared string table Contains all the necessary information for displaying the string: the text, formatting + properties, and phonetic properties (for East Asian languages). +
+ + @author Nick Birch + @author Yegor Kozlov +strings arrays
+
+ If the Shared String table already Contains this CT_Rst bean, its index is returned.
+ Otherwise a new entry is aded.
+
fmt in the numberFormats map if the format is not
+ already in the the number format style table.
+ Does nothing if fmt is already in number format style table.
+
+ @param fmt the number format to add to number format style table
+ @return the index of fmt in the number format style table
+ fmt
+ This may be used to override built-in number formats.
+
+ @param index the number format ID
+ @param fmt the number format code
+ sheet
+
+ @param sheet the sheet associated with this auto-size column tracker
+ @since 3.14beta1
+ columns that are already tracked are ignored by this call.
+
+ @param columns the indices of the columns to track
+ @since 3.14beta1
+ column is already tracked, this call does nothing.
+
+ @param column the index of the column to track for auto-sizing
+ @return if column is already tracked, the call does nothing and returns false
+ @since 3.14beta1
+ columns that is not tracked will be ignored by this call.
+
+ @param columns the indices of the columns to track for auto-sizing
+ @return true if one or more columns were untracked as a result of this call
+ @since 3.14beta1
+ column is not tracked, it will be ignored by this call.
+
+ @param column the index of the column to track for auto-sizing
+ @return true if column was tracked prior this call, false if no action was taken
+ @since 3.14beta1
+ .gz
+
+ @return temp file to write sheet data
+ SXSSFRow objects. Two rows are equal if they belong to the same worksheet and
+ their row indexes are equal.
+
+ @param other the SXSSFRow to be compared.
+ @return 0 if the row number of this SXSSFRow is
+ equal to the row number of the argument SXSSFRow
+ 0 if the row number of this this SXSSFRow is
+ numerically less than the row number of the argument SXSSFRow
+ 0 if the row number of this this SXSSFRow is
+ numerically greater than the row number of the argument SXSSFRow
+ + This process can be relatively slow on large sheets, so this should + normally only be called once per column, at the end of your + processing. +
+ You can specify whether the content of merged cells should be considered or ignored. + Default is to ignore merged cells. + ++ Special note about SXSSF implementation: You must register the columns you wish to track with + the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}. + This is needed because the rows needed to compute the column width may have fallen outside the + random access window and been flushed to disk. + Tracking columns is required even if all rows are in the random access window. +
+New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.
+ + @param column the column index to auto-size ++ This process can be relatively slow on large sheets, so this should + normally only be called once per column, at the end of your + processing. +
+ You can specify whether the content of merged cells should be considered or ignored. + Default is to ignore merged cells. + ++ Special note about SXSSF implementation: You must register the columns you wish to track with + the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}. + This is needed because the rows needed to compute the column width may have fallen outside the + random access window and been flushed to disk. + Tracking columns is required even if all rows are in the random access window. +
+New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.
+ + @param column the column index to auto-size + @param useMergedCells whether to use the contents of merged cells when calculating the width of the column +null if not found+ groupRows requires all rows in the group to be in the current window. + This is not always practical. Instead use setRowOutlineLevel to + explicitly set the group level. Level 1 is the top level group, + followed by 2, etc. It is up to the user to ensure that level 2 + groups are correctly nested under level 1, etc. +
+ + @param rownum index of row to update (0-based) + @param level outline level (greater than 0) +column is already tracked, this call does nothing.
+
+ @param column the column to track for autosizing
+ @since 3.14beta1
+ @see #trackColumnsForAutoSizing(Collection)
+ @see #trackAllColumnsForAutoSizing()
+ columns that are already tracked are ignored by this call.
+
+ @param columns the columns to track for autosizing
+ @since 3.14beta1
+ column is not tracked, it will be ignored by this call.
+
+ @param column the index of the column to track for auto-sizing
+ @return true if column was tracked prior to this call, false if no action was taken
+ @since 3.14beta1
+ @see #untrackColumnsForAutoSizing(Collection)
+ @see #untrackAllColumnsForAutoSizing(int)
+ columns that is not tracked will be ignored by this call.
+
+ @param columns the indices of the columns to track for auto-sizing
+ @return true if one or more columns were untracked as a result of this call
+
+ @param columns the columns to track for autosizing
+ @since 3.14beta1
+ + When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. ++ There are three use-cases to use SXSSFWorkbook(XSSFWorkbook) : +
+ When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. ++ When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. + @param compressTmpFiles whether to use gzip compression for temporary files ++ When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param workbook the template workbook + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. + @param compressTmpFiles whether to use gzip compression for temporary files + @param useSharedStringsTable whether to use a shared strings table +
+ SXSSF writes sheet data in temporary files (a temp file per-sheet)
+ and the size of these temp files can grow to to a very large size,
+ e.g. for a 20 MB csv data the size of the temp xml file become few GB large.
+ If the "compress" flag is set to true then the temporary XML is gzipped.
+
+ Please note the the "compress" option may cause performance penalty. +
+ @param compress whether to compress temp files +null
+ + The idea is to parse every formula and render it back to string + with the updated sheet name. This is done by parsing into Ptgs, + looking for ones with sheet references in them, and changing those +
+ + @param sheetIndex the 0-based index of the sheet being changed + @param oldName the old sheet name + @param newName the new sheet name +null if the formula wasn't modified
+ + Autofit specifies that a shape should be auto-fit to fully contain the text described within it. + Auto-fitting is when text within a shape is scaled in order to contain all the text inside +
++ Example: Consider the situation where a user is building a diagram and needs + to have the text for each shape that they are using stay within the bounds of the shape. + An easy way this might be done is by using NORMAL autofit +
++ Example: Consider the situation where a user is building a diagram and needs to have + the text for each shape that they are using stay within the bounds of the shape. + An easy way this might be done is by using SHAPE autofit +
++ Cells can be numeric, formula-based or string-based (text). The cell type + specifies this. String cells cannot conatin numbers and numeric cells cannot + contain strings (at least according to our model). Client apps should do the + conversions themselves. Formula cells have the formula string, as well as + the formula result, which can be numeric or string. +
++ Cells should have their number (0 based) before being Added to a row. Only + cells that have values should be Added. +
++ For strings, numbers, and errors, we throw an exception. For blank cells we return a false. +
+ @return the value of the cell as a bool + @throws InvalidOperationException if the cell type returned by {@link #CellType} + is not CellType.Boolean, CellType.Blank or CellType.Formula ++ For strings we throw an exception. For blank cells we return a 0. + For formulas or error cells we return the precalculated value; +
+ @return the value of the cell as a number + @throws InvalidOperationException if the cell type returned by {@link #CellType} is CellType.String + @exception NumberFormatException if the cell value isn't a parsabledouble.
+ @see DataFormatter for turning this number into a string similar to that which Excel would render this number as.
+ + For numeric cells we throw an exception. For blank cells we return an empty string. + For formulaCells that are not string Formulas, we throw an exception +
+ @return the value of the cell as a string ++ For numeric cells we throw an exception. For blank cells we return an empty string. + For formula cells we return the pre-calculated value if a string, otherwise an exception +
+ @return the value of the cell as a XSSFRichTextString +SUM(C4:E4)
+ + Note, this method only Sets the formula string and does not calculate the formula value. + To Set the precalculated value use {@link #setCellValue(double)} or {@link #setCellValue(String)} +
+ + @param formula the formula to Set, e.g."SUM(C4:E4)".
+ If the argument is null then the current formula is Removed.
+ @throws NPOI.ss.formula.FormulaParseException if the formula has incorrect syntax or is otherwise invalid
+ @throws InvalidOperationException if the operation is not allowed, for example,
+ when the cell is a part of a multi-cell array formula
+ + If the cell Contains a string, then this value is an index into + the shared string table, pointing to the actual string value. Otherwise, + the value of the cell is expressed directly in this element. Cells Containing formulas express + the last calculated result of the formula in this element. +
+ + @return the raw cell value as Contained in the underlying CT_Cell bean, +null for blank cells.
+ -1 means no xf.
+ @param stylesSource Styles Source to work off
+ null if not Set
+ + Note - many cells are actually Filled with a foreground + Fill, not a background fill - see {@link #getFillForegroundColor()} +
+ @see NPOI.xssf.usermodel.XSSFColor#getRgb() + @return XSSFColor - fill color ornull if not Set
+ + Many cells are Filled with this, instead of a + background color ({@link #getFillBackgroundColor()}) +
+ @see IndexedColors + @return fill color, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC} +null if not Set
+ @see NPOI.ss.usermodel.IndexedColors
+ [degrees below horizon] = 90 - textRotation.
+ application/vnd.Openxmlformats-officedocument.Drawingml.chart+xml
+ @param rel the namespace relationship holding this chart,
+ the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/chart
+ + Chart sheet is a special kind of Sheet that Contains only chart and no data. +
+ + @author Yegor Kozlov ++ If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final + ctColor applied. +
++ The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and + 1.0 means 100% lighten. Also, 0.0 means no Change. +
++ In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where + HLSMAX is currently 255. +
+ Here are some examples of how to apply tint to ctColor: +++ + @return the tint value ++ If (tint < 0) + Lum' = Lum * (1.0 + tint) + + For example: Lum = 200; tint = -0.5; Darken 50% + Lum' = 200 * (0.5) => 100 + For example: Lum = 200; tint = -1.0; Darken 100% (make black) + Lum' = 200 * (1.0-1.0) => 0 + If (tint > 0) + Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint)) + For example: Lum = 100; tint = 0.75; Lighten 75% + + Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75)) + = 100 * .25 + (255 - 255 * .25) + = 25 + (255 - 63) = 25 + 192 = 217 + For example: Lum = 100; tint = 1.0; Lighten 100% (make white) + Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1)) + = 100 * 0 + (255 - 255 * 0) + = 0 + (255 - 0) = 255 ++
null
+ null.
+ null otherwise
+ null.
+ null otherwise
+ null.
+ null otherwise
+ + MUST be a constant from {@link NPOI.ss.usermodel.ComparisonOperator} +
+ + @return the conditional format operator ++ If the condition type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}, + this field is the first operand of the comparison. + If type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}, this formula is used + to determine if the conditional formatting is applied. +
++ If comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function +
+ + @return the first formula +fmt
+ This may be used to override built-in number formats.
+
+ @param index the number format ID
+ @param format the number format code
+ null
+ application/vnd.openxmlformats-officedocument.Drawing+xml
+ @param rel the namespace relationship holding this Drawing,
+ the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing
+ + Even page header value. Corresponds to even printed pages. + Even page(s) in the sheet may not be printed, for example, if the print area is specified to be + a range such that it falls outside an even page's scope. + If no even header is specified, then odd header value is assumed for even page headers. +
+ +null
+ for the (conservative) assumption that any cell may have its defInition Changed After
+ Evaluation begins.
+ @param udfFinder pass null for default (AnalysisToolPak only)
+
+ Defined names are descriptive text that is used to represents a cell, range of cells, formula, or constant value.
+ Use easy-to-understand names, such as Products, to refer to hard to understand ranges, such as Sales!C20:C30.
+
+ + @author Nick Burch + @author Yegor Kozlov ++ XSSFWorkbook wb = new XSSFWorkbook(); + XSSFSheet sh = wb.CreateSheet("Sheet1"); + + //applies to the entire workbook + XSSFName name1 = wb.CreateName(); + name1.SetNameName("FMLA"); + name1.SetRefersToFormula("Sheet1!$B$3"); + + //applies to Sheet1 + XSSFName name2 = wb.CreateName(); + name2.SetNameName("SheetLevelName"); + name2.SetComment("This name is scoped to Sheet1"); + name2.SetLocalSheetId(0); + name2.SetRefersToFormula("Sheet1!$B$3"); + +
true indicates the name refers to a function.
+ true if this name refers to a user-defined function
+ true if the argument is XSSFName and the
+ underlying CTDefinedName bean Equals to the CTDefinedName representing this name
+
+ @param o the object to compare this XSSFName against.
+ @return true if the XSSFName are Equal;
+ false otherwise.
+ + Please note, that this method works correctly only for workbooks + with the default font size (Calibri 11pt for .xlsx). + If the default font is Changed the resized image can be streched vertically or horizontally. +
++ Please note, that this method works correctly only for workbooks + with the default font size (Calibri 11pt for .xlsx). + If the default font is changed the resized image can be streched vertically or horizontally. +
+
+ resize(1.0,1.0) keeps the original size,
+ resize(0.5,0.5) resize to 50% of the original,
+ resize(2.0,2.0) resizes to 200% of the original.
+ resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE}) resizes to the dimension of the embedded image.
+
http://schemas.openxmlformats.org/officeDocument/2006/relationships/image
+ @return registered POIXMLRelation or null if not found
+ + Most strings in a workbook have formatting applied at the cell level, that is, the entire string in the cell has the + same formatting applied. In these cases, the formatting for the cell is stored in the styles part, + and the string for the cell can be shared across the workbook. The following code illustrates the example. +
+ +
+
+ cell1.SetCellValue(new XSSFRichTextString("Apache POI"));
+ cell2.SetCellValue(new XSSFRichTextString("Apache POI"));
+ cell3.SetCellValue(new XSSFRichTextString("Apache POI"));
+
+
+ In the above example all three cells will use the same string cached on workbook level.
+
+ + Some strings in the workbook may have formatting applied at a level that is more granular than the cell level. + For instance, specific characters within the string may be bolded, have coloring, italicizing, etc. + In these cases, the formatting is stored along with the text in the string table, and is treated as + a unique entry in the workbook. The following xml and code snippet illustrate this. +
+ +
+
+ XSSFRichTextString s1 = new XSSFRichTextString("Apache POI");
+ s1.ApplyFont(boldArial);
+ cell1.SetCellValue(s1);
+
+ XSSFRichTextString s2 = new XSSFRichTextString("Apache POI");
+ s2.ApplyFont(italicCourier);
+ cell2.SetCellValue(s2);
+
+
+
+
+ @author Yegor Kozlov
+ null if no formatting is required
+
+ Example: The Unicode character 0D is invalid in an XML 1.0 document,
+ so it shall be escaped as _x000D_.
+
+ for(Cell cell : row){
+ ...
+ }
+ XSSFRow objects. Two rows are equal if they belong to the same worksheet and
+ their row indexes are equal.
+
+ @param row the XSSFRow to be compared.
+ @return 0 if the row number of this XSSFRow is
+ equal to the row number of the argument XSSFRow
+ 0 if the row number of this this XSSFRow is
+ numerically less than the row number of the argument XSSFRow
+ 0 if the row number of this this XSSFRow is
+ numerically greater than the row number of the argument XSSFRow
+
+ short minColIx = row.GetFirstCellNum();
+ short maxColIx = row.GetLastCellNum();
+ for(short colIx=minColIx; colIx<maxColIx; colIx++) {
+ XSSFCell cell = row.GetCell(colIx);
+ if(cell == null) {
+ continue;
+ }
+ //... do something with cell
+ }
+
+
+ @return short representing the last logical cell in the row PLUS ONE,
+ or -1 if the row does not contain any cells.
+ + Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work. + The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can + contain text, numbers, dates, and formulas. Cells can also be formatted. +
++ This process can be relatively slow on large sheets, so this should + normally only be called once per column, at the end of your + Processing. +
+ You can specify whether the content of merged cells should be considered or ignored. + Default is to ignore merged cells. + + @param column the column index + @param useMergedCells whether to use the contents of merged cells when calculating the width of the column +null if the drawing was not found and autoCreate=false
+ + If both colSplit and rowSplit are zero then the existing freeze pane is Removed +
+ + @param colSplit Horizonatal position of split. + @param rowSplit Vertical position of split. + @param leftmostColumn Left column visible in right pane. + @param topRow Top row visible in bottom pane +null if not foundnull
+ + Note, the returned value is always gerater that {@link #GetDefaultColumnWidth()} because the latter does not include margins. + Actual column width measured as the number of characters of the maximum digit width of the + numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin + pAdding (two on each side), plus 1 pixel pAdding for the gridlines. +
+ + @param columnIndex - the column to set (0-based) + @return width - the width in units of 1/256th of a character width ++ Please note, that this method works correctly only for workbooks + with the default font size (Calibri 11pt for .xlsx). +
++ Note, this value is different from {@link #GetColumnWidth(int)}. The latter is always greater and includes + 4 pixels of margin pAdding (two on each side), plus 1 pixel pAdding for the gridlines. +
+ @return column width, default value is 8 +true
+ null to remove protection
+ XSSFRow representing the rownumber or null if its not defined on the sheet
+ null
+ + When true a summary row is inserted below the detailed data being summarized and a + new outline level is established on that row. +
++ When false a summary row is inserted above the detailed data being summarized and a new outline level + is established on that row. +
+ @returntrue if row summaries appear below detail in the outline
+ + When true a summary column is inserted to the right of the detailed data being summarized + and a new outline level is established on that column. +
++ When false a summary column is inserted to the left of the detailed data being + summarized and a new outline level is established on that column. +
+ @returntrue if col summaries appear right of the detail in the outline
+ false if the column is visible
+ true if this sheet should display formulas.
+ true if this sheet displays gridlines.
+ @see #isPrintGridlines() to check if printing of gridlines is turned on or off
+ + Row heading are the row numbers to the side of the sheet +
++ Column heading are the letters or numbers that appear above the columns of the sheet +
+ + @returntrue if this sheet should display row and column headings.
+ true if there is a page break at the indicated row
+ sheet.SetColumnBreak(2); breaks the sheet into two parts
+ with columns A,B,C in the first and D,E,... in the second. Simuilar, sheet.SetRowBreak(2);
+ breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
+ and rows starting with rownum=4 in the second.
+
+ @param row the row to break, inclusive
+ true if the sheet displays Automatic Page Breaks.
+ sheet.SetColumnBreak(2); breaks the sheet into two parts
+ with columns A,B,C in the first and D,E,... in the second. Simuilar, sheet.SetRowBreak(2);
+ breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
+ and rows starting with rownum=4 in the second.
+
+ @param column the column to break, inclusive
+ + * The maximum column width for an individual cell is 255 characters. + * This value represents the number of characters that can be displayed + * in a cell that is formatted with the standard font (first font in the workbook). + *
+ * + *
+ * Character width is defined as the maximum digit width
+ * of the numbers 0, 1, 2, ... 9 as rendered
+ * using the default font (first font in the workbook).
+ *
+ * Unless you are using a very special font, the default character is '0' (zero),
+ * this is true for Arial (default font font in HSSF) and Calibri (default font in XSSF)
+ *
+ * Please note, that the width set by this method includes 4 pixels of margin pAdding (two on each side), + * plus 1 pixel pAdding for the gridlines (Section 3.3.1.12 of the OOXML spec). + * This results is a slightly less value of visible characters than passed to this method (approx. 1/2 of a character). + *
+ *+ * To compute the actual number of visible characters, + * Excel uses the following formula (Section 3.3.1.12 of the OOXML spec): + *
+ *
+ * width = TRuncate([{Number of Visible Characters} *
+ * {Maximum Digit Width} + {5 pixel pAdding}]/{Maximum Digit Width}*256)/256
+ *
+ * Using the Calibri font as an example, the maximum digit width of 11 point font size is 7 pixels (at 96 dpi).
+ * If you set a column width to be eight characters wide, e.g. SetColumnWidth(columnIndex, 8*256),
+ * then the actual value of visible characters (the value Shown in Excel) is derived from the following equation:
+ *
+ TRuncate([numChars*7+5]/7*256)/256 = 8;
+ *
+ *
+ * which gives 7.29.
+ *
+ 10 - 10% + 20 - 20% + ... + 100 - 100% + ... + 400 - 400% ++ + Current view can be Normal, Page Layout, or Page Break Preview. + + @param scale window zoom magnification + @throws ArgumentException if scale is invalid +
+ Additionally Shifts merged regions that are completely defined in these + rows (ie. merged 2 cells on a row to be Shifted).
+ @param startRow the row to start Shifting + @param endRow the row to end Shifting + @param n the number of rows to shift ++ Additionally Shifts merged regions that are completely defined in these + rows (ie. merged 2 cells on a row to be Shifted).
+ + @param startRow the row to start Shifting + @param endRow the row to end Shifting + @param n the number of rows to shift + @param copyRowHeight whether to copy the row height during the shift + @param reSetOriginalRowHeight whether to set the original row's height to the default ++ When only 1 sheet is selected and active, this value should be in synch with the activeTab value. + In case of a conflict, the Start Part Setting wins and Sets the active sheet tab. +
+ Note: multiple sheets can be selected, but only one sheet can be active at one time. + + @returntrue if this sheet is selected
+ A1.
+
+ @return the location of the active cell.
+ null if not found
+ +
CTTable.
+ Thus, {@link #updateReferences()} is inexpensive.
+
+ @since POI 3.15 beta 3
+ column.
+ The column index is relative to the left-most column in the table, 0-indexed.
+ Returns -1 if column is not a header name in table.
+
+ Column Header names are case-insensitive
+
+ Note: this function caches column names for performance. To flush the cache (because columns
+ have been moved or column headers have been changed), {@link #updateHeaders()} must be called.
+
+ @since 3.15 beta 2
+ null value means to use the text font color.
+ + Note that the closest properties object to the text is used, therefore if there is + a conflict between the text paragraph properties and the list style properties for + this level then the text paragraph properties will take precedence. +
+ Returns the level of text properties that this paragraph will follow. + + @return the text level of this paragraph (0-based). Default is 0. +null unsets the Typeface attribute from the underlying xml.
+ + The size is specified using a percentage. + Positive values indicate superscript, negative values indicate subscript. +
+ + @param baselineOffset ++ In Excel 2007 VML Drawings are used to describe properties of cell comments, + although the spec says that VML is deprecated: +
++ The VML format is a legacy format originally introduced with Office 2000 and is included and fully defined + in this Standard for backwards compatibility reasons. The DrawingML format is a newer and richer format + Created with the goal of eventually replacing any uses of VML in the Office Open XML formats. VML should be + considered a deprecated format included in Office Open XML for legacy reasons only and new applications that + need a file format for Drawings are strongly encouraged to use preferentially DrawingML +
+ ++ Warning - Excel is known to Put invalid XML into these files! + For example, >br< without being closed or escaped crops up. +
+ + See 6.4 VML - SpreadsheetML Drawing in Office Open XML Part 4 - Markup Language Reference.pdf + + @author Yegor Kozlov +application/vnd.Openxmlformats-officedocument.Drawing+xml
+ @param rel the namespace relationship holding this Drawing,
+ the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/drawing
+ null
+ Package object,
+ see http://poi.apache.org/oxml4j/.
+
+ Once you have finished working with the Workbook, you should close the package
+ by calling pkg.close, to avoid leaving file handles open.
+
+ Creating a XSSFWorkbook from a file-backed OPC Package has a lower memory
+ footprint than an InputStream backed one.
+
+ @param pkg the OpenXML4J OPC Package object.
+
+ OPCPackage pkg = OPCPackage.open(path);
+ XSSFWorkbook wb = new XSSFWorkbook(pkg);
+ // work with the wb object
+ ......
+ pkg.close(); // gracefully closes the underlying zip file
+ + Note that Excel allows sheet names up to 31 chars in length but other applications + (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars, + others - tRuncate such names to 31 character. +
++ POI's SpreadsheetAPI silently tRuncates the input argument to 31 characters. + Example: + +
+ Sheet sheet = workbook.CreateSheet("My very long sheet name which is longer than 31 chars"); // will be tRuncated
+ assert 31 == sheet.SheetName.Length;
+ assert "My very long sheet name which i" == sheet.SheetName;
+ + Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters: +
+ See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} + for a safe way to create valid names +
+ @param sheetname sheetname to set for the sheet. + @return Sheet representing the new sheet. + @throws IllegalArgumentException if the name is null or invalid + or workbook already contains a sheet with this name + @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal) +null is returned no named range could be found.null if it does not exist
+
+ XSSFWorkbook wb = new XSSFWorkbook(package);
+ for(XSSFSheet sheet : wb){
+
+ }
+ + Note that a sheet could instead be Set to be very hidden, which is different + ({@link #isSheetVeryHidden(int)}) +
+ @param sheetIx Number + @returntrue if sheet is hidden
+ + This is different from the normal hidden status + ({@link #isSheetHidden(int)}) +
+ @param sheetIx sheet index to check + @returntrue if sheet is very hidden
+
+ Calling setSheetHidden(sheetIndex, true) is equivalent to
+ setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN).
+
+ Calling setSheetHidden(sheetIndex, false) is equivalent to
+ setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE).
+
Workbook constants:
+ Workbook.SHEET_STATE_VISIBLE,
+ Workbook.SHEET_STATE_HIDDEN, or
+ Workbook.SHEET_STATE_VERY_HIDDEN.
+ @throws ArgumentException if the supplied sheet index or state is invalid
+ + The calculation chain object specifies the order in which the cells in a workbook were last calculated +
+ + @return theCalculationChain object or null if not defined
+ The external links table specifies details of named ranges etc + * that are referenced from other workbooks, along with the last seen + * values of what they point to.
+ * + *Note that Excel uses index 0 for the current workbook, so the first + * External Links in a formula would be '[1]Foo' which corresponds to + * entry 0 in this list.
+ + * @return theExternalLinksTable list, which may be empty
+ + The default instance : the built-in functions with the Excel Analysis Tool Pack. + To Set / Evaluate custom functions you need to register them as follows: + + + +
+ @return wrapped instance of UDFFinder that allows seeking functions both by index and name ++ Typically you want to force formula recalculation when you modify cell formulas or values + of a workbook previously Created by Excel. When Set to true, this flag will tell Excel + that it needs to recalculate all formulas in the workbook the next time the file is opened. +
++ Note, that recalculation updates cached formula results and, thus, modifies the workbook. + Depending on the version, Excel may prompt you with "Do you want to save the Changes in filename?" + on close. +
+ + @param value true if the application will perform a full recalculation of + workbook values when the workbook is opened + @since 3.8 ++ 9 Jan 2010 +
++ // TODO insert Javadoc here! +
+ @author epp + ++ if the border is on the left or right, no border is displayed. +
++ If the current section is not divided into columns, or the column break + occurs in the last column on the current page when displayed, then the + restart location for text shall be the next page in the document. +
+High(ish) level class for working with .docx files.
+ +This class tries to hide some of the complexity + of the underlying file format, but as it's not a + mature and stable API yet, certain parts of the + XML structure come through. You'll therefore almost + certainly need to refer to the OOXML specifications + from + http://www.ecma-international.org/publications/standards/Ecma-376.htm + at some point in your use.
++ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option any +
+ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option ReadOnly +
+ <w:settings ... > + <w:documentProtection w:edit="forms" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option forms +
+ <w:settings ... > + <w:documentProtection w:edit="comments" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option comments +
+ <w:settings ... > + <w:documentProtection w:edit="trackedChanges" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option trackedChanges +
+ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++
+ <w:settings ... > + <w:documentProtection w:edit="forms" w:enforcement="1"/> ++
+ <w:settings ... > + <w:documentProtection w:edit="comments" w:enforcement="1"/> ++
+ <w:settings ... > + <w:documentProtection w:edit="trackedChanges" w:enforcement="1"/> ++
true if revision tracking is turned on
+ A Paragraph within a Document, Table, Header etc.
+ +A paragraph has a lot of styling information, but the + actual text (possibly along with more styling) is held on + the child {@link XWPFRun}s.
++ If the line height (before any Added spacing) is larger than one or more + characters on the line, all characters will be aligned to each other as + specified by this element. +
++ If this element is omitted on a given paragraph, its value is determined + by the Setting previously Set at any level of the style hierarchy (i.e. + that previous Setting remains unChanged). If this Setting is never + specified in the style hierarchy, then the vertical alignment of all + characters on the line shall be automatically determined by the consumer. +
+ + @return the vertical alignment of this paragraph. ++ If this element is omitted on a given paragraph, + its value is determined by the Setting previously Set at any level of the + style hierarchy (i.e. that previous Setting remains unChanged). If this + Setting is never specified in the style hierarchy, then this property + shall not be applied. Since the paragraph is specified to start on a new + page, it begins page two even though it could have fit on page one. +
+ + @return bool - if page break is Set ++ If this attribute is omitted, its value shall be assumed to be zero. + Negative values are defined such that the text is Moved past the text margin, + positive values Move the text inside the text margin. +
+ + @return indentation or null if indentation is not Set ++ If this attribute is omitted, its value shall be assumed to be zero. + Negative values are defined such that the text is Moved past the text margin, + positive values Move the text inside the text margin. +
+ + @return indentation or null if indentation is not Set +
+ Note, that this call might be expensive since all the picture data is copied into a temporary byte array.
+ You can grab the picture data directly from the underlying package part as follows:
+
+
+ InputStream is1 = GetPackagePart().InputStream;
+
+
http://schemas.openxmlformats.org/officeDocument/2006/relationships/image
+ @return registered POIXMLRelation or null if not found
+ null if parent structure (paragraph > document) is not properly Set.
+
+ This formatting property is a toggle property, which specifies that its
+ behavior differs between its use within a style defInition and its use as
+ direct formatting. When used as part of a style defInition, Setting this
+ property shall toggle the current state of that property as specified up
+ to this point in the hierarchy (i.e. applied to not applied, and vice
+ versa). Setting it to false (or an equivalent) shall
+ result in the current Setting remaining unChanged. However, when used as
+ direct formatting, Setting this property to true or false shall Set the
+ absolute state of the resulting property.
+
+ If this element is not present, the default value is to leave the + formatting applied at previous level in the style hierarchy. If this + element is never applied in the style hierarchy, then bold shall not be + applied to non-complex script characters. +
+ + @param valuetrue if the bold property is applied to
+ this run
+ null if not Set
+ true if the italic property is applied
+ true if the strike property is applied
+ + This formatting property is a toggle property, which specifies that its + behavior differs between its use within a style defInition and its use as + direct formatting. When used as part of a style defInition, Setting this + property shall toggle the current state of that property as specified up + to this point in the hierarchy (i.e. applied to not applied, and vice + versa). Setting it to false (or an equivalent) shall result in the + current Setting remaining unChanged. However, when used as direct + formatting, Setting this property to true or false shall Set the absolute + state of the resulting property. +
++ If this element is not present, the default value is to leave the + formatting applied at previous level in the style hierarchy. If this + element is never applied in the style hierarchy, then strikethrough shall + not be applied to the contents of this run. +
+ + @param valuetrue if the strike property is applied to
+ this run
+ true if the double strike property is applied
+ + The behavior of this break character (the + location where text shall be restarted After this break) shall be + determined by its type values. +
+ @see BreakType ++ The behavior of this break character (the + location where text shall be restarted After this break) shall be + determined by its type (in this case is BreakType.TEXT_WRAPPING as default) and clear attribute values. +
+ @see BreakClear ++ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option any +
+ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option ReadOnly +
+ <w:settings ... > + <w:documentProtection w:edit="[passed editValue]" w:enforcement="1"/> ++
Sketch of XWPFTable class. Only table's text is being hold.
+Specifies the contents of a table present in the document. A table is a set + of paragraphs (and other block-level content) arranged in rows and columns.
++ [M2.8]: When adding a new part to a package, the package implementer + shall ensure that a content type for that part is specified in the + Content Types stream; the package implementer shall perform the steps + described in §9.1.2.3: +
+ 1. Get the extension from the part name by taking the substring to the + right of the rightmost occurrence of the dot character (.) from the + rightmost segment. +
+ 2. If a part name has no extension, a corresponding Override element + shall be added to the Content Types stream. +
+ 3. Compare the resulting extension with the values specified for the + Extension attributes of the Default elements in the Content Types stream. + The comparison shall be case-insensitive ASCII. +
+ 4. If there is a Default element with a matching Extension attribute, + then the content type of the new part shall be compared with the value of + the ContentType attribute. The comparison might be case-sensitive and + include every character regardless of the role it plays in the + content-type grammar of RFC 2616, or it might follow the grammar of RFC + 2616. +
+ a. If the content types match, no further action is required. +
+ b. If the content types do not match, a new Override element shall be + added to the Content Types stream. . +
+ 5. If there is no Default element with a matching Extension attribute, a + new Default element or Override element shall be added to the Content + Types stream. +
++ Delete a content type based on the specified part name. If the specified + part name is register with an override content type, then this content + type is remove, else the content type is remove in the default content + type list if it exists and if no part is associated with it yet. +
+ Check rule M2.4: The package implementer shall require that the Content + Types stream contain one of the following for every part in the package: + One matching Default element One matching Override element Both a + matching Default element and a matching Override element, in which case + the Override element takes precedence. +
+ @param partName + The part URI associated with the override content type to + delete. + @exception InvalidOperationException + Throws if +true if the specified content type is already
+ register, then false.
+ + Rule [M2.9]: To get the content type of a part, the package implementer + shall perform the steps described in §9.1.2.4: +
+ 1. Compare the part name with the values specified for the PartName + attribute of the Override elements. The comparison shall be + case-insensitive ASCII. +
+ 2. If there is an Override element with a matching PartName attribute, + return the value of its ContentType attribute. No further action is + required. +
+ 3. If there is no Override element with a matching PartName attribute, + then a. Get the extension from the part name by taking the substring to + the right of the rightmost occurrence of the dot character (.) from the + rightmost segment. b. Check the Default elements of the Content Types + stream, comparing the extension with the value of the Extension + attribute. The comparison shall be case-insensitive ASCII. +
+ 4. If there is a Default element with a matching Extension attribute, + return the value of its ContentType attribute. No further action is + required. +
+ 5. If neither Override nor Default elements with matching attributes are + found for the specified part name, the implementation shall not map this + part name to a part. +
+ @param partName + The URI part to check. + @return The content type associated with the URI (in case of an override + content type) or the extension (in case of default content type), + elsenull.
+
+ @exception OpenXml4NetRuntimeException
+ Throws if the content type manager is not able to find the
+ content from an existing part.
+ true.
+ null.
+ null.
+ null, skip the action.
+ @see #RemovePart(PackagePartName)
+ + A typical scneario to call this method is to rename a template file to the main format, e.g. + ".dotx" to ".docx" + ".dotm" to ".docm" + ".xltx" to ".xlsx" + ".xltm" to ".xlsm" + ".potx" to ".pptx" + ".potm" to ".pptm" +
+ For example, a code converting a .xlsm macro workbook to .xlsx would look as follows: ++
+
+ OPCPackage pkg = OPCPackage.open(new FileInputStream("macro-workbook.xlsm"));
+ pkg.replaceContentType(
+ "application/vnd.ms-excel.sheet.macroEnabled.main+xml",
+ "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml");
+
+ FileOutputStream out = new FileOutputStream("workbook.xlsx");
+ pkg.save(out);
+ out.close();
+
+ + Check rule M1.25: The Relationships part shall not have relationships to + any other part. Package implementers shall enforce this requirement upon + the attempt to create such a relationship and shall treat any such + relationship as invalid. +
+ @param targetPartName + Name of the target part. This one must be relative to the + source root directory of the part. + @param targetMode + Mode [Internal|External]. + @param relationshipType + Type of relationship. + @param id + Relationship unique id. + @return The newly created and added relationship + + @throws InvalidFormatException + If the URI point to a relationship part URI. + @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddRelationship(org.apache.poi.OpenXml4Net.opc.PackagePartName, + org.apache.poi.OpenXml4Net.opc.TargetMode, java.lang.String, java.lang.String) ++ Check rule M1.25: The Relationships part shall not have relationships to + any other part. Package implementers shall enforce this requirement upon + the attempt to create such a relationship and shall treat any such + relationship as invalid. +
+ @param targetURI + URI of the target part. Must be relative to the source root + directory of the part. + @param targetMode + Mode [Internal|External]. + @param relationshipType + Type of relationship. + @param id + Relationship unique id. + @return The newly created and added relationship + + @throws InvalidFormatException + If the URI point to a relationship part URI. + @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddRelationship(org.apache.poi.OpenXml4Net.opc.PackagePartName, + org.apache.poi.OpenXml4Net.opc.TargetMode, java.lang.String, java.lang.String) +null.
+ true except for
+ special URI like '/' which is needed for internal use by
+ OpenXml4Net but is not valid.
+ @throws InvalidFormatException
+ Throw if the specified part name is not conform to Open
+ Packaging Convention specifications.
+ @see java.net.URI
+ true except for
+ special URI like '/' which is needed for internal use by
+ OpenXml4Net but is not valid.
+ @throws InvalidFormatException
+ Throw if the specified part name is not conform to Open
+ Packaging Convention specifications.
+ true if this part name respect the relationship
+ part naming convention else false.
+ true if this part name respect the relationship
+ part naming convention else false.
+
+ The standard specifies a source relations ship for the Core File Properties part as follows:
+ http://schemas.openxmlformats.org/officedocument/2006/relationships/metadata/core-properties.
+
+ Office uses the following source relationship for the Core File Properties part:
+ http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties.
+
null.
+ null.
+ null.
+ @throws InvalidFormatException
+ Throws if the specified Uri is not OPC compliant.
+ null.
+ @throws InvalidFormatException
+ Throws if the specified part name is not OPC compliant.
+ @see #CreatePartName(Uri)
+ null.
+ @throws InvalidFormatException
+ Throws if the specified part name is not OPC compliant.
+ @see #CreatePartName(Uri)
+ null.
+ @throws InvalidFormatException
+ Throws if the specified part name is not OPC compliant.
+ @see #CreatePartName(Uri)
+ Namespace URI to use to represent that there is no Namespace.
+ +Defined by the Namespace specification to be "".
+ + @see + Namespaces in XML, 5.2 Namespace Defaulting +Prefix to use to represent the default XML Namespace.
+ +Defined by the XML specification to be "".
+ + @see + Namespaces in XML, 3. Qualified Names +The official XML Namespace name URI.
+ +Defined by the XML specification to be + "{@code http://www.w3.org/XML/1998/namespace}".
+ + @see + Namespaces in XML, 3. Qualified Names +The official XML attribute used for specifying XML Namespace + declarations, {@link #XMLNS_ATTRIBUTE + XMLConstants.XMLNS_ATTRIBUTE}, Namespace name URI.
+ +Defined by the XML specification to be + "{@code http://www.w3.org/2000/xmlns/}".
+ + @see + Namespaces in XML, 3. Qualified Names + @see + Namespaces in XML Errata +The official XML attribute used for specifying XML Namespace + declarations.
+ +It is NOT valid to use as a + prefix. Defined by the XML specification to be + "{@code xmlns}".
+ + @see + Namespaces in XML, 3. Qualified Names +W3C XML Schema Instance Namespace URI.
+ +Defined to be "{@code http://www.w3.org/2001/XMLSchema-instance}".
+ + @see + XML Schema Part 1: + Structures, 2.6 Schema-Related Markup in Documents Being Validated +W3C XPath Datatype Namespace URI.
+ +Defined to be "{@code http://www.w3.org/2003/11/xpath-datatypes}".
+ + @see XQuery 1.0 and XPath 2.0 Data Model +RELAX NG Namespace URI.
+ +Defined to be "{@code http://relaxng.org/ns/structure/1.0}".
+ + @see RELAX NG Specification +Returns the character count including whitespace, or 0 if the + {@link DocumentSummaryInformation} does not contain this char count.
+ This is the whitespace-including version of {@link SummaryInformation#getCharCount()} + + @return The character count ornull
+ Get if the User Defined Property Set has been updated outside of the + Application.
+If it has (true), the hyperlinks should be updated on document load.
+Gets the version of the Application which wrote the + Property set, stored with the two high order bytes having the major + version number, and the two low order bytes the minor version number.
+This will be 0 if no version is set.
+Returns the VBA digital signature for the VBA project
+ embedded in the document (or null).
Gets the content type of the file (or null).
Gets the content status of the file (or null).
Gets the document language, which is normally unset and empty
+ (or null).
Gets the document version as a string, which is normally unset and empty
+ (or null).
Creates the most specific {@link PropertySet} from an entry + in the specified POIFS Directory. This is preferrably a {@link + DocumentSummaryInformation} or a {@link SummaryInformation}. If + the specified entry does not contain a property Set stream, an + exception is thrown. If no entry is found with the given name, + an exception is thrown.
+ + @param dir The directory to find the PropertySet in + @param name The name of the entry Containing the PropertySet + @return The Created {@link PropertySet}. + @if there is no entry with that name + @if the stream does not + contain a property Set. + @if some I/O problem occurs. + @exception EncoderFallbackException if the specified codepage is not + supported. +To process this data, you may wish to make use of the + {@link Thumbnail} class. The raw data is generally + an image in WMF or Clipboard (BMP?) format
+typedef struct tagCLIPDATA {
+ // cbSize is the size of the buffer pointed To
+ // by pClipData, plus sizeof(ulClipFmt)
+ ULONG cbSize;
+ long ulClipFmt;
+ BYTE* pClipData;
+ } CLIPDATA;
+
+ See
+ msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp.
+ Turns a codepage number into the equivalent character encoding's + name.
+ + @param codepage The codepage number + + @return The character encoding's name. If the codepage number is 65001, + the encoding name is "UTF-8". All other positive numbers are mapped to + "cp" followed by the number, e.g. if the codepage number is 1252 the + returned character encoding name will be "cp1252". + + @exception UnsupportedEncodingException if the specified codepage is + less than zero. +| Value | +Description | +
|---|---|
| 0 | +No restriction | +
| 2 | +Read-only recommended | +
| 4 | +Read-only enforced | +
The highest well-known property ID. Applications are free to use + higher values for custom purposes. (This value is based on Office 12, + earlier versions of Office had lower values)
++ Returns much (but not all) of the textual content of the file, + suitable for indexing by something like Apache Lucene, or used + by Apache Tika, but not really intended for display to the user. +
+null to remove all protection
+ shouldProtectObjects are protected
+ shouldProtectScenarios are protected
+ null
+ null
+ null if the formula cell is not shared/array/table,
+ or if the specified formula is not the the first in the group.
+ null.
+ null.
+ null
+ null
+ @return encoded size of the formula tokens (does not include 2 bytes for ushort length)
+ DConRef Structure
+ [MS-XLS s.
+ 2.4.86], and the contained DConFile structure
+
+ [MS-XLS s. 2.5.69]. This in turn contains a XLUnicodeStringNoCch
+
+ [MS-XLS s. 2.5.296].
+
+ + _______________________________ + | DConRef | + (bytes) +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+ + | ref |cch| stFile | un| + +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+ + | + _________|_____________________ + |DConFile / XLUnicodeStringNoCch| + +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+ + (bits) |h| reserved | rgb | + +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+ ++ Where +
DConFile.h = 0x00 if the characters inrgb are single byte, and
+ DConFile.h = 0x01 if they are double byte. DConRef.un = 2. Otherwise it is 1.DConFile.rgb = (2 * DConRef.cch). Otherwise it is equal to
+ DConRef.cchDConRef.rgb starts with 0x01 if it is an external reference,
+ and with 0x02 if it is a self-reference.sid = {@value}
+ rgb field of a
+ XLUnicodeStringNoCch. Therefore it will contain at least one leading special
+ character (0x01 or 0x02) and probably other ones.
+ @see
+ DConFile [MS-XLS s. 2.5.77] and
+
+ VirtualPath [MS-XLS s. 2.5.69]
+
+ FtPioGrbitSubRecord and
+ fill its data with the default values
+ FtPioGrbitSubRecord and
+ fill its data with the default values
+ null
+ + Most records construct themselves from {@link RecordInputStream}. + This class assumes that a {@link ContinueRecord} record break always occurs at the type boundary, + however, it is not always so. +
+ Two attachments to Bugzilla 50779 + demonstrate that a CONTINUE break can appear right in between two bytes of a unicode character + or between two bytes of ashort. The problematic portion of the data is
+ in a Asian Phonetic Settings Block (ExtRst) of a UnicodeString.
+
+ {@link RecordInputStream} greedily requests the bytes to be read and stumbles on such files with a
+ "Not enough data (1) to read requested (2) bytes" exception. The ContinuableRecordInput
+ class circumvents this "type boundary" rule and Reads data byte-by-byte rolling over CONTINUE if necessary.
+
+ YK: For now (March 2011) this class is only used to read + @link NPOI.HSSF.Record.Common.UnicodeString.ExtRst} blocks of a UnicodeString. + +
+ + @author Yegor Kozlov +| Mask | Description |
|---|---|
| 0x01 | is16bitEncoded |
| 0x04 | hasExtendedData |
| 0x08 | isRichText |
FtCblsSubRecord and
+ fill its data with the default values
+ true, this record represents an error cell value, otherwise this record represents a boolean cell value
+ Description: the default characterset. for the workbook
+REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
+Use {@link CodePageUtil} to turn these values into Java code pages + to encode/decode strings.
+ @version 2.0-pre +null if it is currently unSet.
+ true if drop down arrow should be suppressed when list validation is
+ used, false otherwise
+ + If the type of the SupBook record is same-sheet referencing, Add-In referencing, + DDE data source referencing, or OLE data source referencing, + then no scope is specified and this value MUST be -2. Otherwise, + the scope must be set as follows: +
-2 Workbook-level reference that applies to the entire workbook.-1 Sheet-level reference. >=0 Sheet-level reference. This specifies the first sheet in the reference.
+ + If the SupBook type is unused or external workbook referencing, + then this value specifies the zero-based index of an external sheet name, + see {@link org.apache.poi.hssf.record.SupBookRecord#getSheetNames()}. + This referenced string specifies the name of the first sheet within the external workbook that is in scope. + This sheet MUST be a worksheet or macro sheet. +
++ If the supporting link type is self-referencing, then this value specifies the zero-based index of a + {@link org.apache.poi.hssf.record.BoundSheetRecord} record in the workbook stream that specifies + the first sheet within the scope of this reference. This sheet MUST be a worksheet or a macro sheet. +
+null if the specified record is not interpreted by POI.
+ null
+ if stream was empty
+ null if not present.
+ null if
+ this pass didn't return a record that's
+ suitable for returning (eg was a continue record).
+ null if unknown to POI
+ null if textExpr does not begin with '='
+ null if numberStr is null
+ null if timeStr is null
+ null for default YYYYMMDD
+ @return null if timeStr is null
+ null
+ +
+ One important concept worth considering Is that of font size. One of the + difficulties in Converting Graphics calls into escher Drawing calls Is that + Excel does not have the concept of absolute pixel positions. It measures + it's cell widths in 'Chars' and the cell heights in points. + Unfortunately it's not defined exactly what a type of Char it's + measuring. Presumably this Is due to the fact that the Excel will be + using different fonts on different platforms or even within the same + platform. + + Because of this constraint we've had to calculate the + verticalPointsPerPixel. This the amount the font should be scaled by when + you Issue commands such as DrawString(). A good way to calculate this + Is to use the follow formula: + ++ + @author Glen Stampoultzis (glens at apache.org) ++ multipler = GroupHeightInPoints / heightOfGroup ++ + The height of the Group Is calculated fairly simply by calculating the + difference between the y coordinates of the bounding box of the shape. The + height of the Group can be calculated by using a convenience called +HSSFClientAnchor.GetAnchorHeightInPoints() . +
0 means Context (Default), 1 means Left To Right, + and 2 means Right to Left
+ + @return order - the reading order (0,1,2) +s.
+ null otherwise
+ null otherwise
+ null otherwise
+ null
+ for the (conservative) assumption that any cell may have its definition changed after
+ evaluation begins.
+ null for default (AnalysisToolPak only)
+ null
+ for the (conservative) assumption that any cell may have its definition changed after
+ evaluation begins.
+ @param udfFinder pass null for default (AnalysisToolPak only)
+ + int EvaluatedCellType = evaluator.EvaluateInCell(cell).CellType; ++ Be aware that your cell value will be Changed to hold the + result of the formula. If you simply want the formula + value computed for you, use {@link #EvaluateFormulaCell(HSSFCell)} + @param cell +
+ Please note, that this method works correctly only for workbooks + with default font size (Arial 10pt for .xls). + If the default font is changed the resized image can be streched vertically or horizontally. +
+
+ resize(1.0,1.0) keeps the original size,
+ resize(0.5,0.5) resize to 50% of the original,
+ resize(2.0,2.0) resizes to 200% of the original.
+ resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE}) resizes to the dimension of the embedded image.
+
null to remove protection
+ + 10 - 10% + 20 - 20% + ... + 100 - 100% + ... + 400 - 400% ++ + @param scale window zoom magnification + @throws IllegalArgumentException if scale is invalid +
indexes.
+
+ @param indexes
+ Title: HSSFCellRangeAddress
+Description: + Implementation of the cell range Address lists,like Is described in + OpenOffice.org's Excel Documentation . + In BIFF8 there Is a common way to store absolute cell range Address + lists in several records (not formulas). A cell range Address list + consists of a field with the number of ranges and the list of the range + Addresses. Each cell range Address (called an AddR structure) Contains + 4 16-bit-values.
+Copyright: Copyright (c) 2004
+Company:
+ @author Dragos Buleandra (dragos.buleandra@trade2b.ro) + @version 2.0-pre +-1 means that
+ the scope of the name will be ignored and the parser will match named ranges only by name
+
+ @return the parsed formula tokens
+ null, typically empty array
+ null if there isn't one for the given name.
+ 2.3.4.7 ECMA-376 Document Encryption Key Generation (Standard Encryption)
+ 2.3.4.11 Encryption Key Generation (Agile Encryption)
The encryption key for ECMA-376 document encryption [ECMA-376] using agile + encryption MUST be generated by using the following method, which is derived from PKCS #5: + Password-Based Cryptography Version 2.0 [RFC2898].
+ +Let H() be a hashing algorithm as determined by the PasswordKeyEncryptor.hashAlgorithm + element, H_n be the hash data of the n-th iteration, and a plus sign (+) represent concatenation. + The password MUST be provided as an array of Unicode characters. Limitations on the length of the + password and the characters used by the password are implementation-dependent. + The initial password hash is generated as follows:
+ + +H_0 = H(salt + password)+ +
The salt used MUST be generated randomly. The salt MUST be stored in the + PasswordKeyEncryptor.saltValue element contained within the \EncryptionInfo stream as + specified in section 2.3.4.10. The hash is then iterated by using the following approach:
+ +H_n = H(iterator + H_n-1)+ +
where iterator is an unsigned 32-bit value that is initially set to 0x00000000 and then incremented + monotonically on each iteration until PasswordKey.spinCount iterations have been performed. + The value of iterator on the last iteration MUST be one less than PasswordKey.spinCount.
+ +For POI, H_final will be calculated by {@link #generateKey(byte[],HashAlgorithm,byte[],int)}
+ + @param password + @param hashAlgorithm + @param salt + @param spinCount + @return the hashed password +2.3.4.12 Initialization Vector Generation (Agile Encryption)
+ +Initialization vectors are used in all cases for agile encryption. An initialization vector MUST be + generated by using the following method, where H() is a hash function that MUST be the same as + specified in section 2.3.4.11 and a plus sign (+) represents concatenation:
+2.3.4.11 Encryption Key Generation (Agile Encryption)
+ +The final hash data that is used for an encryption key is then generated by using the following + method:
+ +H_final = H(H_n + blockKey)+ +
where blockKey represents an array of bytes used to prevent two different blocks from encrypting + to the same cipher text.
+ +If the size of the resulting H_final is smaller than that of PasswordKeyEncryptor.keyBits, the key + MUST be padded by appending bytes with a value of 0x36. If the hash value is larger in size than + PasswordKeyEncryptor.keyBits, the key is obtained by truncating the hash value.
+ + @param passwordHash + @param hashAlgorithm + @param blockKey + @param keySize + @return intermediate key ++ Use {@link #getLength()} to Get the size of that data that can be safely read from the stream. + Just Reading to the end of the input stream is not sufficient because there are + normally pAdding bytes that must be discarded +
+ + @param dir the node to read from + @return decrypted stream ++ The length variable is Initialized in {@link #getDataStream(NPOI.POIFS.FileSystem.DirectoryNode)}, + an attempt to call GetLength() prior to GetDataStream() will result in InvalidOperationException. +
+ + @return length of the encrypted data + @throws InvalidOperationException if {@link #getDataStream(NPOI.POIFS.FileSystem.DirectoryNode)} + was not called +true always
+ Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream. The File will be opened read-only
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ + @param file the File from which to read the data + + @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream.
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ + @param file the File from which to read or read/write the data + @param readOnly whether the POIFileSystem will only be used in read-only mode + + @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from an open FileChannel. This uses + * less memory than creating from an InputStream. The stream will + * be used in read-only mode.
+ * + *Note that with this constructor, you will need to call {@link #close()} + * when you're done to have the underlying Channel closed, as the channel is + * kept open during normal operation to read the data out.
+ * + * @param channel the FileChannel from which to read the data + * + * @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from an open FileChannel. This uses + less memory than creating from an InputStream.
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying Channel closed, as the channel is + kept open during normal operation to read the data out.
+ + @param channel the FileChannel from which to read or read/write the data + @param readOnly whether the POIFileSystem will only be used in read-only mode + + @exception IOException on errors reading, or on invalid data +true
+ for markSupported()). In the unlikely case that the caller has such a stream
+ and needs to use it After this constructor completes, a work around is to wrap the
+ stream in order to trap the close() call. A convenience method (
+ CreateNonClosingInputStream()) has been provided for this purpose:
+ + InputStream wrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is); + HSSFWorkbook wb = new HSSFWorkbook(wrappedStream); + is.Reset(); + doSomethingElse(is); ++ Note also the special case of MemoryStream for which the close() + method does nothing. +
+ MemoryStream bais = ... + HSSFWorkbook wb = new HSSFWorkbook(bais); // calls bais.Close() ! + bais.Reset(); // no problem + doSomethingElse(bais); ++ + @param stream the InputStream from which to read the data + + @exception IOException on errors Reading, or on invalid data +
false if an exception is currently being thrown in the calling method
+ null.
+
+ @return the dataSize
+ null
+ if no data was embedded. Note that an embedding may provide information about
+ the data, but the actual data is not included. (So label, filename etc. are
+ available, but this method returns null.)
+
+ @return the dataBuffer
+ Returns the last name in the document path's name sequence. + If the document path's name sequence is empty, then the empty string is returned.
+ + @since 2016-04-09 + @return The last name in the document path's name sequence, or empty string if this is the root path +Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream.
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ @param readOnly whether the POIFileSystem will only be used in read-only mode + + @param file the File from which to read the data + + @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream. The File will be opened read-only
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ + @param file the File from which to read the data + + @exception IOException on errors reading, or on invalid data +A class describing attributes of the Big Block Size
+read() method if
+ the current position is less than the limit.
+ Creates a {@link ClassID} from a human-readable representation of the Class ID in standard
+ format "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}".
The value returned by this method is equal to the value that would + be returned by Arrays.asList(a).toString(), unless a + is null, in which case "null" is returned.
+ + @param a the array whose string representation to return + @return a string representation of a + @see #deepToString(Object[]) + @since 1.5 +Provides constants for understanding numeric codepages, + along with utilities to translate these into Java Character Sets.
+Codepage 037, a special case
+Codepage for SJIS
+Codepage for GBK, aka MS936
+Codepage for MS949
+Codepage for UTF-16
+Codepage for UTF-16 big-endian
+Codepage for Windows 1250
+Codepage for Windows 1251
+Codepage for Windows 1252
+Codepage for Windows 1253
+Codepage for Windows 1254
+Codepage for Windows 1255
+Codepage for Windows 1256
+Codepage for Windows 1257
+Codepage for Windows 1258
+Codepage for Johab
+Codepage for Macintosh Roman (Java: MacRoman)
+Codepage for Macintosh Japan (Java: unknown - use SJIS, cp942 or + cp943)
+Codepage for Macintosh Chinese Traditional (Java: unknown - use Big5, + MS950, or cp937)
+Codepage for Macintosh Korean (Java: unknown - use EUC_KR or + cp949)
+Codepage for Macintosh Arabic (Java: MacArabic)
+Codepage for Macintosh Hebrew (Java: MacHebrew)
+Codepage for Macintosh Greek (Java: MacGreek)
+Codepage for Macintosh Cyrillic (Java: MacCyrillic)
+Codepage for Macintosh Chinese Simplified (Java: unknown - use + EUC_CN, ISO2022_CN_GB, MS936 or cp935)
+Codepage for Macintosh Romanian (Java: MacRomania)
+Codepage for Macintosh Ukrainian (Java: MacUkraine)
+Codepage for Macintosh Thai (Java: MacThai)
+Codepage for Macintosh Central Europe (Latin-2) + (Java: MacCentralEurope)
+Codepage for Macintosh Iceland (Java: MacIceland)
+Codepage for Macintosh Turkish (Java: MacTurkish)
+Codepage for Macintosh Croatian (Java: MacCroatian)
+Codepage for US-ASCII
+Codepage for KOI8-R
+Codepage for ISO-8859-1
+Codepage for ISO-8859-2
+Codepage for ISO-8859-3
+Codepage for ISO-8859-4
+Codepage for ISO-8859-5
+Codepage for ISO-8859-6
+Codepage for ISO-8859-7
+Codepage for ISO-8859-8
+Codepage for ISO-8859-9
+Codepage for ISO-2022-JP
+Another codepage for ISO-2022-JP
+Yet another codepage for ISO-2022-JP
+Codepage for ISO-2022-KR
+Codepage for EUC-JP
+Codepage for EUC-KR
+Codepage for GB2312
+Codepage for GB18030
+Another codepage for US-ASCII
+Codepage for UTF-8
+Codepage for Unicode
+Turns a codepage number into the equivalent character encoding's + name.
+ + @param codepage The codepage number + + @return The character encoding's name. If the codepage number is 65001, + the encoding name is "UTF-8". All other positive numbers are mapped to + "cp" followed by the number, e.g. if the codepage number is 1252 the + returned character encoding name will be "cp1252". + + @exception UnsupportedEncodingException if the specified codepage is + less than zero. +bytesToDump bytes to an output stream.
+
+ @param in The stream to read from
+ @param out The output stream
+ @param start The index to use as the starting position for the left hand side label
+ @param bytesToDump The number of bytes to output. Use -1 to read until the end of file.
+ If the length of
The first byte read is stored into element
The
+read(b, 0, b.length)
This method blocks until input data is available, end of file is + detected, or an exception is thrown.
+ + If
The first byte read is stored into element
In every case, elements
The
The
Note that while some implementations of {@code InputStream} will return + the total number of bytes in the stream, many will not. It is + never correct to use the return value of this method to allocate + a buffer intended to hold all data in this stream.
+ +A subclass' implementation of this method may choose to throw an + {@link IOException} if this input stream has been closed by + invoking the {@link #close()} method.
+ +The {@code available} method for class {@code InputStream} always + returns {@code 0}.
+ +This method should be overridden by subclasses.
+ The
The
The general contract of
Marking a closed stream should not have any effect on the stream.
+ + The
The general contract of
The method
+ hashCode = 1;
+ Iterator i = list.Iterator();
+ while (i.HasNext()) {
+ Object obj = i.Next();
+ hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
+ }
+
+
+ This ensures that list1.Equals(list2) implies that
+ list1.HashCode()==list2.HashCode() for any two lists, list1 and
+ list2, as required by the general contract of Object.HashCode.
+
+ I am happy is someone wants to re-implement this without using the + internal list and hashmap. If so could you please make sure that + you can add elements half way into the list and have the value-key mappings + update
+byte.length bytes of data from this
+ input stream into an array of bytes. This method blocks until some
+ input is available.
+
+ simulate java FilterInputStream
+ len bytes of data from this input stream
+ into an array of bytes.If len is not zero, the method
+ blocks until some input is available; otherwise, no
+ bytes are read and0 is returned.
+
+ simulate java FilterInputStream
+
+ hashCode = 1;
+ Iterator i = list.Iterator();
+ while (i.HasNext()) {
+ Object obj = i.Next();
+ hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
+ }
+
+
+ This ensures that list1.Equals(list2) implies that
+ list1.HashCode()==list2.HashCode() for any two lists, list1 and
+ list2, as required by the general contract of Object.HashCode.
+ + References: +
epsilon of value, in absolute terms.
+ @param maxDenominator maximum denominator value allowed.
+ @param maxIterations maximum number of convergents
+ @throws RuntimeException if the continued fraction failed to
+ converge.
+ @throws IllegalArgumentException if value > Integer.MAX_VALUE
+ + Syntax: MAXIFS(data_range, criteria_range1, criteria1, [criteria_range2, criteria2]) +
++ Syntax: MINIFS(min_range, criteria_range1, criteria1, [criteria_range2, criteria2]) +
+true if date is weekend, false otherwise.
+ true if date is a holiday, false otherwise.
+ 1 is not a workday, 0 otherwise.
+ true if aDate is between start and end dates, false otherwise.
+ | Value | Days per Month | Days per Year |
|---|---|---|
| 0 (default) | 30 | 360 |
| 1 | actual | actual |
| 2 | actual | 360 |
| 3 | actual | 365 |
| 4 | 30 | 360 |
null signifying that the cell is not present (or blank)
+ @return null if the supplied cell is null or blank
+ + int EvaluatedCellType = Evaluator.EvaluateInCell(cell).CellType; ++ Be aware that your cell value will be Changed to hold the + result of the formula. If you simply want the formula + value computed for you, use {@link #EvaluateFormulaCellEnum(Cell)}} + @param cell + @return the {@code cell} that was passed in, allowing for chained calls +
+ int EvaluatedCellType = Evaluator.EvaluateFormulaCell(cell); ++ Be aware that your cell will hold both the formula, and the result. If you want the cell + Replaced with the result of the formula, use {@link #EvaluateInCell(NPOI.SS.UserModel.Cell)} + @param cell The cell to Evaluate + @return -1 for non-formula cells, or the type of the formula result +
+ ICellType EvaluatedCellType = Evaluator.EvaluateFormulaCellEnum(cell); ++ Be aware that your cell will hold both the formula, + and the result. If you want the cell Replaced with + the result of the formula, use {@link #Evaluate(NPOI.SS.UserModel.Cell)} } + @param cell The cell to Evaluate + @return The type of the formula result (the cell's type remains as CellType.FORMULA however) + If cell is not a formula cell, returns {@link CellType#_NONE} rather than throwing an exception. + @since POI 3.15 beta 3 +
null for default (AnalysisToolPak only)
+ null if the supplied cell is null or blank
+ null (possibly {@link BlankEval}). The specified indexes should be absolute
+ indexes in the sheet and not relative indexes within the area.
+
+ public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
+ // ...
+ Eval arg0 = args[0];
+ if(arg0 is ErrorEval) {
+ return arg0;
+ }
+ if(!(arg0 is AreaEval)) {
+ return ErrorEval.VALUE_INVALID;
+ }
+ double temp = 0;
+ AreaEval area = (AreaEval)arg0;
+ ValueEval[] values = area.LittleEndianConstants.BYTE_SIZE;
+ for (int i = 0; i < values.Length; i++) {
+ ValueEval ve = values[i];
+ if(ve is ErrorEval) {
+ return ve;
+ }
+ if(!(ve is NumericValueEval)) {
+ return ErrorEval.VALUE_INVALID;
+ }
+ temp += ((NumericValueEval)ve).NumberValue;
+ }
+ // ...
+ }
+
+ In this example, if any error is encountered while Processing the arguments, an error is
+ returned immediately. This code is difficult to refactor due to all the points where errors
+ are returned.
+ public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
+ try {
+ // ...
+ AreaEval area = GetAreaArg(args[0]);
+ double temp = sumValues(area.LittleEndianConstants.BYTE_SIZE);
+ // ...
+ } catch (EvaluationException e) {
+ return e.GetErrorEval();
+ }
+ }
+
+ private static AreaEval GetAreaArg(Eval arg0){
+ if (arg0 is ErrorEval) {
+ throw new EvaluationException((ErrorEval) arg0);
+ }
+ if (arg0 is AreaEval) {
+ return (AreaEval) arg0;
+ }
+ throw EvaluationException.InvalidValue();
+ }
+
+ private double sumValues(ValueEval[] values){
+ double temp = 0;
+ for (int i = 0; i < values.Length; i++) {
+ ValueEval ve = values[i];
+ if (ve is ErrorEval) {
+ throw new EvaluationException((ErrorEval) ve);
+ }
+ if (!(ve is NumericValueEval)) {
+ throw EvaluationException.InvalidValue();
+ }
+ temp += ((NumericValueEval) ve).NumberValue;
+ }
+ return temp;
+ }
+
+ It is not mandatory to use EvaluationException, doing so might give the following advantages:null.
+ | A | B | C | D | |
|---|---|---|---|---|
| 1 | 15 | 20 | 25 | |
| 2 | 200 | |||
| 3 | 300 | |||
| 3 | 400 |
| A | B | C | D | |
|---|---|---|---|---|
| 1 | 15 | 20 | 25 | |
| 2 | 1215 | 1220 | #VALUE! | 200 |
| 3 | 1315 | 1320 | #VALUE! | 300 |
| 4 | #VALUE! | #VALUE! | #VALUE! | 400 |
null, possibly empty string.
+
+ Syntax :
+ AverageIfs ( average_range, criteria_range1, criteria1,
+ [criteria_range2, criteria2], ...)
+
criteriaRanges argument contains the same number of rows and columns
+ as the avgRange argument
+
+ @throws EvaluationException if
+ aeAvg
+ @param predicates array of predicates, a predicate for each value in ranges
+ @param aeAvg the range to calculate
+
+ @return the computed value
+ Some utils for Converting from and to any base
+ + @author cedric dot walter @ gmail dot com ++ Syntax: COUNTIFS(criteria_range1, criteria1, [criteria_range2, criteria2]) +
+
+ Syntax:
+ ERROR.TYPE(errorValue)
+ Returns a number corresponding to the error type of the supplied argument.
++
| errorValue | Return Value |
| #NULL! | 1 |
| #DIV/0! | 2 |
| #VALUE! | 3 |
| #REF! | 4 |
| #NAME? | 5 |
| #NUM! | 6 |
| #N/A! | 7 |
| everything else | #N/A! |
double representing periodic payment amount.
+ double representing interest portion of payment.
+
+ @see #pmt(double, int, double, double, int)
+ @see #fv(double, int, double, double, int)
+ double representing principal portion of payment.
+
+ @see #pmt(double, int, double, double, int)
+ @see #ipmt(double, int, int, double, double, bool)
+ double representing future principal value.
+ Returns the modified internal rate of return for a series of periodic cash flows. MIRR considers both the cost + of the investment and the interest received on reinvestment of cash.
+ + Values is an array or a reference to cells that contain numbers. These numbers represent a series of payments (negative values) and income (positive values) occurring at regular periods. +Implementation for Excel Oct2Dec() function.
++ Converts an octal number to decimal. +
+
+ Syntax:
Oct2Dec (number )
+
Implementation for Excel QUOTIENT () function.
+
+ Syntax:
QUOTIENT(Numerator,Denominator)
+
+ Numerator is the dividend. + Denominator is the divisor. + + Returns the integer portion of a division. Use this function when you want to discard the remainder of a division. +
+ + If either enumerator/denominator is non numeric, QUOTIENT returns the #VALUE! error value. + If denominator is Equals to zero, QUOTIENT returns the #DIV/0! error value. + + @author cedric dot walter @ gmail dot com +
+
+ Syntax :
+ AVERAGEIF ( range, criteria, avg_range )
+
| range | The range over which criteria is applied. Also used for included values when the third parameter is not present |
|---|---|
| criteria | The value or expression used to filter rows from range |
| avg_range | Locates the top-left corner of the corresponding range of addends - values to be included (after being selected by the criteria) |
+ Syntax :
+ SUMIFS ( sum_range, criteria_range1, criteria1,
+ [criteria_range2, criteria2], ...)
+
criteria predicate is valid, i.e. not an error
+
+ @throws EvaluationException if there are criteria which resulted in Errors.
+ criteriaRanges argument contains the same number of rows and columns
+ as the sumRange argument
+
+ @throws EvaluationException if
+ aeSum
+ @param predicates array of predicates, a predicate for each value in ranges
+ @param aeSum the range to sum
+
+ @return the computed value
+ + If there are other subtotals within argument refs (or nested subtotals), + these nested subtotals are ignored to avoid double counting. +
+ + @see Subtotal ++ Syntax: COUNTBLANK ( range ) +
| range | is the range of cells to count blanks |
|---|
| range | is the range of cells to be Counted based on the criteria |
|---|---|
| criteria | is used to determine which cells to Count |
null if the arg evaluates to blank.
+ Calculates the number of days between two dates based on a 360-day year + (twelve 30-day months), which is used in some accounting calculations. Use + this function to help compute payments if your accounting system is based on + twelve 30-day months.
+ + {@code DAYS360(start_date,end_date,[method])} + +
+ p(1+r)^n + y(1+rt)((1+r)^n-1)/r + f=0 ...{when r!=0}
+ ny + p + f=0 ...{when r=0}
+
+ null,
+ nor are any of its elements.
+ @param ec primarily used to identify the source cell Containing the formula being Evaluated.
+ may also be used to dynamically create reference evals.
+ @return never null. Possibly an instance of | reference | typically an area reference, possibly a union of areas |
|---|---|
| array | a literal array value (currently not supported) |
| row_num | selects the row within the array or area reference |
| column_num | selects column within the array or area reference. default Is 1 |
| area_num | used when reference Is a union of areas |
null if text cannot be parsed.
+ null if there is a syntax error in any escape sequence
+ (the typical syntax error is a single quote character not followed by another).
+ + Starting with the guess, the method cycles through the calculation until the result + is accurate within 0.00001 percent. If IRR can't find a result that works + after 20 tries, the Double.NaN is returned. +
++ The implementation is inspired by the NewtonSolver from the Apache Commons-Math library, + @see http://commons.apache.org +
+ + @param values the income values. + @param guess the initial guess of irr. + @return the irr value. The method returnsDouble.NaN
+ if the maximum iteration count is exceeded
+
+ @see
+ http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution
+ @see
+ http://en.wikipedia.org/wiki/Newton%27s_method
+ | Input Return | Value | Thrown Error |
|---|---|---|
| 5 | 4 | |
| 2.9 | 2 | |
| "5" | 4 | |
| "2.18e1" | 21 | |
| "-$2" | -3 | * |
| FALSE | -1 | * |
| TRUE | 0 | |
| "TRUE" | #REF! | |
| "abc" | #REF! | |
| "" | #REF! | |
| <blank> | #VALUE! |
| Value | Matching Behaviour |
|---|---|
| 1 | (default) Find the largest value that Is less than or equal to lookup_value. + The lookup_array must be in ascending order*. |
| 0 | Find the first value that Is exactly equal to lookup_value. + The lookup_array can be in any order. |
| -1 | Find the smallest value that Is greater than or equal to lookup_value. + The lookup_array must be in descending order*. |
+
+ Syntax :
+ SUBTOTAL ( functionCode, ref1, ref2 ... )
+
| functionCode | (1-11) Selects the underlying aggregate function to be used (see table below) |
| ref1, ref2 ... | Arguments to be passed to the underlying aggregate function |
| functionCode | Aggregate Function |
|---|---|
| 1 | AVERAGE |
| 2 | COUNT |
| 3 | COUNTA |
| 4 | MAX |
| 5 | MIN |
| 6 | PRODUCT |
| 7 | STDEV |
| 8 | STDEVP * |
| 9 | SUM |
| 10 | VAR * |
| 11 | VARP * |
| 101-111 | * |
+
+ Syntax :
+ SUMIF ( range, criteria, sum_range )
+
| range | The range over which criteria is applied. Also used for addend values when the third parameter is not present |
|---|---|
| criteria | The value or expression used to filter rows from range |
| sum_range | Locates the top-left corner of the corresponding range of addends - values to be added (after being selected by the criteria) |
null if there is any problem converting the text
+ Title: XSSF Area 3D Reference (Sheet + Area)
+Description: Defined an area in an external or different sheet.
+REFERENCE:
+ +This is XSSF only, as it stores the sheet / book references + in String form. The HSSF equivalent using indexes is {@link Area3DPtg}
+This is XSSF only, as it stores the sheet / book references + in String form. The HSSF equivalent using indexes is {@link NameXPtg}
+Title: XSSF 3D Reference
+Description: Defines a cell in an external or different sheet.
+REFERENCE:
+ +This is XSSF only, as it stores the sheet / book references + in String form. The HSSF equivalent using indexes is {@link Ref3DPtg}
+Title: Area 3D Ptg - 3D reference (Sheet + Area)
+Description: Defined an area in Extern Sheet.
+REFERENCE:
+ + This is HSSF only, as it matches the HSSF file format way of + referring to the sheet by an extern index. The XSSF equivalent + is {@link Area3DPxg} +For example, $E5:B$10 becomes B5:$E$10
null if the function name is unknown.
+
+ @param name Name of function.
+ @return Function executor.
+ Return will have no workbook set if it's actually in our own workbook
+Return will have no workbook set if it's actually in our own workbook
+null.
+ nulls OK.
+ @param ptgs may be null
+ @return Never null (Possibly empty if the supplied null)
+ nulls OK.
+
+ @param formula may be null
+ @return possibly null (if the supplied null)
+ null if this formula is not part of an array or shared formula.
+ -1 means that
+ * the scope of the name will be ignored and the parser will match names only by name
+ *
+ * @return array of parsed tokens
+ * @throws FormulaParseException if the formula is unparsable
+ + A$1 + $A$1 : $B1 + A1 ....... C2 + Sheet1 !$A1 + a..b!A1 + 'my sheet'!A1 + .my.sheet!A1 + 'my sheet':'my alt sheet'!A1 + .my.sheet1:.my.sheet2!$B$2 + my.named..range. + 'my sheet'!my.named.range + .my.sheet!my.named.range + foo.bar(123.456, "abc") + 123.456 + "abc" + true + [Foo.xls]!$A$1 + [Foo.xls]'my sheet'!$A$1 + [Foo.xls]!my.named.range ++ +
+ Table1[col] + Table1[[#Totals],[col]] + Table1[#Totals] + Table1[#All] + Table1[#Data] + Table1[#Headers] + Table1[#Totals] + Table1[#This Row] + Table1[[#All],[col]] + Table1[[#Headers],[col]] + Table1[[#Totals],[col]] + Table1[[#All],[col1]:[col2]] + Table1[[#Data],[col1]:[col2]] + Table1[[#Headers],[col1]:[col2]] + Table1[[#Totals],[col1]:[col2]] + Table1[[#Headers],[#Data],[col2]] + Table1[[#This Row], [col1]] + Table1[ [col1]:[col2] ] ++ @param tableName + @return +
+ my.named...range. + foo.bar(123.456, "abc") + 123.456 + "abc" + true ++
null
+ @param part1
+ @param part2 may be null
+ null (and leaves {@link #_pointer} unchanged if a proper range part does not parse out
+ null result
+ @return The sheet name as an identifier null if '!' is not found in the right place
+ null
+ * @return Ptg a null is returned if we're in an IF formula, it needs extreme manipulation and is handled in this Function
+ null if either workbook or sheet is not found
+ null
+ the current workbook is assumed. Note - to Evaluate formulas which use multiple workbooks,
+ a {@link CollaboratingWorkbooksEnvironment} must be set up.
+ @param sheetName the name of the sheet Containing the reference. May be null
+ (when null.
+ @param refStrPart2 the second part of the area reference. For single cell references this
+ parameter must be null
+ @param isA1Style specifies the format for null
+ null or {@link #RefErrorPtg} if no change was made
+
+ @param aptg
+ @return
+ null or {@link #AreaErrPtg} if no change was made
+
+ @param aptg
+ @return null, AreaErrPtg, or modified aptg
+ Ptg
+ tokens into human readable text form. In formula expressions, a sheet name always has a
+ trailing '!' so there is little chance for ambiguity. It doesn't matter too much what this
+ method returns but it is worth noting the likely consumers of these formula text strings:
+ + + @return+
+ Input Result Comments + "A1" true + "a111" true + "AA" false + "aa1" true + "A1A" false + "A1A1" false + "A$1:$C$20" false Not a plain cell reference + "SALES20080101" true +Still needs delimiting even though well out of range
+ In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable. + With this method you can control how POI handles such missing references: +
This defines how to calculate the ranges for a conditional + formatting rule, eg which values Get a Green Traffic Light + icon and which Yellow or Red.
+If you change the range type, you need to + ensure that the Formula and Value parameters + are compatible with it before saving
+ Formula to use to calculate the threshold, + ornull if no formula
+ null is given.
+ Gets the value used for the threshold, or
+ null if there isn't one.
+ + If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final + ctColor applied. +
++ The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and + 1.0 means 100% lighten. Also, 0.0 means no Change. +
++ In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where + HLSMAX is currently 255. +
+ Here are some examples of how to apply tint to ctColor: +++ + @return the tint value ++ If (tint < 0) + Lum' = Lum * (1.0 + tint) + + For example: Lum = 200; tint = -0.5; Darken 50% + Lum' = 200 * (0.5) => 100 + For example: Lum = 200; tint = -1.0; Darken 100% (make black) + Lum' = 200 * (1.0-1.0) => 0 + If (tint > 0) + Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint)) + For example: Lum = 100; tint = 0.75; Lighten 75% + + Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75)) + = 100 * .25 + (255 - 255 * .25) + = 25 + (255 - 63) = 25 + 192 = 217 + For example: Lum = 100; tint = 1.0; Lighten 100% (make white) + Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1)) + = 100 * 0 + (255 - 255 * 0) + = 0 + (255 - 0) = 255 ++
Format class that handles Excel style fractions, such as "# #/#" and "#/###"
+ +As of this writing, this is still not 100% accurate, but it does a reasonable job + of trying to mimic Excel's fraction calculations. It does not currently + maintain Excel's spacing.
+ +This class relies on a method lifted nearly verbatim from org.apache.math.fraction. + If further uses for Commons Math are found, we will consider Adding it as a dependency. + For now, we have in-lined the one method to keep things simple.
+If the new Icon Set has a different number of + icons to the old one, you must update the + thresholds before saving!
+ Should Icon + Value be displayed, or only the Icon? ++ Each element corresponds to a color index (zero-based). When using the default indexed color palette, + the values are not written out, but instead are implied. When the color palette has been modified from default, + then the entire color palette is used. +
+ + @author Yegor Kozlov +XSSFTable.UpdateHeaders() is called to reset the cache.
+ @param columnHeader the column header name to Get the table column index of
+ @return column index corresponding to columnHeader
+ + Filtering data is a quick and easy way to find and work with a subset of data in a range of cells or table. + For example, you can filter to see only the values that you specify, filter to see the top or bottom values, + or filter to quickly see duplicate values. +
+ + TODO YK: For now (Aug 2010) POI only supports Setting a basic autofilter on a range of cells. + In future, when we support more auto-filter functions like custom criteria, sort, etc. we will add + corresponding methods to this interface. +null if there is not a built-in format at that index
+ + Automatically converts "text" to excel's format string to represent text. +
+ @param pFmt string matching a built-in format + @return index of format or -1 if undefined. ++ Cells can be numeric, formula-based or string-based (text). The cell type + specifies this. String cells cannot conatin numbers and numeric cells cannot + contain strings (at least according to our model). Client apps should do the + conversions themselves. Formula cells have the formula string, as well as + the formula result, which can be numeric or string. +
++ Cells should have their number (0 based) before being Added to a row. +
+If the cell currently contains a value, the value will + be converted to match the new type, if possible. Formatting + is generally lost in the process however.
+If what you want to do is get a String value for your + numeric cell, stop!. This is not the way to do it. + Instead, for fetching the string value of a numeric or boolean + or date cell, use {@link DataFormatter} instead.
+"SUM(C4:E4)".
+ A1 style address of this cell
+ @since 3.14beta2
+ null.
+ null.
+ + Specifies that the current drawing shall move and + resize to maintain its row and column anchors (i.e. the + object is anchored to the actual from and to row and column) +
++ Specifies that the current drawing shall move with its + row and column (i.e. the object is anchored to the + actual from row and column), but that the size shall remain absolute. +
++ If Additional rows/columns are Added between the from and to locations of the drawing, + the drawing shall move its to anchors as needed to maintain this same absolute size. +
++ Specifies that the current start and end positions shall + be maintained with respect to the distances from the + absolute start point of the worksheet. +
++ If Additional rows/columns are Added before the + drawing, the drawing shall move its anchors as needed + to maintain this same absolute position. +
++ 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells. +
+ @return the anchor type + @see #MOVE_AND_RESIZE + @see #MOVE_DONT_RESIZE + @see #DONT_MOVE_AND_RESIZE ++ For example, "highlight cells that begin with "M2" and contain "Mountain Gear". +
+ + @author Dmitriy Kumshayev + @author Yegor Kozlov ++ ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index); + newSheet.AddConditionalFormatting(cf); ++ +
+
+ // Define a Conditional Formatting rule, which triggers formatting
+ // when cell's value is greater or equal than 100.0 and
+ // applies patternFormatting defined below.
+ ConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
+ ComparisonOperator.GE,
+ "100.0", // 1st formula
+ null // 2nd formula is not used for comparison operator GE
+ );
+
+ // Create pattern with red background
+ PatternFormatting patternFmt = rule.CretePatternFormatting();
+ patternFormatting.FillBackgroundColor(IndexedColor.RED.Index);
+
+ // Define a region Containing first column
+ Region [] regions =
+ {
+ new Region(1,(short)1,-1,(short)1)
+ };
+
+ // Apply Conditional Formatting rule defined above to the regions
+ sheet.AddConditionalFormatting(regions, rule);
+
+
+ @author Dmitriy Kumshayev
+ @author Yegor Kozlov
+ null
+ null.
+ null otherwise
+ null.
+ null otherwise
+ null.
+ null otherwise
+ null otherwise
+ null otherwise
+ null otherwise
+ + MUST be either {@link #CONDITION_TYPE_CELL_VALUE_IS} or {@link #CONDITION_TYPE_FORMULA} +
+ + @return the type of condition ++ MUST be a constant from {@link ComparisonOperator} +
+ + @return the conditional format operator ++ If the condition type is {@link #CONDITION_TYPE_CELL_VALUE_IS}, + this field is the first operand of the comparison. + If type is {@link #CONDITION_TYPE_FORMULA}, this formula is used + to determine if the conditional formatting is applied. +
++ If comparison type is {@link #CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function +
+ + @return the first formula +null
+ null
+ null
+ null
+ formula1 was comma-separated literal values rather than a range or named range,
+ returns list of literal values.
+ Otherwise returns null.
+ null
+ null
+ excelDate == GetExcelDate(GetJavaDate(excelDate,false))
+ Is not always true. For example if default timezone Is
+ Example: + In the case of SUM(B1 C1), the space between B1 and C1 is treated as the binary + intersection operator, when a comma was intended. end example] +
+Example: + In the case of a function argument, text was expected, but a number was provided +
+Example: + If a formula Contains a reference to a cell, and then the row or column Containing that cell is deleted, + a #REF! error results. If a worksheet does not support 20,001 columns, + OFFSET(A1,0,20000) will result in a #REF! error. +
+Example: + Certain calls to ASIN, ATANH, FACT, and SQRT might result in domain errors. +
+ Intended to indicate that the result of a function cannot be represented in a value of + the specified type, typically due to extreme magnitude. (This is known as a range + error.) +Example: FACT(1000) might result in a range error.
+Example: + Some functions, such as SUMX2MY2, perform a series of operations on corresponding + elements in two arrays. If those arrays do not have the same number of elements, then + for some elements in the longer array, there are no corresponding elements in the + shorter one; that is, one or more values in the shorter array are not available. +
+ This error value can be produced by calling the function NA ++ int EvaluatedCellType = Evaluator.evaluateFormulaCell(cell); ++ Be aware that your cell will hold both the formula, + and the result. If you want the cell Replaced with + the result of the formula, use {@link #EvaluateInCell(Cell)} + @param cell The cell to Evaluate + @return The type of the formula result, i.e. -1 if the cell is not a formula, + or one of Cell.CELL_TYPE_NUMERIC, Cell.CELL_TYPE_STRING, Cell.CELL_TYPE_BOOLEAN, Cell.CELL_TYPE_ERROR + Note: the cell's type remains as Cell.CELL_TYPE_FORMULA however. +
+ int EvaluatedCellType = Evaluator.evaluateInCell(cell).getCellType(); ++ Be aware that your cell value will be Changed to hold the + result of the formula. If you simply want the formula + value comPuted for you, use {@link #EvaluateFormulaCell(Cell)} + @param cell +
+ Additional rules: +
+ When there is also an indent value to apply, both the left and right side of the cell + are pAdded by the indent value. +
+A 'word' is a set of characters with no space character in them.
+Two lines inside a cell are Separated by a carriage return.
+null if it has not been set yet. Never empty string
+ @see #SetRefersToFormula(String)
+ + Please note, that this method works correctly only for workbooks + with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx). + If the default font is changed the resized image can be streched vertically or horizontally. +
+
+ resize(1.0,1.0) keeps the original size,
+ resize(0.5,0.5) resize to 50% of the original,
+ resize(2.0,2.0) resizes to 200% of the original.
+ resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE}) resizes to the dimension of the embedded image.
+
SetCellValue or SetCellType.
+
+ short minColIx = row.GetFirstCellNum();
+ short maxColIx = row.GetLastCellNum();
+ for(short colIx=minColIx; colIx<maxColIx; colIx++) {
+ Cell cell = row.GetCell(colIx);
+ if(cell == null) {
+ continue;
+ }
+ //... do something with cell
+ }
+
+ nullnullnull to remove protection
+ + Sheet1!$1:$1 + Sheet2!$5:$8 ++ The {@link CellRangeAddress} returned contains a column part which spans + all columns, and a row part which specifies the contiguous range of + repeating rows. + + If the Sheet does not have any repeating rows defined, null is returned. +
+ Sheet1!$A:$A + Sheet2!$C:$F ++ The {@link CellRangeAddress} returned contains a row part which spans all + rows, and a column part which specifies the contiguous range of + repeating columns. + + If the Sheet does not have any repeating columns defined, null is + returned. +
A1.
+ + The Created conditional formatting rule Compares a cell value + to a formula calculated result, using the specified operator. + The type of the Created condition is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS} +
+ + @param comparisonOperation - MUST be a constant value from ++
+ When text direction is horizontal: the vertical alignment of lines of text is distributed vertically, + where each line of text inside the cell is evenly distributed across the height of the cell, + with flush top and bottom margins. +
++ When text direction is vertical: similar behavior as horizontal justification. + The alignment is justified (flush top and bottom in this case). For each line of text, each + line of the wrapped text in a cell is aligned to the top and bottom (except the last line). + If no single line of text wraps in the cell, then the text is not justified. +
++ When text direction is horizontal: the vertical alignment of lines of text is distributed vertically, + where each line of text inside the cell is evenly distributed across the height of the cell, + with flush top +
++ When text direction is vertical: behaves exactly as distributed horizontal alignment. + The first words in a line of text (appearing at the top of the cell) are flush + with the top edge of the cell, and the last words of a line of text are flush with the bottom edge of the cell, + and the line of text is distributed evenly from top to bottom. +
++ This is different from the normal hidden status + ({@link #isSheetHidden(int)}) +
+ @param sheetIx sheet index to check + @returntrue if sheet is very hidden
+ + 0 = not hidden + 1 = hidden + 2 = very hidden. ++ @param sheetIx The sheet number + @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden +
This class is a Container for POI usermodel row=0 column=0 cell references. + It is barely a Container for these two coordinates. The implementation + of the Comparable interface sorts by "natural" order top left to bottom right.
+ +Use CellAddress when you want to refer to the location of a cell in a sheet + when the concept of relative/absolute does not apply (such as the anchor location + of a cell comment). Use {@link CellReference} when the concept of + relative/absolute does apply (such as a cell reference in a formula). + CellAddresses do not have a concept of "sheet", while CellReferences do.
+25.4/HorizontalPixelSize
+ and 25.4/VerticalPixelSize. Where 25.4 is the number of mm in inch.
+
+ @return array of two elements: {horisontalPdi, verticalDpi}.
+ {96, 96} is the default.
+ | Result | Comment |
|---|---|
| A1:A1 | Single cell area reference without sheet |
| A1:$C$1 | Multi-cell area reference without sheet |
| Sheet1!A$1:B4 | Standard sheet name |
| 'O''Brien''s Sales'!B5:C6' | Sheet name with special Chars |
Common conversion functions between Excel style A1, C27 style + cell references, and POI usermodel style row=0, column=0 + style references. Handles sheet-based and sheet-free references + as well, eg "Sheet1!A1" and "$B$72"
+ +Use CellReference when the concept of + relative/absolute does apply (such as a cell reference in a formula). + Use {@link CellAddress} when you want to refer to the location of a cell in a sheet + when the concept of relative/absolute does not apply (such as the anchor location + of a cell comment). + CellReferences have a concept of "sheet", while CellAddresses do not.
+| Result | Comment |
|---|---|
| A1 | Cell reference without sheet |
| Sheet1!A1 | Standard sheet name |
| 'O''Brien''s Sales'!A1' | Sheet name with special characters |
+ POI currently targets BIFF8 (Excel 97-2003), so the following behaviour can be observed for + this method: ++
+ Version File Format +Last Column Last Row + 97-2003 BIFF8 "IV" (2^8) 65536 (2^14) + 2007 BIFF12 "XFD" (2^14) 1048576 (2^20)
+ + @param colStr a string of only letter characters + @param rowStr a string of only digit characters + @return+
+ Input +Result + "A", "1" true + "a", "111" true + "A", "65536" true + "A", "65537" false + "iv", "1" true + "IW", "1" false + "AAA", "1" false + "a", "111" true + "Sheet", "1" false
This method attempts to find an existing CellStyle that matches the cell's
+ current style plus styles properties in properties. A new style is created if the
+ workbook does not contain a matching style.
Modifies the cell style of cell without affecting other cells that use the
+ same style.
This is necessary because Excel has an upper limit on the number of styles that it supports.
+ +This function is more efficient than multiple calls to + {@link #setCellStyleProperty(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.usermodel.Workbook, String, Object)} + if adding multiple cell styles.
+ +For performance reasons, if this is the only cell in a workbook that uses a cell style, + this method does NOT remove the old style from the workbook. + +
+ + @param cell The cell to change the style of + @param properties The properties to be added to a cell style, as {propertyName: propertyValue}. + @since POI 3.14 beta 2 +This method attempts to find an existing CellStyle that matches the cell's
+ current style plus a single style property propertyName with value
+ propertyValue.
+ A new style is created if the workbook does not contain a matching style.
Modifies the cell style of cell without affecting other cells that use the
+ same style.
If setting more than one cell style property on a cell, use + {@link #setCellStyleProperties(org.apache.poi.ss.usermodel.Cell, Map)}, + which is faster and does not add unnecessary intermediate CellStyles to the workbook.
+ + @param cell The cell that is to be changed. + @param propertyName The name of the property that is to be changed. + @param propertyValue The value of the property that is to be changed. +This method attempts to find an existing CellStyle that matches the cell's
+ current style plus a single style property propertyName with value
+ propertyValue.
+ A new style is created if the workbook does not contain a matching style.
Modifies the cell style of cell without affecting other cells that use the
+ same style.
If setting more than one cell style property on a cell, use + {@link #setCellStyleProperties(Cell, Map)}, + which is faster and does not add unnecessary intermediate CellStyles to the workbook.
+ + @param workbook The workbook that is being worked with. + @param propertyName The name of the property that is to be changed. + @param propertyValue The value of the property that is to be changed. + @param cell The cell that needs it's style changes +style, so subsequent changes
+ to style will not modify the map, and changes to the returned
+ map will not modify the cell style. The returned map is mutable.
+ @param style cell style
+ @return map of format properties (String -> Object)
+ @see #setFormatProperties(org.apache.poi.ss.usermodel.CellStyle, org.apache.poi.ss.usermodel.Workbook, java.util.Map)
+ | 1 | 2 |
| 3 | 4 |
negative, 0, or positive according to the standard Excel comparison
+ of values isNegative ? -1 : +1
+ java.util.Date or java.util.Calendar
+ instances become date cells.Object.toString()
+ method call.If the cell at the given co-ordinates is a merged cell, this will + return the primary (top-left) most cell of the merged region.
+If the cell at the given co-ordinates is not in a merged region, + then will return the cell itself.
+If there is no cell defined at the given co-ordinates, will return + null.
+
+ The character count
GetMaxRows() - 1
+ GetMaxColumns() - 1
+ IV or XFD).
+ true if this revocation data Set holds OCSP
+ responses.
+
+ @return true if this revocation data Set holds OCSP
+ responses.
+ true if this revocation data Set holds CRLs.
+
+ @return true if this revocation data Set holds CRLs.
+ true if this revocation data is not empty.
+
+ @return true if this revocation data is not empty.
+ null if a description is not available.
+
+ @return the description, or null.
+ null in case such a download location does not
+ exist.
+
+ @return the download URL, or null.
+ null the signature will be limited to XAdES-T only.
+ null value will trigger an automatically generated signature Id.
+ null value will trigger an automatically generated signature Id.
+ null, the hash algorithm of the main entry
+ null the signature will be limited to XAdES-T only.
+ null the signature will be limited to XAdES-T only.
+ null, defaults to {@link #getDigestAlgo()}
+ 1.3.6.1.4.1.13762.3
+ null the claimed role element is omitted.
+ Defaults to null
+ null the claimed role element is omitted.
+ idSignedProperties
+ null defaults to idSignedProperties
+ true
+ EXCLUSIVE
+ @see javax.xml.Crypto.dsig.CanonicalizationMethod
+ null if not specified)
+ null
+ if not specified)
+ URIReference and returns the
+ dereferenced data.
+
+ @param uriReference the URIReference
+ @param context an XMLCryptoContext that may
+ contain additional useful information for dereferencing the URI. This
+ implementation should dereference the specified
+ URIReference against the context's baseURI
+ parameter, if specified.
+ @return the dereferenced data
+ @throws NullPointerException if uriReference or
+ context are null
+ @throws URIReferenceException if an exception occurs while
+ dereferencing the specified uriReference
+ EventListener interface was registered.
+ @param evt The Event contains contextual information
+ about the event. It also contains the stopPropagation
+ and preventDefault methods which are used in
+ determining the event's flow and default action.
+ This class is the default entry point for XML signatures and can be used for + validating an existing signed office document and signing a office document.
+ +Validating a signed office document
+ ++ OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ); + SignatureConfig sic = new SignatureConfig(); + sic.setOpcPackage(pkg); + SignatureInfo si = new SignatureInfo(); + si.setSignatureConfig(sic); + boolean isValid = si.validate(); + ... ++ +
Signing an office document
+ +
+ // loading the keystore - pkcs12 is used here, but of course jks & co are also valid
+ // the keystore needs to contain a private key and it's certificate having a
+ // 'digitalSignature' key usage
+ char password[] = "test".toCharArray();
+ File file = new File("test.pfx");
+ KeyStore keystore = KeyStore.getInstance("PKCS12");
+ FileInputStream fis = new FileInputStream(file);
+ keystore.load(fis, password);
+ fis.close();
+
+ // extracting private key and certificate
+ String alias = "xyz"; // alias of the keystore entry
+ Key key = keystore.getKey(alias, password);
+ X509Certificate x509 = (X509Certificate)keystore.getCertificate(alias);
+
+ // filling the SignatureConfig entries (minimum fields, more options are available ...)
+ SignatureConfig signatureConfig = new SignatureConfig();
+ signatureConfig.setKey(keyPair.getPrivate());
+ signatureConfig.setSigningCertificateChain(Collections.singletonList(x509));
+ OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ_WRITE);
+ signatureConfig.setOpcPackage(pkg);
+
+ // adding the signature document to the package
+ SignatureInfo si = new SignatureInfo();
+ si.setSignatureConfig(signatureConfig);
+ si.confirmSignature();
+ // optionally verify the generated signature
+ boolean b = si.verifySignature();
+ assert (b);
+ // write the changes back to disc
+ pkg.close();
+
+
+ Implementation notes:
+ +Although there's a XML signature implementation in the Oracle JDKs 6 and higher, + compatibility with IBM JDKs is also in focus (... but maybe not thoroughly tested ...). + Therefore we are using the Apache Santuario libs (xmlsec) instead of the built-in classes, + as the compatibility seems to be provided there.
+ +To use SignatureInfo and its sibling classes, you'll need to have the following libs + in the classpath:
++ Each POIXMLDocumentPart keeps a reference to the underlying a {@link org.apache.poi.openxml4j.opc.PackagePart}. +
+ + @author Yegor Kozlov +null for the root element.
+
+ protected void commit() {
+ PackagePart part = GetPackagePart();
+ Stream out = part.GetStream();
+ XmlObject bean = GetXmlBean(); //the "model" which holds Changes in memory
+ bean.save(out, DEFAULT_XML_OPTIONS);
+ out.close();
+ }
+ POIXMLDocumentPart
+
+ @author Yegor Kozlov
+ null if there isn't one
+
+ @return The Document Thumbnail part or null
+ thumbnail.jpeg, or null if there
+ isn't one.
+
+ @return The thumbnail filename, or null
+ null if there isn't one.
+
+ @return The thumbnail data, or null
+ thumbnail.jpg
+ @param imageData The inputstream to read the thumbnail image from
+ + A workbook may contain thousands of cells Containing string (non-numeric) data. Furthermore this data is very + likely to be repeated across many rows or columns. The goal of implementing a single string table that is shared + across the workbook is to improve performance in opening and saving the file by only Reading and writing the + repetitive information once. +
++ Consider for example a workbook summarizing information for cities within various countries. There may be a + column for the name of the country, a column for the name of each city in that country, and a column + Containing the data for each city. In this case the country name is repetitive, being duplicated in many cells. + In many cases the repetition is extensive, and a tremendous savings is realized by making use of a shared string + table when saving the workbook. When displaying text in the spreadsheet, the cell table will just contain an + index into the string table as the value of a cell, instead of the full string. +
++ The shared string table Contains all the necessary information for displaying the string: the text, formatting + properties, and phonetic properties (for East Asian languages). +
+ + @author Nick Birch + @author Yegor Kozlov +strings arrays
+
+ If the Shared String table already Contains this CT_Rst bean, its index is returned.
+ Otherwise a new entry is aded.
+
fmt in the numberFormats map if the format is not
+ already in the the number format style table.
+ Does nothing if fmt is already in number format style table.
+
+ @param fmt the number format to add to number format style table
+ @return the index of fmt in the number format style table
+ fmt
+ This may be used to override built-in number formats.
+
+ @param index the number format ID
+ @param fmt the number format code
+ sheet
+
+ @param sheet the sheet associated with this auto-size column tracker
+ @since 3.14beta1
+ columns that are already tracked are ignored by this call.
+
+ @param columns the indices of the columns to track
+ @since 3.14beta1
+ column is already tracked, this call does nothing.
+
+ @param column the index of the column to track for auto-sizing
+ @return if column is already tracked, the call does nothing and returns false
+ @since 3.14beta1
+ columns that is not tracked will be ignored by this call.
+
+ @param columns the indices of the columns to track for auto-sizing
+ @return true if one or more columns were untracked as a result of this call
+ @since 3.14beta1
+ column is not tracked, it will be ignored by this call.
+
+ @param column the index of the column to track for auto-sizing
+ @return true if column was tracked prior this call, false if no action was taken
+ @since 3.14beta1
+ .gz
+
+ @return temp file to write sheet data
+ SXSSFRow objects. Two rows are equal if they belong to the same worksheet and
+ their row indexes are equal.
+
+ @param other the SXSSFRow to be compared.
+ @return 0 if the row number of this SXSSFRow is
+ equal to the row number of the argument SXSSFRow
+ 0 if the row number of this this SXSSFRow is
+ numerically less than the row number of the argument SXSSFRow
+ 0 if the row number of this this SXSSFRow is
+ numerically greater than the row number of the argument SXSSFRow
+ + This process can be relatively slow on large sheets, so this should + normally only be called once per column, at the end of your + processing. +
+ You can specify whether the content of merged cells should be considered or ignored. + Default is to ignore merged cells. + ++ Special note about SXSSF implementation: You must register the columns you wish to track with + the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}. + This is needed because the rows needed to compute the column width may have fallen outside the + random access window and been flushed to disk. + Tracking columns is required even if all rows are in the random access window. +
+New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.
+ + @param column the column index to auto-size ++ This process can be relatively slow on large sheets, so this should + normally only be called once per column, at the end of your + processing. +
+ You can specify whether the content of merged cells should be considered or ignored. + Default is to ignore merged cells. + ++ Special note about SXSSF implementation: You must register the columns you wish to track with + the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}. + This is needed because the rows needed to compute the column width may have fallen outside the + random access window and been flushed to disk. + Tracking columns is required even if all rows are in the random access window. +
+New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.
+ + @param column the column index to auto-size + @param useMergedCells whether to use the contents of merged cells when calculating the width of the column +null if not found+ groupRows requires all rows in the group to be in the current window. + This is not always practical. Instead use setRowOutlineLevel to + explicitly set the group level. Level 1 is the top level group, + followed by 2, etc. It is up to the user to ensure that level 2 + groups are correctly nested under level 1, etc. +
+ + @param rownum index of row to update (0-based) + @param level outline level (greater than 0) +column is already tracked, this call does nothing.
+
+ @param column the column to track for autosizing
+ @since 3.14beta1
+ @see #trackColumnsForAutoSizing(Collection)
+ @see #trackAllColumnsForAutoSizing()
+ columns that are already tracked are ignored by this call.
+
+ @param columns the columns to track for autosizing
+ @since 3.14beta1
+ column is not tracked, it will be ignored by this call.
+
+ @param column the index of the column to track for auto-sizing
+ @return true if column was tracked prior to this call, false if no action was taken
+ @since 3.14beta1
+ @see #untrackColumnsForAutoSizing(Collection)
+ @see #untrackAllColumnsForAutoSizing(int)
+ columns that is not tracked will be ignored by this call.
+
+ @param columns the indices of the columns to track for auto-sizing
+ @return true if one or more columns were untracked as a result of this call
+
+ @param columns the columns to track for autosizing
+ @since 3.14beta1
+ + When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. ++ There are three use-cases to use SXSSFWorkbook(XSSFWorkbook) : +
+ When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. ++ When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. + @param compressTmpFiles whether to use gzip compression for temporary files ++ When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param workbook the template workbook + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. + @param compressTmpFiles whether to use gzip compression for temporary files + @param useSharedStringsTable whether to use a shared strings table +
+ SXSSF writes sheet data in temporary files (a temp file per-sheet)
+ and the size of these temp files can grow to to a very large size,
+ e.g. for a 20 MB csv data the size of the temp xml file become few GB large.
+ If the "compress" flag is set to true then the temporary XML is gzipped.
+
+ Please note the the "compress" option may cause performance penalty. +
+ @param compress whether to compress temp files +null
+ + The idea is to parse every formula and render it back to string + with the updated sheet name. This is done by parsing into Ptgs, + looking for ones with sheet references in them, and changing those +
+ + @param sheetIndex the 0-based index of the sheet being changed + @param oldName the old sheet name + @param newName the new sheet name +null if the formula wasn't modified
+ + Autofit specifies that a shape should be auto-fit to fully contain the text described within it. + Auto-fitting is when text within a shape is scaled in order to contain all the text inside +
++ Example: Consider the situation where a user is building a diagram and needs + to have the text for each shape that they are using stay within the bounds of the shape. + An easy way this might be done is by using NORMAL autofit +
++ Example: Consider the situation where a user is building a diagram and needs to have + the text for each shape that they are using stay within the bounds of the shape. + An easy way this might be done is by using SHAPE autofit +
++ Cells can be numeric, formula-based or string-based (text). The cell type + specifies this. String cells cannot conatin numbers and numeric cells cannot + contain strings (at least according to our model). Client apps should do the + conversions themselves. Formula cells have the formula string, as well as + the formula result, which can be numeric or string. +
++ Cells should have their number (0 based) before being Added to a row. Only + cells that have values should be Added. +
++ For strings, numbers, and errors, we throw an exception. For blank cells we return a false. +
+ @return the value of the cell as a bool + @throws InvalidOperationException if the cell type returned by {@link #CellType} + is not CellType.Boolean, CellType.Blank or CellType.Formula ++ For strings we throw an exception. For blank cells we return a 0. + For formulas or error cells we return the precalculated value; +
+ @return the value of the cell as a number + @throws InvalidOperationException if the cell type returned by {@link #CellType} is CellType.String + @exception NumberFormatException if the cell value isn't a parsabledouble.
+ @see DataFormatter for turning this number into a string similar to that which Excel would render this number as.
+ + For numeric cells we throw an exception. For blank cells we return an empty string. + For formulaCells that are not string Formulas, we throw an exception +
+ @return the value of the cell as a string ++ For numeric cells we throw an exception. For blank cells we return an empty string. + For formula cells we return the pre-calculated value if a string, otherwise an exception +
+ @return the value of the cell as a XSSFRichTextString +SUM(C4:E4)
+ + Note, this method only Sets the formula string and does not calculate the formula value. + To Set the precalculated value use {@link #setCellValue(double)} or {@link #setCellValue(String)} +
+ + @param formula the formula to Set, e.g."SUM(C4:E4)".
+ If the argument is null then the current formula is Removed.
+ @throws NPOI.ss.formula.FormulaParseException if the formula has incorrect syntax or is otherwise invalid
+ @throws InvalidOperationException if the operation is not allowed, for example,
+ when the cell is a part of a multi-cell array formula
+ + If the cell Contains a string, then this value is an index into + the shared string table, pointing to the actual string value. Otherwise, + the value of the cell is expressed directly in this element. Cells Containing formulas express + the last calculated result of the formula in this element. +
+ + @return the raw cell value as Contained in the underlying CT_Cell bean, +null for blank cells.
+ -1 means no xf.
+ @param stylesSource Styles Source to work off
+ null if not Set
+ + Note - many cells are actually Filled with a foreground + Fill, not a background fill - see {@link #getFillForegroundColor()} +
+ @see NPOI.xssf.usermodel.XSSFColor#getRgb() + @return XSSFColor - fill color ornull if not Set
+ + Many cells are Filled with this, instead of a + background color ({@link #getFillBackgroundColor()}) +
+ @see IndexedColors + @return fill color, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC} +null if not Set
+ @see NPOI.ss.usermodel.IndexedColors
+ [degrees below horizon] = 90 - textRotation.
+ application/vnd.Openxmlformats-officedocument.Drawingml.chart+xml
+ @param rel the namespace relationship holding this chart,
+ the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/chart
+ + Chart sheet is a special kind of Sheet that Contains only chart and no data. +
+ + @author Yegor Kozlov ++ If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final + ctColor applied. +
++ The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and + 1.0 means 100% lighten. Also, 0.0 means no Change. +
++ In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where + HLSMAX is currently 255. +
+ Here are some examples of how to apply tint to ctColor: +++ + @return the tint value ++ If (tint < 0) + Lum' = Lum * (1.0 + tint) + + For example: Lum = 200; tint = -0.5; Darken 50% + Lum' = 200 * (0.5) => 100 + For example: Lum = 200; tint = -1.0; Darken 100% (make black) + Lum' = 200 * (1.0-1.0) => 0 + If (tint > 0) + Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint)) + For example: Lum = 100; tint = 0.75; Lighten 75% + + Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75)) + = 100 * .25 + (255 - 255 * .25) + = 25 + (255 - 63) = 25 + 192 = 217 + For example: Lum = 100; tint = 1.0; Lighten 100% (make white) + Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1)) + = 100 * 0 + (255 - 255 * 0) + = 0 + (255 - 0) = 255 ++
null
+ null.
+ null otherwise
+ null.
+ null otherwise
+ null.
+ null otherwise
+ + MUST be a constant from {@link NPOI.ss.usermodel.ComparisonOperator} +
+ + @return the conditional format operator ++ If the condition type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}, + this field is the first operand of the comparison. + If type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}, this formula is used + to determine if the conditional formatting is applied. +
++ If comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function +
+ + @return the first formula +fmt
+ This may be used to override built-in number formats.
+
+ @param index the number format ID
+ @param format the number format code
+ null
+ application/vnd.openxmlformats-officedocument.Drawing+xml
+ @param rel the namespace relationship holding this Drawing,
+ the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing
+ + Even page header value. Corresponds to even printed pages. + Even page(s) in the sheet may not be printed, for example, if the print area is specified to be + a range such that it falls outside an even page's scope. + If no even header is specified, then odd header value is assumed for even page headers. +
+ +null
+ for the (conservative) assumption that any cell may have its defInition Changed After
+ Evaluation begins.
+ @param udfFinder pass null for default (AnalysisToolPak only)
+
+ Defined names are descriptive text that is used to represents a cell, range of cells, formula, or constant value.
+ Use easy-to-understand names, such as Products, to refer to hard to understand ranges, such as Sales!C20:C30.
+
+ + @author Nick Burch + @author Yegor Kozlov ++ XSSFWorkbook wb = new XSSFWorkbook(); + XSSFSheet sh = wb.CreateSheet("Sheet1"); + + //applies to the entire workbook + XSSFName name1 = wb.CreateName(); + name1.SetNameName("FMLA"); + name1.SetRefersToFormula("Sheet1!$B$3"); + + //applies to Sheet1 + XSSFName name2 = wb.CreateName(); + name2.SetNameName("SheetLevelName"); + name2.SetComment("This name is scoped to Sheet1"); + name2.SetLocalSheetId(0); + name2.SetRefersToFormula("Sheet1!$B$3"); + +
true indicates the name refers to a function.
+ true if this name refers to a user-defined function
+ true if the argument is XSSFName and the
+ underlying CTDefinedName bean Equals to the CTDefinedName representing this name
+
+ @param o the object to compare this XSSFName against.
+ @return true if the XSSFName are Equal;
+ false otherwise.
+ + Please note, that this method works correctly only for workbooks + with the default font size (Calibri 11pt for .xlsx). + If the default font is Changed the resized image can be streched vertically or horizontally. +
++ Please note, that this method works correctly only for workbooks + with the default font size (Calibri 11pt for .xlsx). + If the default font is changed the resized image can be streched vertically or horizontally. +
+
+ resize(1.0,1.0) keeps the original size,
+ resize(0.5,0.5) resize to 50% of the original,
+ resize(2.0,2.0) resizes to 200% of the original.
+ resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE}) resizes to the dimension of the embedded image.
+
http://schemas.openxmlformats.org/officeDocument/2006/relationships/image
+ @return registered POIXMLRelation or null if not found
+ + Most strings in a workbook have formatting applied at the cell level, that is, the entire string in the cell has the + same formatting applied. In these cases, the formatting for the cell is stored in the styles part, + and the string for the cell can be shared across the workbook. The following code illustrates the example. +
+ +
+
+ cell1.SetCellValue(new XSSFRichTextString("Apache POI"));
+ cell2.SetCellValue(new XSSFRichTextString("Apache POI"));
+ cell3.SetCellValue(new XSSFRichTextString("Apache POI"));
+
+
+ In the above example all three cells will use the same string cached on workbook level.
+
+ + Some strings in the workbook may have formatting applied at a level that is more granular than the cell level. + For instance, specific characters within the string may be bolded, have coloring, italicizing, etc. + In these cases, the formatting is stored along with the text in the string table, and is treated as + a unique entry in the workbook. The following xml and code snippet illustrate this. +
+ +
+
+ XSSFRichTextString s1 = new XSSFRichTextString("Apache POI");
+ s1.ApplyFont(boldArial);
+ cell1.SetCellValue(s1);
+
+ XSSFRichTextString s2 = new XSSFRichTextString("Apache POI");
+ s2.ApplyFont(italicCourier);
+ cell2.SetCellValue(s2);
+
+
+
+
+ @author Yegor Kozlov
+ null if no formatting is required
+
+ Example: The Unicode character 0D is invalid in an XML 1.0 document,
+ so it shall be escaped as _x000D_.
+
+ for(Cell cell : row){
+ ...
+ }
+ XSSFRow objects. Two rows are equal if they belong to the same worksheet and
+ their row indexes are equal.
+
+ @param row the XSSFRow to be compared.
+ @return 0 if the row number of this XSSFRow is
+ equal to the row number of the argument XSSFRow
+ 0 if the row number of this this XSSFRow is
+ numerically less than the row number of the argument XSSFRow
+ 0 if the row number of this this XSSFRow is
+ numerically greater than the row number of the argument XSSFRow
+
+ short minColIx = row.GetFirstCellNum();
+ short maxColIx = row.GetLastCellNum();
+ for(short colIx=minColIx; colIx<maxColIx; colIx++) {
+ XSSFCell cell = row.GetCell(colIx);
+ if(cell == null) {
+ continue;
+ }
+ //... do something with cell
+ }
+
+
+ @return short representing the last logical cell in the row PLUS ONE,
+ or -1 if the row does not contain any cells.
+ + Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work. + The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can + contain text, numbers, dates, and formulas. Cells can also be formatted. +
++ This process can be relatively slow on large sheets, so this should + normally only be called once per column, at the end of your + Processing. +
+ You can specify whether the content of merged cells should be considered or ignored. + Default is to ignore merged cells. + + @param column the column index + @param useMergedCells whether to use the contents of merged cells when calculating the width of the column +null if the drawing was not found and autoCreate=false
+ + If both colSplit and rowSplit are zero then the existing freeze pane is Removed +
+ + @param colSplit Horizonatal position of split. + @param rowSplit Vertical position of split. + @param leftmostColumn Left column visible in right pane. + @param topRow Top row visible in bottom pane +null if not foundnull
+ + Note, the returned value is always gerater that {@link #GetDefaultColumnWidth()} because the latter does not include margins. + Actual column width measured as the number of characters of the maximum digit width of the + numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin + pAdding (two on each side), plus 1 pixel pAdding for the gridlines. +
+ + @param columnIndex - the column to set (0-based) + @return width - the width in units of 1/256th of a character width ++ Please note, that this method works correctly only for workbooks + with the default font size (Calibri 11pt for .xlsx). +
++ Note, this value is different from {@link #GetColumnWidth(int)}. The latter is always greater and includes + 4 pixels of margin pAdding (two on each side), plus 1 pixel pAdding for the gridlines. +
+ @return column width, default value is 8 +true
+ null to remove protection
+ XSSFRow representing the rownumber or null if its not defined on the sheet
+ null
+ + When true a summary row is inserted below the detailed data being summarized and a + new outline level is established on that row. +
++ When false a summary row is inserted above the detailed data being summarized and a new outline level + is established on that row. +
+ @returntrue if row summaries appear below detail in the outline
+ + When true a summary column is inserted to the right of the detailed data being summarized + and a new outline level is established on that column. +
++ When false a summary column is inserted to the left of the detailed data being + summarized and a new outline level is established on that column. +
+ @returntrue if col summaries appear right of the detail in the outline
+ false if the column is visible
+ true if this sheet should display formulas.
+ true if this sheet displays gridlines.
+ @see #isPrintGridlines() to check if printing of gridlines is turned on or off
+ + Row heading are the row numbers to the side of the sheet +
++ Column heading are the letters or numbers that appear above the columns of the sheet +
+ + @returntrue if this sheet should display row and column headings.
+ true if there is a page break at the indicated row
+ sheet.SetColumnBreak(2); breaks the sheet into two parts
+ with columns A,B,C in the first and D,E,... in the second. Simuilar, sheet.SetRowBreak(2);
+ breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
+ and rows starting with rownum=4 in the second.
+
+ @param row the row to break, inclusive
+ true if the sheet displays Automatic Page Breaks.
+ sheet.SetColumnBreak(2); breaks the sheet into two parts
+ with columns A,B,C in the first and D,E,... in the second. Simuilar, sheet.SetRowBreak(2);
+ breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
+ and rows starting with rownum=4 in the second.
+
+ @param column the column to break, inclusive
+ + * The maximum column width for an individual cell is 255 characters. + * This value represents the number of characters that can be displayed + * in a cell that is formatted with the standard font (first font in the workbook). + *
+ * + *
+ * Character width is defined as the maximum digit width
+ * of the numbers 0, 1, 2, ... 9 as rendered
+ * using the default font (first font in the workbook).
+ *
+ * Unless you are using a very special font, the default character is '0' (zero),
+ * this is true for Arial (default font font in HSSF) and Calibri (default font in XSSF)
+ *
+ * Please note, that the width set by this method includes 4 pixels of margin pAdding (two on each side), + * plus 1 pixel pAdding for the gridlines (Section 3.3.1.12 of the OOXML spec). + * This results is a slightly less value of visible characters than passed to this method (approx. 1/2 of a character). + *
+ *+ * To compute the actual number of visible characters, + * Excel uses the following formula (Section 3.3.1.12 of the OOXML spec): + *
+ *
+ * width = TRuncate([{Number of Visible Characters} *
+ * {Maximum Digit Width} + {5 pixel pAdding}]/{Maximum Digit Width}*256)/256
+ *
+ * Using the Calibri font as an example, the maximum digit width of 11 point font size is 7 pixels (at 96 dpi).
+ * If you set a column width to be eight characters wide, e.g. SetColumnWidth(columnIndex, 8*256),
+ * then the actual value of visible characters (the value Shown in Excel) is derived from the following equation:
+ *
+ TRuncate([numChars*7+5]/7*256)/256 = 8;
+ *
+ *
+ * which gives 7.29.
+ *
+ 10 - 10% + 20 - 20% + ... + 100 - 100% + ... + 400 - 400% ++ + Current view can be Normal, Page Layout, or Page Break Preview. + + @param scale window zoom magnification + @throws ArgumentException if scale is invalid +
+ Additionally Shifts merged regions that are completely defined in these + rows (ie. merged 2 cells on a row to be Shifted).
+ @param startRow the row to start Shifting + @param endRow the row to end Shifting + @param n the number of rows to shift ++ Additionally Shifts merged regions that are completely defined in these + rows (ie. merged 2 cells on a row to be Shifted).
+ + @param startRow the row to start Shifting + @param endRow the row to end Shifting + @param n the number of rows to shift + @param copyRowHeight whether to copy the row height during the shift + @param reSetOriginalRowHeight whether to set the original row's height to the default ++ When only 1 sheet is selected and active, this value should be in synch with the activeTab value. + In case of a conflict, the Start Part Setting wins and Sets the active sheet tab. +
+ Note: multiple sheets can be selected, but only one sheet can be active at one time. + + @returntrue if this sheet is selected
+ A1.
+
+ @return the location of the active cell.
+ null if not found
+ +
CTTable.
+ Thus, {@link #updateReferences()} is inexpensive.
+
+ @since POI 3.15 beta 3
+ column.
+ The column index is relative to the left-most column in the table, 0-indexed.
+ Returns -1 if column is not a header name in table.
+
+ Column Header names are case-insensitive
+
+ Note: this function caches column names for performance. To flush the cache (because columns
+ have been moved or column headers have been changed), {@link #updateHeaders()} must be called.
+
+ @since 3.15 beta 2
+ null value means to use the text font color.
+ + Note that the closest properties object to the text is used, therefore if there is + a conflict between the text paragraph properties and the list style properties for + this level then the text paragraph properties will take precedence. +
+ Returns the level of text properties that this paragraph will follow. + + @return the text level of this paragraph (0-based). Default is 0. +null unsets the Typeface attribute from the underlying xml.
+ + The size is specified using a percentage. + Positive values indicate superscript, negative values indicate subscript. +
+ + @param baselineOffset ++ In Excel 2007 VML Drawings are used to describe properties of cell comments, + although the spec says that VML is deprecated: +
++ The VML format is a legacy format originally introduced with Office 2000 and is included and fully defined + in this Standard for backwards compatibility reasons. The DrawingML format is a newer and richer format + Created with the goal of eventually replacing any uses of VML in the Office Open XML formats. VML should be + considered a deprecated format included in Office Open XML for legacy reasons only and new applications that + need a file format for Drawings are strongly encouraged to use preferentially DrawingML +
+ ++ Warning - Excel is known to Put invalid XML into these files! + For example, >br< without being closed or escaped crops up. +
+ + See 6.4 VML - SpreadsheetML Drawing in Office Open XML Part 4 - Markup Language Reference.pdf + + @author Yegor Kozlov +application/vnd.Openxmlformats-officedocument.Drawing+xml
+ @param rel the namespace relationship holding this Drawing,
+ the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/drawing
+ null
+ Package object,
+ see http://poi.apache.org/oxml4j/.
+
+ Once you have finished working with the Workbook, you should close the package
+ by calling pkg.close, to avoid leaving file handles open.
+
+ Creating a XSSFWorkbook from a file-backed OPC Package has a lower memory
+ footprint than an InputStream backed one.
+
+ @param pkg the OpenXML4J OPC Package object.
+
+ OPCPackage pkg = OPCPackage.open(path);
+ XSSFWorkbook wb = new XSSFWorkbook(pkg);
+ // work with the wb object
+ ......
+ pkg.close(); // gracefully closes the underlying zip file
+ + Note that Excel allows sheet names up to 31 chars in length but other applications + (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars, + others - tRuncate such names to 31 character. +
++ POI's SpreadsheetAPI silently tRuncates the input argument to 31 characters. + Example: + +
+ Sheet sheet = workbook.CreateSheet("My very long sheet name which is longer than 31 chars"); // will be tRuncated
+ assert 31 == sheet.SheetName.Length;
+ assert "My very long sheet name which i" == sheet.SheetName;
+ + Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters: +
+ See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} + for a safe way to create valid names +
+ @param sheetname sheetname to set for the sheet. + @return Sheet representing the new sheet. + @throws IllegalArgumentException if the name is null or invalid + or workbook already contains a sheet with this name + @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal) +null is returned no named range could be found.null if it does not exist
+
+ XSSFWorkbook wb = new XSSFWorkbook(package);
+ for(XSSFSheet sheet : wb){
+
+ }
+ + Note that a sheet could instead be Set to be very hidden, which is different + ({@link #isSheetVeryHidden(int)}) +
+ @param sheetIx Number + @returntrue if sheet is hidden
+ + This is different from the normal hidden status + ({@link #isSheetHidden(int)}) +
+ @param sheetIx sheet index to check + @returntrue if sheet is very hidden
+
+ Calling setSheetHidden(sheetIndex, true) is equivalent to
+ setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN).
+
+ Calling setSheetHidden(sheetIndex, false) is equivalent to
+ setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE).
+
Workbook constants:
+ Workbook.SHEET_STATE_VISIBLE,
+ Workbook.SHEET_STATE_HIDDEN, or
+ Workbook.SHEET_STATE_VERY_HIDDEN.
+ @throws ArgumentException if the supplied sheet index or state is invalid
+ + The calculation chain object specifies the order in which the cells in a workbook were last calculated +
+ + @return theCalculationChain object or null if not defined
+ The external links table specifies details of named ranges etc + * that are referenced from other workbooks, along with the last seen + * values of what they point to.
+ * + *Note that Excel uses index 0 for the current workbook, so the first + * External Links in a formula would be '[1]Foo' which corresponds to + * entry 0 in this list.
+ + * @return theExternalLinksTable list, which may be empty
+ + The default instance : the built-in functions with the Excel Analysis Tool Pack. + To Set / Evaluate custom functions you need to register them as follows: + + + +
+ @return wrapped instance of UDFFinder that allows seeking functions both by index and name ++ Typically you want to force formula recalculation when you modify cell formulas or values + of a workbook previously Created by Excel. When Set to true, this flag will tell Excel + that it needs to recalculate all formulas in the workbook the next time the file is opened. +
++ Note, that recalculation updates cached formula results and, thus, modifies the workbook. + Depending on the version, Excel may prompt you with "Do you want to save the Changes in filename?" + on close. +
+ + @param value true if the application will perform a full recalculation of + workbook values when the workbook is opened + @since 3.8 ++ 9 Jan 2010 +
++ // TODO insert Javadoc here! +
+ @author epp + ++ if the border is on the left or right, no border is displayed. +
++ If the current section is not divided into columns, or the column break + occurs in the last column on the current page when displayed, then the + restart location for text shall be the next page in the document. +
+High(ish) level class for working with .docx files.
+ +This class tries to hide some of the complexity + of the underlying file format, but as it's not a + mature and stable API yet, certain parts of the + XML structure come through. You'll therefore almost + certainly need to refer to the OOXML specifications + from + http://www.ecma-international.org/publications/standards/Ecma-376.htm + at some point in your use.
++ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option any +
+ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option ReadOnly +
+ <w:settings ... > + <w:documentProtection w:edit="forms" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option forms +
+ <w:settings ... > + <w:documentProtection w:edit="comments" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option comments +
+ <w:settings ... > + <w:documentProtection w:edit="trackedChanges" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option trackedChanges +
+ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++
+ <w:settings ... > + <w:documentProtection w:edit="forms" w:enforcement="1"/> ++
+ <w:settings ... > + <w:documentProtection w:edit="comments" w:enforcement="1"/> ++
+ <w:settings ... > + <w:documentProtection w:edit="trackedChanges" w:enforcement="1"/> ++
true if revision tracking is turned on
+ A Paragraph within a Document, Table, Header etc.
+ +A paragraph has a lot of styling information, but the + actual text (possibly along with more styling) is held on + the child {@link XWPFRun}s.
++ If the line height (before any Added spacing) is larger than one or more + characters on the line, all characters will be aligned to each other as + specified by this element. +
++ If this element is omitted on a given paragraph, its value is determined + by the Setting previously Set at any level of the style hierarchy (i.e. + that previous Setting remains unChanged). If this Setting is never + specified in the style hierarchy, then the vertical alignment of all + characters on the line shall be automatically determined by the consumer. +
+ + @return the vertical alignment of this paragraph. ++ If this element is omitted on a given paragraph, + its value is determined by the Setting previously Set at any level of the + style hierarchy (i.e. that previous Setting remains unChanged). If this + Setting is never specified in the style hierarchy, then this property + shall not be applied. Since the paragraph is specified to start on a new + page, it begins page two even though it could have fit on page one. +
+ + @return bool - if page break is Set ++ If this attribute is omitted, its value shall be assumed to be zero. + Negative values are defined such that the text is Moved past the text margin, + positive values Move the text inside the text margin. +
+ + @return indentation or null if indentation is not Set ++ If this attribute is omitted, its value shall be assumed to be zero. + Negative values are defined such that the text is Moved past the text margin, + positive values Move the text inside the text margin. +
+ + @return indentation or null if indentation is not Set +
+ Note, that this call might be expensive since all the picture data is copied into a temporary byte array.
+ You can grab the picture data directly from the underlying package part as follows:
+
+
+ InputStream is1 = GetPackagePart().InputStream;
+
+
http://schemas.openxmlformats.org/officeDocument/2006/relationships/image
+ @return registered POIXMLRelation or null if not found
+ null if parent structure (paragraph > document) is not properly Set.
+
+ This formatting property is a toggle property, which specifies that its
+ behavior differs between its use within a style defInition and its use as
+ direct formatting. When used as part of a style defInition, Setting this
+ property shall toggle the current state of that property as specified up
+ to this point in the hierarchy (i.e. applied to not applied, and vice
+ versa). Setting it to false (or an equivalent) shall
+ result in the current Setting remaining unChanged. However, when used as
+ direct formatting, Setting this property to true or false shall Set the
+ absolute state of the resulting property.
+
+ If this element is not present, the default value is to leave the + formatting applied at previous level in the style hierarchy. If this + element is never applied in the style hierarchy, then bold shall not be + applied to non-complex script characters. +
+ + @param valuetrue if the bold property is applied to
+ this run
+ null if not Set
+ true if the italic property is applied
+ true if the strike property is applied
+ + This formatting property is a toggle property, which specifies that its + behavior differs between its use within a style defInition and its use as + direct formatting. When used as part of a style defInition, Setting this + property shall toggle the current state of that property as specified up + to this point in the hierarchy (i.e. applied to not applied, and vice + versa). Setting it to false (or an equivalent) shall result in the + current Setting remaining unChanged. However, when used as direct + formatting, Setting this property to true or false shall Set the absolute + state of the resulting property. +
++ If this element is not present, the default value is to leave the + formatting applied at previous level in the style hierarchy. If this + element is never applied in the style hierarchy, then strikethrough shall + not be applied to the contents of this run. +
+ + @param valuetrue if the strike property is applied to
+ this run
+ true if the double strike property is applied
+ + The behavior of this break character (the + location where text shall be restarted After this break) shall be + determined by its type values. +
+ @see BreakType ++ The behavior of this break character (the + location where text shall be restarted After this break) shall be + determined by its type (in this case is BreakType.TEXT_WRAPPING as default) and clear attribute values. +
+ @see BreakClear ++ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option any +
+ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option ReadOnly +
+ <w:settings ... > + <w:documentProtection w:edit="[passed editValue]" w:enforcement="1"/> ++
Sketch of XWPFTable class. Only table's text is being hold.
+Specifies the contents of a table present in the document. A table is a set + of paragraphs (and other block-level content) arranged in rows and columns.
+Returns the character count including whitespace, or 0 if the + {@link DocumentSummaryInformation} does not contain this char count.
+ This is the whitespace-including version of {@link SummaryInformation#getCharCount()} + + @return The character count ornull
+ Get if the User Defined Property Set has been updated outside of the + Application.
+If it has (true), the hyperlinks should be updated on document load.
+Gets the version of the Application which wrote the + Property set, stored with the two high order bytes having the major + version number, and the two low order bytes the minor version number.
+This will be 0 if no version is set.
+Returns the VBA digital signature for the VBA project
+ embedded in the document (or null).
Gets the content type of the file (or null).
Gets the content status of the file (or null).
Gets the document language, which is normally unset and empty
+ (or null).
Gets the document version as a string, which is normally unset and empty
+ (or null).
Creates the most specific {@link PropertySet} from an entry + in the specified POIFS Directory. This is preferrably a {@link + DocumentSummaryInformation} or a {@link SummaryInformation}. If + the specified entry does not contain a property Set stream, an + exception is thrown. If no entry is found with the given name, + an exception is thrown.
+ + @param dir The directory to find the PropertySet in + @param name The name of the entry Containing the PropertySet + @return The Created {@link PropertySet}. + @if there is no entry with that name + @if the stream does not + contain a property Set. + @if some I/O problem occurs. + @exception EncoderFallbackException if the specified codepage is not + supported. +To process this data, you may wish to make use of the + {@link Thumbnail} class. The raw data is generally + an image in WMF or Clipboard (BMP?) format
+typedef struct tagCLIPDATA {
+ // cbSize is the size of the buffer pointed To
+ // by pClipData, plus sizeof(ulClipFmt)
+ ULONG cbSize;
+ long ulClipFmt;
+ BYTE* pClipData;
+ } CLIPDATA;
+
+ See
+ msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp.
+ Turns a codepage number into the equivalent character encoding's + name.
+ + @param codepage The codepage number + + @return The character encoding's name. If the codepage number is 65001, + the encoding name is "UTF-8". All other positive numbers are mapped to + "cp" followed by the number, e.g. if the codepage number is 1252 the + returned character encoding name will be "cp1252". + + @exception UnsupportedEncodingException if the specified codepage is + less than zero. +| Value | +Description | +
|---|---|
| 0 | +No restriction | +
| 2 | +Read-only recommended | +
| 4 | +Read-only enforced | +
The highest well-known property ID. Applications are free to use + higher values for custom purposes. (This value is based on Office 12, + earlier versions of Office had lower values)
++ Returns much (but not all) of the textual content of the file, + suitable for indexing by something like Apache Lucene, or used + by Apache Tika, but not really intended for display to the user. +
+-1 means that
+ the scope of the name will be ignored and the parser will match named ranges only by name
+
+ @return the parsed formula tokens
+ null, typically empty array
+ null if there isn't one for the given name.
+ null
+ null
+ null if the formula cell is not shared/array/table,
+ or if the specified formula is not the the first in the group.
+ null.
+ null.
+ null to remove all protection
+ shouldProtectObjects are protected
+ shouldProtectScenarios are protected
+ true, this record represents an error cell value, otherwise this record represents a boolean cell value
+ null
+ null
+ @return encoded size of the formula tokens (does not include 2 bytes for ushort length)
+ Description: the default characterset. for the workbook
+REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
+Use {@link CodePageUtil} to turn these values into Java code pages + to encode/decode strings.
+ @version 2.0-pre ++ Most records construct themselves from {@link RecordInputStream}. + This class assumes that a {@link ContinueRecord} record break always occurs at the type boundary, + however, it is not always so. +
+ Two attachments to Bugzilla 50779 + demonstrate that a CONTINUE break can appear right in between two bytes of a unicode character + or between two bytes of ashort. The problematic portion of the data is
+ in a Asian Phonetic Settings Block (ExtRst) of a UnicodeString.
+
+ {@link RecordInputStream} greedily requests the bytes to be read and stumbles on such files with a
+ "Not enough data (1) to read requested (2) bytes" exception. The ContinuableRecordInput
+ class circumvents this "type boundary" rule and Reads data byte-by-byte rolling over CONTINUE if necessary.
+
+ YK: For now (March 2011) this class is only used to read + @link NPOI.HSSF.Record.Common.UnicodeString.ExtRst} blocks of a UnicodeString. + +
+ + @author Yegor Kozlov +| Mask | Description |
|---|---|
| 0x01 | is16bitEncoded |
| 0x04 | hasExtendedData |
| 0x08 | isRichText |
null if it is currently unSet.
+ DConRef Structure
+ [MS-XLS s.
+ 2.4.86], and the contained DConFile structure
+
+ [MS-XLS s. 2.5.69]. This in turn contains a XLUnicodeStringNoCch
+
+ [MS-XLS s. 2.5.296].
+
+ + _______________________________ + | DConRef | + (bytes) +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+ + | ref |cch| stFile | un| + +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+ + | + _________|_____________________ + |DConFile / XLUnicodeStringNoCch| + +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+ + (bits) |h| reserved | rgb | + +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+ ++ Where +
DConFile.h = 0x00 if the characters inrgb are single byte, and
+ DConFile.h = 0x01 if they are double byte. DConRef.un = 2. Otherwise it is 1.DConFile.rgb = (2 * DConRef.cch). Otherwise it is equal to
+ DConRef.cchDConRef.rgb starts with 0x01 if it is an external reference,
+ and with 0x02 if it is a self-reference.sid = {@value}
+ rgb field of a
+ XLUnicodeStringNoCch. Therefore it will contain at least one leading special
+ character (0x01 or 0x02) and probably other ones.
+ @see
+ DConFile [MS-XLS s. 2.5.77] and
+
+ VirtualPath [MS-XLS s. 2.5.69]
+
+ true if drop down arrow should be suppressed when list validation is
+ used, false otherwise
+ + If the type of the SupBook record is same-sheet referencing, Add-In referencing, + DDE data source referencing, or OLE data source referencing, + then no scope is specified and this value MUST be -2. Otherwise, + the scope must be set as follows: +
-2 Workbook-level reference that applies to the entire workbook.-1 Sheet-level reference. >=0 Sheet-level reference. This specifies the first sheet in the reference.
+ + If the SupBook type is unused or external workbook referencing, + then this value specifies the zero-based index of an external sheet name, + see {@link org.apache.poi.hssf.record.SupBookRecord#getSheetNames()}. + This referenced string specifies the name of the first sheet within the external workbook that is in scope. + This sheet MUST be a worksheet or macro sheet. +
++ If the supporting link type is self-referencing, then this value specifies the zero-based index of a + {@link org.apache.poi.hssf.record.BoundSheetRecord} record in the workbook stream that specifies + the first sheet within the scope of this reference. This sheet MUST be a worksheet or a macro sheet. +
+FtCblsSubRecord and
+ fill its data with the default values
+ FtPioGrbitSubRecord and
+ fill its data with the default values
+ FtPioGrbitSubRecord and
+ fill its data with the default values
+ null
+ null if the specified record is not interpreted by POI.
+ null
+ if stream was empty
+ null if not present.
+ null if
+ this pass didn't return a record that's
+ suitable for returning (eg was a continue record).
+ null if unknown to POI
+ null if textExpr does not begin with '='
+ null if numberStr is null
+ null if timeStr is null
+ null for default YYYYMMDD
+ @return null if timeStr is null
+ null
+ + One important concept worth considering Is that of font size. One of the + difficulties in Converting Graphics calls into escher Drawing calls Is that + Excel does not have the concept of absolute pixel positions. It measures + it's cell widths in 'Chars' and the cell heights in points. + Unfortunately it's not defined exactly what a type of Char it's + measuring. Presumably this Is due to the fact that the Excel will be + using different fonts on different platforms or even within the same + platform. + + Because of this constraint we've had to calculate the + verticalPointsPerPixel. This the amount the font should be scaled by when + you Issue commands such as DrawString(). A good way to calculate this + Is to use the follow formula: + ++ + @author Glen Stampoultzis (glens at apache.org) ++ multipler = GroupHeightInPoints / heightOfGroup ++ + The height of the Group Is calculated fairly simply by calculating the + difference between the y coordinates of the bounding box of the shape. The + height of the Group can be calculated by using a convenience called +HSSFClientAnchor.GetAnchorHeightInPoints() . +
0 means Context (Default), 1 means Left To Right, + and 2 means Right to Left
+ + @return order - the reading order (0,1,2) +s.
+ null otherwise
+ null otherwise
+ null otherwise
+ +
null
+ for the (conservative) assumption that any cell may have its definition changed after
+ evaluation begins.
+ null for default (AnalysisToolPak only)
+ null
+ for the (conservative) assumption that any cell may have its definition changed after
+ evaluation begins.
+ @param udfFinder pass null for default (AnalysisToolPak only)
+ + int EvaluatedCellType = evaluator.EvaluateInCell(cell).CellType; ++ Be aware that your cell value will be Changed to hold the + result of the formula. If you simply want the formula + value computed for you, use {@link #EvaluateFormulaCell(HSSFCell)} + @param cell +
+ Please note, that this method works correctly only for workbooks + with default font size (Arial 10pt for .xls). + If the default font is changed the resized image can be streched vertically or horizontally. +
+
+ resize(1.0,1.0) keeps the original size,
+ resize(0.5,0.5) resize to 50% of the original,
+ resize(2.0,2.0) resizes to 200% of the original.
+ resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE}) resizes to the dimension of the embedded image.
+
null to remove protection
+ + 10 - 10% + 20 - 20% + ... + 100 - 100% + ... + 400 - 400% ++ + @param scale window zoom magnification + @throws IllegalArgumentException if scale is invalid +
indexes.
+
+ @param indexes
+ Title: HSSFCellRangeAddress
+Description: + Implementation of the cell range Address lists,like Is described in + OpenOffice.org's Excel Documentation . + In BIFF8 there Is a common way to store absolute cell range Address + lists in several records (not formulas). A cell range Address list + consists of a field with the number of ranges and the list of the range + Addresses. Each cell range Address (called an AddR structure) Contains + 4 16-bit-values.
+Copyright: Copyright (c) 2004
+Company:
+ @author Dragos Buleandra (dragos.buleandra@trade2b.ro) + @version 2.0-pre +A class describing attributes of the Big Block Size
+2.3.4.7 ECMA-376 Document Encryption Key Generation (Standard Encryption)
+ 2.3.4.11 Encryption Key Generation (Agile Encryption)
The encryption key for ECMA-376 document encryption [ECMA-376] using agile + encryption MUST be generated by using the following method, which is derived from PKCS #5: + Password-Based Cryptography Version 2.0 [RFC2898].
+ +Let H() be a hashing algorithm as determined by the PasswordKeyEncryptor.hashAlgorithm + element, H_n be the hash data of the n-th iteration, and a plus sign (+) represent concatenation. + The password MUST be provided as an array of Unicode characters. Limitations on the length of the + password and the characters used by the password are implementation-dependent. + The initial password hash is generated as follows:
+ + +H_0 = H(salt + password)+ +
The salt used MUST be generated randomly. The salt MUST be stored in the + PasswordKeyEncryptor.saltValue element contained within the \EncryptionInfo stream as + specified in section 2.3.4.10. The hash is then iterated by using the following approach:
+ +H_n = H(iterator + H_n-1)+ +
where iterator is an unsigned 32-bit value that is initially set to 0x00000000 and then incremented + monotonically on each iteration until PasswordKey.spinCount iterations have been performed. + The value of iterator on the last iteration MUST be one less than PasswordKey.spinCount.
+ +For POI, H_final will be calculated by {@link #generateKey(byte[],HashAlgorithm,byte[],int)}
+ + @param password + @param hashAlgorithm + @param salt + @param spinCount + @return the hashed password +2.3.4.12 Initialization Vector Generation (Agile Encryption)
+ +Initialization vectors are used in all cases for agile encryption. An initialization vector MUST be + generated by using the following method, where H() is a hash function that MUST be the same as + specified in section 2.3.4.11 and a plus sign (+) represents concatenation:
+2.3.4.11 Encryption Key Generation (Agile Encryption)
+ +The final hash data that is used for an encryption key is then generated by using the following + method:
+ +H_final = H(H_n + blockKey)+ +
where blockKey represents an array of bytes used to prevent two different blocks from encrypting + to the same cipher text.
+ +If the size of the resulting H_final is smaller than that of PasswordKeyEncryptor.keyBits, the key + MUST be padded by appending bytes with a value of 0x36. If the hash value is larger in size than + PasswordKeyEncryptor.keyBits, the key is obtained by truncating the hash value.
+ + @param passwordHash + @param hashAlgorithm + @param blockKey + @param keySize + @return intermediate key ++ Use {@link #getLength()} to Get the size of that data that can be safely read from the stream. + Just Reading to the end of the input stream is not sufficient because there are + normally pAdding bytes that must be discarded +
+ + @param dir the node to read from + @return decrypted stream ++ The length variable is Initialized in {@link #getDataStream(NPOI.POIFS.FileSystem.DirectoryNode)}, + an attempt to call GetLength() prior to GetDataStream() will result in InvalidOperationException. +
+ + @return length of the encrypted data + @throws InvalidOperationException if {@link #getDataStream(NPOI.POIFS.FileSystem.DirectoryNode)} + was not called +true always
+ Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream. The File will be opened read-only
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ + @param file the File from which to read the data + + @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream.
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ + @param file the File from which to read or read/write the data + @param readOnly whether the POIFileSystem will only be used in read-only mode + + @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from an open FileChannel. This uses + * less memory than creating from an InputStream. The stream will + * be used in read-only mode.
+ * + *Note that with this constructor, you will need to call {@link #close()} + * when you're done to have the underlying Channel closed, as the channel is + * kept open during normal operation to read the data out.
+ * + * @param channel the FileChannel from which to read the data + * + * @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from an open FileChannel. This uses + less memory than creating from an InputStream.
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying Channel closed, as the channel is + kept open during normal operation to read the data out.
+ + @param channel the FileChannel from which to read or read/write the data + @param readOnly whether the POIFileSystem will only be used in read-only mode + + @exception IOException on errors reading, or on invalid data +true
+ for markSupported()). In the unlikely case that the caller has such a stream
+ and needs to use it After this constructor completes, a work around is to wrap the
+ stream in order to trap the close() call. A convenience method (
+ CreateNonClosingInputStream()) has been provided for this purpose:
+ + InputStream wrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is); + HSSFWorkbook wb = new HSSFWorkbook(wrappedStream); + is.Reset(); + doSomethingElse(is); ++ Note also the special case of MemoryStream for which the close() + method does nothing. +
+ MemoryStream bais = ... + HSSFWorkbook wb = new HSSFWorkbook(bais); // calls bais.Close() ! + bais.Reset(); // no problem + doSomethingElse(bais); ++ + @param stream the InputStream from which to read the data + + @exception IOException on errors Reading, or on invalid data +
false if an exception is currently being thrown in the calling method
+ null.
+
+ @return the dataSize
+ null
+ if no data was embedded. Note that an embedding may provide information about
+ the data, but the actual data is not included. (So label, filename etc. are
+ available, but this method returns null.)
+
+ @return the dataBuffer
+ Returns the last name in the document path's name sequence. + If the document path's name sequence is empty, then the empty string is returned.
+ + @since 2016-04-09 + @return The last name in the document path's name sequence, or empty string if this is the root path +Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream.
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ @param readOnly whether the POIFileSystem will only be used in read-only mode + + @param file the File from which to read the data + + @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream. The File will be opened read-only
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ + @param file the File from which to read the data + + @exception IOException on errors reading, or on invalid data +The value returned by this method is equal to the value that would + be returned by Arrays.asList(a).toString(), unless a + is null, in which case "null" is returned.
+ + @param a the array whose string representation to return + @return a string representation of a + @see #deepToString(Object[]) + @since 1.5 +read() method if
+ the current position is less than the limit.
+ Creates a {@link ClassID} from a human-readable representation of the Class ID in standard
+ format "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}".
Provides constants for understanding numeric codepages, + along with utilities to translate these into Java Character Sets.
+Codepage 037, a special case
+Codepage for SJIS
+Codepage for GBK, aka MS936
+Codepage for MS949
+Codepage for UTF-16
+Codepage for UTF-16 big-endian
+Codepage for Windows 1250
+Codepage for Windows 1251
+Codepage for Windows 1252
+Codepage for Windows 1253
+Codepage for Windows 1254
+Codepage for Windows 1255
+Codepage for Windows 1256
+Codepage for Windows 1257
+Codepage for Windows 1258
+Codepage for Johab
+Codepage for Macintosh Roman (Java: MacRoman)
+Codepage for Macintosh Japan (Java: unknown - use SJIS, cp942 or + cp943)
+Codepage for Macintosh Chinese Traditional (Java: unknown - use Big5, + MS950, or cp937)
+Codepage for Macintosh Korean (Java: unknown - use EUC_KR or + cp949)
+Codepage for Macintosh Arabic (Java: MacArabic)
+Codepage for Macintosh Hebrew (Java: MacHebrew)
+Codepage for Macintosh Greek (Java: MacGreek)
+Codepage for Macintosh Cyrillic (Java: MacCyrillic)
+Codepage for Macintosh Chinese Simplified (Java: unknown - use + EUC_CN, ISO2022_CN_GB, MS936 or cp935)
+Codepage for Macintosh Romanian (Java: MacRomania)
+Codepage for Macintosh Ukrainian (Java: MacUkraine)
+Codepage for Macintosh Thai (Java: MacThai)
+Codepage for Macintosh Central Europe (Latin-2) + (Java: MacCentralEurope)
+Codepage for Macintosh Iceland (Java: MacIceland)
+Codepage for Macintosh Turkish (Java: MacTurkish)
+Codepage for Macintosh Croatian (Java: MacCroatian)
+Codepage for US-ASCII
+Codepage for KOI8-R
+Codepage for ISO-8859-1
+Codepage for ISO-8859-2
+Codepage for ISO-8859-3
+Codepage for ISO-8859-4
+Codepage for ISO-8859-5
+Codepage for ISO-8859-6
+Codepage for ISO-8859-7
+Codepage for ISO-8859-8
+Codepage for ISO-8859-9
+Codepage for ISO-2022-JP
+Another codepage for ISO-2022-JP
+Yet another codepage for ISO-2022-JP
+Codepage for ISO-2022-KR
+Codepage for EUC-JP
+Codepage for EUC-KR
+Codepage for GB2312
+Codepage for GB18030
+Another codepage for US-ASCII
+Codepage for UTF-8
+Codepage for Unicode
+Turns a codepage number into the equivalent character encoding's + name.
+ + @param codepage The codepage number + + @return The character encoding's name. If the codepage number is 65001, + the encoding name is "UTF-8". All other positive numbers are mapped to + "cp" followed by the number, e.g. if the codepage number is 1252 the + returned character encoding name will be "cp1252". + + @exception UnsupportedEncodingException if the specified codepage is + less than zero. +bytesToDump bytes to an output stream.
+
+ @param in The stream to read from
+ @param out The output stream
+ @param start The index to use as the starting position for the left hand side label
+ @param bytesToDump The number of bytes to output. Use -1 to read until the end of file.
+ If the length of
The first byte read is stored into element
The
+read(b, 0, b.length)
This method blocks until input data is available, end of file is + detected, or an exception is thrown.
+ + If
The first byte read is stored into element
In every case, elements
The
The
Note that while some implementations of {@code InputStream} will return + the total number of bytes in the stream, many will not. It is + never correct to use the return value of this method to allocate + a buffer intended to hold all data in this stream.
+ +A subclass' implementation of this method may choose to throw an + {@link IOException} if this input stream has been closed by + invoking the {@link #close()} method.
+ +The {@code available} method for class {@code InputStream} always + returns {@code 0}.
+ +This method should be overridden by subclasses.
+ The
The
The general contract of
Marking a closed stream should not have any effect on the stream.
+ + The
The general contract of
The method
+ hashCode = 1;
+ Iterator i = list.Iterator();
+ while (i.HasNext()) {
+ Object obj = i.Next();
+ hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
+ }
+
+
+ This ensures that list1.Equals(list2) implies that
+ list1.HashCode()==list2.HashCode() for any two lists, list1 and
+ list2, as required by the general contract of Object.HashCode.
+
+ I am happy is someone wants to re-implement this without using the + internal list and hashmap. If so could you please make sure that + you can add elements half way into the list and have the value-key mappings + update
+byte.length bytes of data from this
+ input stream into an array of bytes. This method blocks until some
+ input is available.
+
+ simulate java FilterInputStream
+ len bytes of data from this input stream
+ into an array of bytes.If len is not zero, the method
+ blocks until some input is available; otherwise, no
+ bytes are read and0 is returned.
+
+ simulate java FilterInputStream
+
+ hashCode = 1;
+ Iterator i = list.Iterator();
+ while (i.HasNext()) {
+ Object obj = i.Next();
+ hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
+ }
+
+
+ This ensures that list1.Equals(list2) implies that
+ list1.HashCode()==list2.HashCode() for any two lists, list1 and
+ list2, as required by the general contract of Object.HashCode.
+ + References: +
epsilon of value, in absolute terms.
+ @param maxDenominator maximum denominator value allowed.
+ @param maxIterations maximum number of convergents
+ @throws RuntimeException if the continued fraction failed to
+ converge.
+ @throws IllegalArgumentException if value > Integer.MAX_VALUE
+ + Syntax: MAXIFS(data_range, criteria_range1, criteria1, [criteria_range2, criteria2]) +
++ Syntax: MINIFS(min_range, criteria_range1, criteria1, [criteria_range2, criteria2]) +
+true if date is weekend, false otherwise.
+ true if date is a holiday, false otherwise.
+ 1 is not a workday, 0 otherwise.
+ true if aDate is between start and end dates, false otherwise.
+ | Value | Days per Month | Days per Year |
|---|---|---|
| 0 (default) | 30 | 360 |
| 1 | actual | actual |
| 2 | actual | 360 |
| 3 | actual | 365 |
| 4 | 30 | 360 |
null signifying that the cell is not present (or blank)
+ @return null if the supplied cell is null or blank
+ + int EvaluatedCellType = Evaluator.EvaluateInCell(cell).CellType; ++ Be aware that your cell value will be Changed to hold the + result of the formula. If you simply want the formula + value computed for you, use {@link #EvaluateFormulaCellEnum(Cell)}} + @param cell + @return the {@code cell} that was passed in, allowing for chained calls +
+ int EvaluatedCellType = Evaluator.EvaluateFormulaCell(cell); ++ Be aware that your cell will hold both the formula, and the result. If you want the cell + Replaced with the result of the formula, use {@link #EvaluateInCell(NPOI.SS.UserModel.Cell)} + @param cell The cell to Evaluate + @return -1 for non-formula cells, or the type of the formula result +
+ ICellType EvaluatedCellType = Evaluator.EvaluateFormulaCellEnum(cell); ++ Be aware that your cell will hold both the formula, + and the result. If you want the cell Replaced with + the result of the formula, use {@link #Evaluate(NPOI.SS.UserModel.Cell)} } + @param cell The cell to Evaluate + @return The type of the formula result (the cell's type remains as CellType.FORMULA however) + If cell is not a formula cell, returns {@link CellType#_NONE} rather than throwing an exception. + @since POI 3.15 beta 3 +
Return will have no workbook set if it's actually in our own workbook
+Return will have no workbook set if it's actually in our own workbook
+null (possibly {@link BlankEval}). The specified indexes should be absolute
+ indexes in the sheet and not relative indexes within the area.
+
+ public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
+ // ...
+ Eval arg0 = args[0];
+ if(arg0 is ErrorEval) {
+ return arg0;
+ }
+ if(!(arg0 is AreaEval)) {
+ return ErrorEval.VALUE_INVALID;
+ }
+ double temp = 0;
+ AreaEval area = (AreaEval)arg0;
+ ValueEval[] values = area.LittleEndianConstants.BYTE_SIZE;
+ for (int i = 0; i < values.Length; i++) {
+ ValueEval ve = values[i];
+ if(ve is ErrorEval) {
+ return ve;
+ }
+ if(!(ve is NumericValueEval)) {
+ return ErrorEval.VALUE_INVALID;
+ }
+ temp += ((NumericValueEval)ve).NumberValue;
+ }
+ // ...
+ }
+
+ In this example, if any error is encountered while Processing the arguments, an error is
+ returned immediately. This code is difficult to refactor due to all the points where errors
+ are returned.
+ public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
+ try {
+ // ...
+ AreaEval area = GetAreaArg(args[0]);
+ double temp = sumValues(area.LittleEndianConstants.BYTE_SIZE);
+ // ...
+ } catch (EvaluationException e) {
+ return e.GetErrorEval();
+ }
+ }
+
+ private static AreaEval GetAreaArg(Eval arg0){
+ if (arg0 is ErrorEval) {
+ throw new EvaluationException((ErrorEval) arg0);
+ }
+ if (arg0 is AreaEval) {
+ return (AreaEval) arg0;
+ }
+ throw EvaluationException.InvalidValue();
+ }
+
+ private double sumValues(ValueEval[] values){
+ double temp = 0;
+ for (int i = 0; i < values.Length; i++) {
+ ValueEval ve = values[i];
+ if (ve is ErrorEval) {
+ throw new EvaluationException((ErrorEval) ve);
+ }
+ if (!(ve is NumericValueEval)) {
+ throw EvaluationException.InvalidValue();
+ }
+ temp += ((NumericValueEval) ve).NumberValue;
+ }
+ return temp;
+ }
+
+ It is not mandatory to use EvaluationException, doing so might give the following advantages:null for default (AnalysisToolPak only)
+ null if the supplied cell is null or blank
+ null.
+ | A | B | C | D | |
|---|---|---|---|---|
| 1 | 15 | 20 | 25 | |
| 2 | 200 | |||
| 3 | 300 | |||
| 3 | 400 |
| A | B | C | D | |
|---|---|---|---|---|
| 1 | 15 | 20 | 25 | |
| 2 | 1215 | 1220 | #VALUE! | 200 |
| 3 | 1315 | 1320 | #VALUE! | 300 |
| 4 | #VALUE! | #VALUE! | #VALUE! | 400 |
null, possibly empty string.
+ null.
+ nulls OK.
+ @param ptgs may be null
+ @return Never null (Possibly empty if the supplied null)
+ nulls OK.
+
+ @param formula may be null
+ @return possibly null (if the supplied null)
+ null if this formula is not part of an array or shared formula.
+ -1 means that
+ * the scope of the name will be ignored and the parser will match names only by name
+ *
+ * @return array of parsed tokens
+ * @throws FormulaParseException if the formula is unparsable
+ + A$1 + $A$1 : $B1 + A1 ....... C2 + Sheet1 !$A1 + a..b!A1 + 'my sheet'!A1 + .my.sheet!A1 + 'my sheet':'my alt sheet'!A1 + .my.sheet1:.my.sheet2!$B$2 + my.named..range. + 'my sheet'!my.named.range + .my.sheet!my.named.range + foo.bar(123.456, "abc") + 123.456 + "abc" + true + [Foo.xls]!$A$1 + [Foo.xls]'my sheet'!$A$1 + [Foo.xls]!my.named.range ++ +
+ Table1[col] + Table1[[#Totals],[col]] + Table1[#Totals] + Table1[#All] + Table1[#Data] + Table1[#Headers] + Table1[#Totals] + Table1[#This Row] + Table1[[#All],[col]] + Table1[[#Headers],[col]] + Table1[[#Totals],[col]] + Table1[[#All],[col1]:[col2]] + Table1[[#Data],[col1]:[col2]] + Table1[[#Headers],[col1]:[col2]] + Table1[[#Totals],[col1]:[col2]] + Table1[[#Headers],[#Data],[col2]] + Table1[[#This Row], [col1]] + Table1[ [col1]:[col2] ] ++ @param tableName + @return +
+ my.named...range. + foo.bar(123.456, "abc") + 123.456 + "abc" + true ++
null
+ @param part1
+ @param part2 may be null
+ null (and leaves {@link #_pointer} unchanged if a proper range part does not parse out
+ null result
+ @return The sheet name as an identifier null if '!' is not found in the right place
+ null
+ * @return Ptg a null is returned if we're in an IF formula, it needs extreme manipulation and is handled in this Function
+
+
+ Syntax :
+ AVERAGEIF ( range, criteria, avg_range )
+
| range | The range over which criteria is applied. Also used for included values when the third parameter is not present |
|---|---|
| criteria | The value or expression used to filter rows from range |
| avg_range | Locates the top-left corner of the corresponding range of addends - values to be included (after being selected by the criteria) |
+ Syntax :
+ AverageIfs ( average_range, criteria_range1, criteria1,
+ [criteria_range2, criteria2], ...)
+
criteriaRanges argument contains the same number of rows and columns
+ as the avgRange argument
+
+ @throws EvaluationException if
+ aeAvg
+ @param predicates array of predicates, a predicate for each value in ranges
+ @param aeAvg the range to calculate
+
+ @return the computed value
+ Some utils for Converting from and to any base
+ + @author cedric dot walter @ gmail dot com ++ If there are other subtotals within argument refs (or nested subtotals), + these nested subtotals are ignored to avoid double counting. +
+ + @see Subtotal ++ Syntax: COUNTBLANK ( range ) +
| range | is the range of cells to count blanks |
|---|
| range | is the range of cells to be Counted based on the criteria |
|---|---|
| criteria | is used to determine which cells to Count |
null if the arg evaluates to blank.
+ + Syntax: COUNTIFS(criteria_range1, criteria1, [criteria_range2, criteria2]) +
+Calculates the number of days between two dates based on a 360-day year + (twelve 30-day months), which is used in some accounting calculations. Use + this function to help compute payments if your accounting system is based on + twelve 30-day months.
+ + {@code DAYS360(start_date,end_date,[method])} + +
+ Syntax:
+ ERROR.TYPE(errorValue)
+ Returns a number corresponding to the error type of the supplied argument.
++
| errorValue | Return Value |
| #NULL! | 1 |
| #DIV/0! | 2 |
| #VALUE! | 3 |
| #REF! | 4 |
| #NAME? | 5 |
| #NUM! | 6 |
| #N/A! | 7 |
| everything else | #N/A! |
double representing periodic payment amount.
+ double representing interest portion of payment.
+
+ @see #pmt(double, int, double, double, int)
+ @see #fv(double, int, double, double, int)
+ double representing principal portion of payment.
+
+ @see #pmt(double, int, double, double, int)
+ @see #ipmt(double, int, int, double, double, bool)
+ double representing future principal value.
+
+ p(1+r)^n + y(1+rt)((1+r)^n-1)/r + f=0 ...{when r!=0}
+ ny + p + f=0 ...{when r=0}
+
+ null,
+ nor are any of its elements.
+ @param ec primarily used to identify the source cell Containing the formula being Evaluated.
+ may also be used to dynamically create reference evals.
+ @return never null. Possibly an instance of | reference | typically an area reference, possibly a union of areas |
|---|---|
| array | a literal array value (currently not supported) |
| row_num | selects the row within the array or area reference |
| column_num | selects column within the array or area reference. default Is 1 |
| area_num | used when reference Is a union of areas |
null if text cannot be parsed.
+ null if there is a syntax error in any escape sequence
+ (the typical syntax error is a single quote character not followed by another).
+ + Starting with the guess, the method cycles through the calculation until the result + is accurate within 0.00001 percent. If IRR can't find a result that works + after 20 tries, the Double.NaN is returned. +
++ The implementation is inspired by the NewtonSolver from the Apache Commons-Math library, + @see http://commons.apache.org +
+ + @param values the income values. + @param guess the initial guess of irr. + @return the irr value. The method returnsDouble.NaN
+ if the maximum iteration count is exceeded
+
+ @see
+ http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution
+ @see
+ http://en.wikipedia.org/wiki/Newton%27s_method
+ | Input Return | Value | Thrown Error |
|---|---|---|
| 5 | 4 | |
| 2.9 | 2 | |
| "5" | 4 | |
| "2.18e1" | 21 | |
| "-$2" | -3 | * |
| FALSE | -1 | * |
| TRUE | 0 | |
| "TRUE" | #REF! | |
| "abc" | #REF! | |
| "" | #REF! | |
| <blank> | #VALUE! |
| Value | Matching Behaviour |
|---|---|
| 1 | (default) Find the largest value that Is less than or equal to lookup_value. + The lookup_array must be in ascending order*. |
| 0 | Find the first value that Is exactly equal to lookup_value. + The lookup_array can be in any order. |
| -1 | Find the smallest value that Is greater than or equal to lookup_value. + The lookup_array must be in descending order*. |
Returns the modified internal rate of return for a series of periodic cash flows. MIRR considers both the cost + of the investment and the interest received on reinvestment of cash.
+ + Values is an array or a reference to cells that contain numbers. These numbers represent a series of payments (negative values) and income (positive values) occurring at regular periods. +Implementation for Excel Oct2Dec() function.
++ Converts an octal number to decimal. +
+
+ Syntax:
Oct2Dec (number )
+
Implementation for Excel QUOTIENT () function.
+
+ Syntax:
QUOTIENT(Numerator,Denominator)
+
+ Numerator is the dividend. + Denominator is the divisor. + + Returns the integer portion of a division. Use this function when you want to discard the remainder of a division. +
+ + If either enumerator/denominator is non numeric, QUOTIENT returns the #VALUE! error value. + If denominator is Equals to zero, QUOTIENT returns the #DIV/0! error value. + + @author cedric dot walter @ gmail dot com +
+
+ Syntax :
+ SUBTOTAL ( functionCode, ref1, ref2 ... )
+
| functionCode | (1-11) Selects the underlying aggregate function to be used (see table below) |
| ref1, ref2 ... | Arguments to be passed to the underlying aggregate function |
| functionCode | Aggregate Function |
|---|---|
| 1 | AVERAGE |
| 2 | COUNT |
| 3 | COUNTA |
| 4 | MAX |
| 5 | MIN |
| 6 | PRODUCT |
| 7 | STDEV |
| 8 | STDEVP * |
| 9 | SUM |
| 10 | VAR * |
| 11 | VARP * |
| 101-111 | * |
+
+ Syntax :
+ SUMIF ( range, criteria, sum_range )
+
| range | The range over which criteria is applied. Also used for addend values when the third parameter is not present |
|---|---|
| criteria | The value or expression used to filter rows from range |
| sum_range | Locates the top-left corner of the corresponding range of addends - values to be added (after being selected by the criteria) |
+ Syntax :
+ SUMIFS ( sum_range, criteria_range1, criteria1,
+ [criteria_range2, criteria2], ...)
+
criteria predicate is valid, i.e. not an error
+
+ @throws EvaluationException if there are criteria which resulted in Errors.
+ criteriaRanges argument contains the same number of rows and columns
+ as the sumRange argument
+
+ @throws EvaluationException if
+ aeSum
+ @param predicates array of predicates, a predicate for each value in ranges
+ @param aeSum the range to sum
+
+ @return the computed value
+ null if there is any problem converting the text
+ null if either workbook or sheet is not found
+ null
+ the current workbook is assumed. Note - to Evaluate formulas which use multiple workbooks,
+ a {@link CollaboratingWorkbooksEnvironment} must be set up.
+ @param sheetName the name of the sheet Containing the reference. May be null
+ (when null.
+ @param refStrPart2 the second part of the area reference. For single cell references this
+ parameter must be null
+ @param isA1Style specifies the format for Title: Area 3D Ptg - 3D reference (Sheet + Area)
+Description: Defined an area in Extern Sheet.
+REFERENCE:
+ + This is HSSF only, as it matches the HSSF file format way of + referring to the sheet by an extern index. The XSSF equivalent + is {@link Area3DPxg} +Title: XSSF Area 3D Reference (Sheet + Area)
+Description: Defined an area in an external or different sheet.
+REFERENCE:
+ +This is XSSF only, as it stores the sheet / book references + in String form. The HSSF equivalent using indexes is {@link Area3DPtg}
+For example, $E5:B$10 becomes B5:$E$10
This is XSSF only, as it stores the sheet / book references + in String form. The HSSF equivalent using indexes is {@link NameXPtg}
+Title: XSSF 3D Reference
+Description: Defines a cell in an external or different sheet.
+REFERENCE:
+ +This is XSSF only, as it stores the sheet / book references + in String form. The HSSF equivalent using indexes is {@link Ref3DPtg}
+null
+ null or {@link #RefErrorPtg} if no change was made
+
+ @param aptg
+ @return
+ null or {@link #AreaErrPtg} if no change was made
+
+ @param aptg
+ @return null, AreaErrPtg, or modified aptg
+ Ptg
+ tokens into human readable text form. In formula expressions, a sheet name always has a
+ trailing '!' so there is little chance for ambiguity. It doesn't matter too much what this
+ method returns but it is worth noting the likely consumers of these formula text strings:
+ + + @return+
+ Input Result Comments + "A1" true + "a111" true + "AA" false + "aa1" true + "A1A" false + "A1A1" false + "A$1:$C$20" false Not a plain cell reference + "SALES20080101" true +Still needs delimiting even though well out of range
null if the function name is unknown.
+
+ @param name Name of function.
+ @return Function executor.
+ + In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable. + With this method you can control how POI handles such missing references: +
GetMaxRows() - 1
+ GetMaxColumns() - 1
+ IV or XFD).
+ + Filtering data is a quick and easy way to find and work with a subset of data in a range of cells or table. + For example, you can filter to see only the values that you specify, filter to see the top or bottom values, + or filter to quickly see duplicate values. +
+ + TODO YK: For now (Aug 2010) POI only supports Setting a basic autofilter on a range of cells. + In future, when we support more auto-filter functions like custom criteria, sort, etc. we will add + corresponding methods to this interface. +null if there is not a built-in format at that index
+ + Automatically converts "text" to excel's format string to represent text. +
+ @param pFmt string matching a built-in format + @return index of format or -1 if undefined. ++ Cells can be numeric, formula-based or string-based (text). The cell type + specifies this. String cells cannot conatin numbers and numeric cells cannot + contain strings (at least according to our model). Client apps should do the + conversions themselves. Formula cells have the formula string, as well as + the formula result, which can be numeric or string. +
++ Cells should have their number (0 based) before being Added to a row. +
+If the cell currently contains a value, the value will + be converted to match the new type, if possible. Formatting + is generally lost in the process however.
+If what you want to do is get a String value for your + numeric cell, stop!. This is not the way to do it. + Instead, for fetching the string value of a numeric or boolean + or date cell, use {@link DataFormatter} instead.
+"SUM(C4:E4)".
+ A1 style address of this cell
+ @since 3.14beta2
+ null.
+ null.
+ + Specifies that the current drawing shall move and + resize to maintain its row and column anchors (i.e. the + object is anchored to the actual from and to row and column) +
++ Specifies that the current drawing shall move with its + row and column (i.e. the object is anchored to the + actual from row and column), but that the size shall remain absolute. +
++ If Additional rows/columns are Added between the from and to locations of the drawing, + the drawing shall move its to anchors as needed to maintain this same absolute size. +
++ Specifies that the current start and end positions shall + be maintained with respect to the distances from the + absolute start point of the worksheet. +
++ If Additional rows/columns are Added before the + drawing, the drawing shall move its anchors as needed + to maintain this same absolute position. +
++ 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells. +
+ @return the anchor type + @see #MOVE_AND_RESIZE + @see #MOVE_DONT_RESIZE + @see #DONT_MOVE_AND_RESIZE ++ For example, "highlight cells that begin with "M2" and contain "Mountain Gear". +
+ + @author Dmitriy Kumshayev + @author Yegor Kozlov ++ ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index); + newSheet.AddConditionalFormatting(cf); ++ +
+
+ // Define a Conditional Formatting rule, which triggers formatting
+ // when cell's value is greater or equal than 100.0 and
+ // applies patternFormatting defined below.
+ ConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
+ ComparisonOperator.GE,
+ "100.0", // 1st formula
+ null // 2nd formula is not used for comparison operator GE
+ );
+
+ // Create pattern with red background
+ PatternFormatting patternFmt = rule.CretePatternFormatting();
+ patternFormatting.FillBackgroundColor(IndexedColor.RED.Index);
+
+ // Define a region Containing first column
+ Region [] regions =
+ {
+ new Region(1,(short)1,-1,(short)1)
+ };
+
+ // Apply Conditional Formatting rule defined above to the regions
+ sheet.AddConditionalFormatting(regions, rule);
+
+
+ @author Dmitriy Kumshayev
+ @author Yegor Kozlov
+ null
+ null.
+ null otherwise
+ null.
+ null otherwise
+ null.
+ null otherwise
+ null otherwise
+ null otherwise
+ null otherwise
+ + MUST be either {@link #CONDITION_TYPE_CELL_VALUE_IS} or {@link #CONDITION_TYPE_FORMULA} +
+ + @return the type of condition ++ MUST be a constant from {@link ComparisonOperator} +
+ + @return the conditional format operator ++ If the condition type is {@link #CONDITION_TYPE_CELL_VALUE_IS}, + this field is the first operand of the comparison. + If type is {@link #CONDITION_TYPE_FORMULA}, this formula is used + to determine if the conditional formatting is applied. +
++ If comparison type is {@link #CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function +
+ + @return the first formula +This defines how to calculate the ranges for a conditional + formatting rule, eg which values Get a Green Traffic Light + icon and which Yellow or Red.
+If you change the range type, you need to + ensure that the Formula and Value parameters + are compatible with it before saving
+ Formula to use to calculate the threshold, + ornull if no formula
+ null is given.
+ Gets the value used for the threshold, or
+ null if there isn't one.
+ null
+ null
+ null
+ null
+ formula1 was comma-separated literal values rather than a range or named range,
+ returns list of literal values.
+ Otherwise returns null.
+ null
+ null
+ excelDate == GetExcelDate(GetJavaDate(excelDate,false))
+ Is not always true. For example if default timezone Is
+ + If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final + ctColor applied. +
++ The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and + 1.0 means 100% lighten. Also, 0.0 means no Change. +
++ In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where + HLSMAX is currently 255. +
+ Here are some examples of how to apply tint to ctColor: +++ + @return the tint value ++ If (tint < 0) + Lum' = Lum * (1.0 + tint) + + For example: Lum = 200; tint = -0.5; Darken 50% + Lum' = 200 * (0.5) => 100 + For example: Lum = 200; tint = -1.0; Darken 100% (make black) + Lum' = 200 * (1.0-1.0) => 0 + If (tint > 0) + Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint)) + For example: Lum = 100; tint = 0.75; Lighten 75% + + Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75)) + = 100 * .25 + (255 - 255 * .25) + = 25 + (255 - 63) = 25 + 192 = 217 + For example: Lum = 100; tint = 1.0; Lighten 100% (make white) + Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1)) + = 100 * 0 + (255 - 255 * 0) + = 0 + (255 - 0) = 255 ++
Example: + In the case of SUM(B1 C1), the space between B1 and C1 is treated as the binary + intersection operator, when a comma was intended. end example] +
+Example: + In the case of a function argument, text was expected, but a number was provided +
+Example: + If a formula Contains a reference to a cell, and then the row or column Containing that cell is deleted, + a #REF! error results. If a worksheet does not support 20,001 columns, + OFFSET(A1,0,20000) will result in a #REF! error. +
+Example: + Certain calls to ASIN, ATANH, FACT, and SQRT might result in domain errors. +
+ Intended to indicate that the result of a function cannot be represented in a value of + the specified type, typically due to extreme magnitude. (This is known as a range + error.) +Example: FACT(1000) might result in a range error.
+Example: + Some functions, such as SUMX2MY2, perform a series of operations on corresponding + elements in two arrays. If those arrays do not have the same number of elements, then + for some elements in the longer array, there are no corresponding elements in the + shorter one; that is, one or more values in the shorter array are not available. +
+ This error value can be produced by calling the function NA ++ int EvaluatedCellType = Evaluator.evaluateFormulaCell(cell); ++ Be aware that your cell will hold both the formula, + and the result. If you want the cell Replaced with + the result of the formula, use {@link #EvaluateInCell(Cell)} + @param cell The cell to Evaluate + @return The type of the formula result, i.e. -1 if the cell is not a formula, + or one of Cell.CELL_TYPE_NUMERIC, Cell.CELL_TYPE_STRING, Cell.CELL_TYPE_BOOLEAN, Cell.CELL_TYPE_ERROR + Note: the cell's type remains as Cell.CELL_TYPE_FORMULA however. +
+ int EvaluatedCellType = Evaluator.evaluateInCell(cell).getCellType(); ++ Be aware that your cell value will be Changed to hold the + result of the formula. If you simply want the formula + value comPuted for you, use {@link #EvaluateFormulaCell(Cell)} + @param cell +
Format class that handles Excel style fractions, such as "# #/#" and "#/###"
+ +As of this writing, this is still not 100% accurate, but it does a reasonable job + of trying to mimic Excel's fraction calculations. It does not currently + maintain Excel's spacing.
+ +This class relies on a method lifted nearly verbatim from org.apache.math.fraction. + If further uses for Commons Math are found, we will consider Adding it as a dependency. + For now, we have in-lined the one method to keep things simple.
++ Additional rules: +
+ When there is also an indent value to apply, both the left and right side of the cell + are pAdded by the indent value. +
+A 'word' is a set of characters with no space character in them.
+Two lines inside a cell are Separated by a carriage return.
+If the new Icon Set has a different number of + icons to the old one, you must update the + thresholds before saving!
+ Should Icon + Value be displayed, or only the Icon? ++ Each element corresponds to a color index (zero-based). When using the default indexed color palette, + the values are not written out, but instead are implied. When the color palette has been modified from default, + then the entire color palette is used. +
+ + @author Yegor Kozlov +null if it has not been set yet. Never empty string
+ @see #SetRefersToFormula(String)
+ + Please note, that this method works correctly only for workbooks + with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx). + If the default font is changed the resized image can be streched vertically or horizontally. +
+
+ resize(1.0,1.0) keeps the original size,
+ resize(0.5,0.5) resize to 50% of the original,
+ resize(2.0,2.0) resizes to 200% of the original.
+ resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE}) resizes to the dimension of the embedded image.
+
SetCellValue or SetCellType.
+
+ short minColIx = row.GetFirstCellNum();
+ short maxColIx = row.GetLastCellNum();
+ for(short colIx=minColIx; colIx<maxColIx; colIx++) {
+ Cell cell = row.GetCell(colIx);
+ if(cell == null) {
+ continue;
+ }
+ //... do something with cell
+ }
+
+ nullnullnull to remove protection
+ + Sheet1!$1:$1 + Sheet2!$5:$8 ++ The {@link CellRangeAddress} returned contains a column part which spans + all columns, and a row part which specifies the contiguous range of + repeating rows. + + If the Sheet does not have any repeating rows defined, null is returned. +
+ Sheet1!$A:$A + Sheet2!$C:$F ++ The {@link CellRangeAddress} returned contains a row part which spans all + rows, and a column part which specifies the contiguous range of + repeating columns. + + If the Sheet does not have any repeating columns defined, null is + returned. +
A1.
+ + The Created conditional formatting rule Compares a cell value + to a formula calculated result, using the specified operator. + The type of the Created condition is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS} +
+ + @param comparisonOperation - MUST be a constant value from ++
XSSFTable.UpdateHeaders() is called to reset the cache.
+ @param columnHeader the column header name to Get the table column index of
+ @return column index corresponding to columnHeader
+ + When text direction is horizontal: the vertical alignment of lines of text is distributed vertically, + where each line of text inside the cell is evenly distributed across the height of the cell, + with flush top and bottom margins. +
++ When text direction is vertical: similar behavior as horizontal justification. + The alignment is justified (flush top and bottom in this case). For each line of text, each + line of the wrapped text in a cell is aligned to the top and bottom (except the last line). + If no single line of text wraps in the cell, then the text is not justified. +
++ When text direction is horizontal: the vertical alignment of lines of text is distributed vertically, + where each line of text inside the cell is evenly distributed across the height of the cell, + with flush top +
++ When text direction is vertical: behaves exactly as distributed horizontal alignment. + The first words in a line of text (appearing at the top of the cell) are flush + with the top edge of the cell, and the last words of a line of text are flush with the bottom edge of the cell, + and the line of text is distributed evenly from top to bottom. +
++ This is different from the normal hidden status + ({@link #isSheetHidden(int)}) +
+ @param sheetIx sheet index to check + @returntrue if sheet is very hidden
+ + 0 = not hidden + 1 = hidden + 2 = very hidden. ++ @param sheetIx The sheet number + @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden +
| Result | Comment |
|---|---|
| A1:A1 | Single cell area reference without sheet |
| A1:$C$1 | Multi-cell area reference without sheet |
| Sheet1!A$1:B4 | Standard sheet name |
| 'O''Brien''s Sales'!B5:C6' | Sheet name with special Chars |
This class is a Container for POI usermodel row=0 column=0 cell references. + It is barely a Container for these two coordinates. The implementation + of the Comparable interface sorts by "natural" order top left to bottom right.
+ +Use CellAddress when you want to refer to the location of a cell in a sheet + when the concept of relative/absolute does not apply (such as the anchor location + of a cell comment). Use {@link CellReference} when the concept of + relative/absolute does apply (such as a cell reference in a formula). + CellAddresses do not have a concept of "sheet", while CellReferences do.
+Common conversion functions between Excel style A1, C27 style + cell references, and POI usermodel style row=0, column=0 + style references. Handles sheet-based and sheet-free references + as well, eg "Sheet1!A1" and "$B$72"
+ +Use CellReference when the concept of + relative/absolute does apply (such as a cell reference in a formula). + Use {@link CellAddress} when you want to refer to the location of a cell in a sheet + when the concept of relative/absolute does not apply (such as the anchor location + of a cell comment). + CellReferences have a concept of "sheet", while CellAddresses do not.
+| Result | Comment |
|---|---|
| A1 | Cell reference without sheet |
| Sheet1!A1 | Standard sheet name |
| 'O''Brien''s Sales'!A1' | Sheet name with special characters |
+ POI currently targets BIFF8 (Excel 97-2003), so the following behaviour can be observed for + this method: ++
+ Version File Format +Last Column Last Row + 97-2003 BIFF8 "IV" (2^8) 65536 (2^14) + 2007 BIFF12 "XFD" (2^14) 1048576 (2^20)
+ + @param colStr a string of only letter characters + @param rowStr a string of only digit characters + @return+
+ Input +Result + "A", "1" true + "a", "111" true + "A", "65536" true + "A", "65537" false + "iv", "1" true + "IW", "1" false + "AAA", "1" false + "a", "111" true + "Sheet", "1" false
This method attempts to find an existing CellStyle that matches the cell's
+ current style plus styles properties in properties. A new style is created if the
+ workbook does not contain a matching style.
Modifies the cell style of cell without affecting other cells that use the
+ same style.
This is necessary because Excel has an upper limit on the number of styles that it supports.
+ +This function is more efficient than multiple calls to + {@link #setCellStyleProperty(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.usermodel.Workbook, String, Object)} + if adding multiple cell styles.
+ +For performance reasons, if this is the only cell in a workbook that uses a cell style, + this method does NOT remove the old style from the workbook. + +
+ + @param cell The cell to change the style of + @param properties The properties to be added to a cell style, as {propertyName: propertyValue}. + @since POI 3.14 beta 2 +This method attempts to find an existing CellStyle that matches the cell's
+ current style plus a single style property propertyName with value
+ propertyValue.
+ A new style is created if the workbook does not contain a matching style.
Modifies the cell style of cell without affecting other cells that use the
+ same style.
If setting more than one cell style property on a cell, use + {@link #setCellStyleProperties(org.apache.poi.ss.usermodel.Cell, Map)}, + which is faster and does not add unnecessary intermediate CellStyles to the workbook.
+ + @param cell The cell that is to be changed. + @param propertyName The name of the property that is to be changed. + @param propertyValue The value of the property that is to be changed. +This method attempts to find an existing CellStyle that matches the cell's
+ current style plus a single style property propertyName with value
+ propertyValue.
+ A new style is created if the workbook does not contain a matching style.
Modifies the cell style of cell without affecting other cells that use the
+ same style.
If setting more than one cell style property on a cell, use + {@link #setCellStyleProperties(Cell, Map)}, + which is faster and does not add unnecessary intermediate CellStyles to the workbook.
+ + @param workbook The workbook that is being worked with. + @param propertyName The name of the property that is to be changed. + @param propertyValue The value of the property that is to be changed. + @param cell The cell that needs it's style changes +style, so subsequent changes
+ to style will not modify the map, and changes to the returned
+ map will not modify the cell style. The returned map is mutable.
+ @param style cell style
+ @return map of format properties (String -> Object)
+ @see #setFormatProperties(org.apache.poi.ss.usermodel.CellStyle, org.apache.poi.ss.usermodel.Workbook, java.util.Map)
+ | 1 | 2 |
| 3 | 4 |
25.4/HorizontalPixelSize
+ and 25.4/VerticalPixelSize. Where 25.4 is the number of mm in inch.
+
+ @return array of two elements: {horisontalPdi, verticalDpi}.
+ {96, 96} is the default.
+ negative, 0, or positive according to the standard Excel comparison
+ of values isNegative ? -1 : +1
+ java.util.Date or java.util.Calendar
+ instances become date cells.Object.toString()
+ method call.If the cell at the given co-ordinates is a merged cell, this will + return the primary (top-left) most cell of the merged region.
+If the cell at the given co-ordinates is not in a merged region, + then will return the cell itself.
+If there is no cell defined at the given co-ordinates, will return + null.
+
+ The character count
true if this revocation data Set holds OCSP
+ responses.
+
+ @return true if this revocation data Set holds OCSP
+ responses.
+ true if this revocation data Set holds CRLs.
+
+ @return true if this revocation data Set holds CRLs.
+ true if this revocation data is not empty.
+
+ @return true if this revocation data is not empty.
+ null if a description is not available.
+
+ @return the description, or null.
+ null in case such a download location does not
+ exist.
+
+ @return the download URL, or null.
+ null the signature will be limited to XAdES-T only.
+ null value will trigger an automatically generated signature Id.
+ null value will trigger an automatically generated signature Id.
+ null, the hash algorithm of the main entry
+ null the signature will be limited to XAdES-T only.
+ null the signature will be limited to XAdES-T only.
+ null, defaults to {@link #getDigestAlgo()}
+ 1.3.6.1.4.1.13762.3
+ null the claimed role element is omitted.
+ Defaults to null
+ null the claimed role element is omitted.
+ idSignedProperties
+ null defaults to idSignedProperties
+ true
+ EXCLUSIVE
+ @see javax.xml.Crypto.dsig.CanonicalizationMethod
+ null if not specified)
+ null
+ if not specified)
+ URIReference and returns the
+ dereferenced data.
+
+ @param uriReference the URIReference
+ @param context an XMLCryptoContext that may
+ contain additional useful information for dereferencing the URI. This
+ implementation should dereference the specified
+ URIReference against the context's baseURI
+ parameter, if specified.
+ @return the dereferenced data
+ @throws NullPointerException if uriReference or
+ context are null
+ @throws URIReferenceException if an exception occurs while
+ dereferencing the specified uriReference
+ EventListener interface was registered.
+ @param evt The Event contains contextual information
+ about the event. It also contains the stopPropagation
+ and preventDefault methods which are used in
+ determining the event's flow and default action.
+ This class is the default entry point for XML signatures and can be used for + validating an existing signed office document and signing a office document.
+ +Validating a signed office document
+ ++ OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ); + SignatureConfig sic = new SignatureConfig(); + sic.setOpcPackage(pkg); + SignatureInfo si = new SignatureInfo(); + si.setSignatureConfig(sic); + boolean isValid = si.validate(); + ... ++ +
Signing an office document
+ +
+ // loading the keystore - pkcs12 is used here, but of course jks & co are also valid
+ // the keystore needs to contain a private key and it's certificate having a
+ // 'digitalSignature' key usage
+ char password[] = "test".toCharArray();
+ File file = new File("test.pfx");
+ KeyStore keystore = KeyStore.getInstance("PKCS12");
+ FileInputStream fis = new FileInputStream(file);
+ keystore.load(fis, password);
+ fis.close();
+
+ // extracting private key and certificate
+ String alias = "xyz"; // alias of the keystore entry
+ Key key = keystore.getKey(alias, password);
+ X509Certificate x509 = (X509Certificate)keystore.getCertificate(alias);
+
+ // filling the SignatureConfig entries (minimum fields, more options are available ...)
+ SignatureConfig signatureConfig = new SignatureConfig();
+ signatureConfig.setKey(keyPair.getPrivate());
+ signatureConfig.setSigningCertificateChain(Collections.singletonList(x509));
+ OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ_WRITE);
+ signatureConfig.setOpcPackage(pkg);
+
+ // adding the signature document to the package
+ SignatureInfo si = new SignatureInfo();
+ si.setSignatureConfig(signatureConfig);
+ si.confirmSignature();
+ // optionally verify the generated signature
+ boolean b = si.verifySignature();
+ assert (b);
+ // write the changes back to disc
+ pkg.close();
+
+
+ Implementation notes:
+ +Although there's a XML signature implementation in the Oracle JDKs 6 and higher, + compatibility with IBM JDKs is also in focus (... but maybe not thoroughly tested ...). + Therefore we are using the Apache Santuario libs (xmlsec) instead of the built-in classes, + as the compatibility seems to be provided there.
+ +To use SignatureInfo and its sibling classes, you'll need to have the following libs + in the classpath:
++ Each POIXMLDocumentPart keeps a reference to the underlying a {@link org.apache.poi.openxml4j.opc.PackagePart}. +
+ + @author Yegor Kozlov +null for the root element.
+
+ protected void commit() {
+ PackagePart part = GetPackagePart();
+ Stream out = part.GetStream();
+ XmlObject bean = GetXmlBean(); //the "model" which holds Changes in memory
+ bean.save(out, DEFAULT_XML_OPTIONS);
+ out.close();
+ }
+ POIXMLDocumentPart
+
+ @author Yegor Kozlov
+ null if there isn't one
+
+ @return The Document Thumbnail part or null
+ thumbnail.jpeg, or null if there
+ isn't one.
+
+ @return The thumbnail filename, or null
+ null if there isn't one.
+
+ @return The thumbnail data, or null
+ thumbnail.jpg
+ @param imageData The inputstream to read the thumbnail image from
+ + A workbook may contain thousands of cells Containing string (non-numeric) data. Furthermore this data is very + likely to be repeated across many rows or columns. The goal of implementing a single string table that is shared + across the workbook is to improve performance in opening and saving the file by only Reading and writing the + repetitive information once. +
++ Consider for example a workbook summarizing information for cities within various countries. There may be a + column for the name of the country, a column for the name of each city in that country, and a column + Containing the data for each city. In this case the country name is repetitive, being duplicated in many cells. + In many cases the repetition is extensive, and a tremendous savings is realized by making use of a shared string + table when saving the workbook. When displaying text in the spreadsheet, the cell table will just contain an + index into the string table as the value of a cell, instead of the full string. +
++ The shared string table Contains all the necessary information for displaying the string: the text, formatting + properties, and phonetic properties (for East Asian languages). +
+ + @author Nick Birch + @author Yegor Kozlov +strings arrays
+
+ If the Shared String table already Contains this CT_Rst bean, its index is returned.
+ Otherwise a new entry is aded.
+
fmt in the numberFormats map if the format is not
+ already in the the number format style table.
+ Does nothing if fmt is already in number format style table.
+
+ @param fmt the number format to add to number format style table
+ @return the index of fmt in the number format style table
+ fmt
+ This may be used to override built-in number formats.
+
+ @param index the number format ID
+ @param fmt the number format code
+ sheet
+
+ @param sheet the sheet associated with this auto-size column tracker
+ @since 3.14beta1
+ columns that are already tracked are ignored by this call.
+
+ @param columns the indices of the columns to track
+ @since 3.14beta1
+ column is already tracked, this call does nothing.
+
+ @param column the index of the column to track for auto-sizing
+ @return if column is already tracked, the call does nothing and returns false
+ @since 3.14beta1
+ columns that is not tracked will be ignored by this call.
+
+ @param columns the indices of the columns to track for auto-sizing
+ @return true if one or more columns were untracked as a result of this call
+ @since 3.14beta1
+ column is not tracked, it will be ignored by this call.
+
+ @param column the index of the column to track for auto-sizing
+ @return true if column was tracked prior this call, false if no action was taken
+ @since 3.14beta1
+ .gz
+
+ @return temp file to write sheet data
+ SXSSFRow objects. Two rows are equal if they belong to the same worksheet and
+ their row indexes are equal.
+
+ @param other the SXSSFRow to be compared.
+ @return 0 if the row number of this SXSSFRow is
+ equal to the row number of the argument SXSSFRow
+ 0 if the row number of this this SXSSFRow is
+ numerically less than the row number of the argument SXSSFRow
+ 0 if the row number of this this SXSSFRow is
+ numerically greater than the row number of the argument SXSSFRow
+ + This process can be relatively slow on large sheets, so this should + normally only be called once per column, at the end of your + processing. +
+ You can specify whether the content of merged cells should be considered or ignored. + Default is to ignore merged cells. + ++ Special note about SXSSF implementation: You must register the columns you wish to track with + the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}. + This is needed because the rows needed to compute the column width may have fallen outside the + random access window and been flushed to disk. + Tracking columns is required even if all rows are in the random access window. +
+New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.
+ + @param column the column index to auto-size ++ This process can be relatively slow on large sheets, so this should + normally only be called once per column, at the end of your + processing. +
+ You can specify whether the content of merged cells should be considered or ignored. + Default is to ignore merged cells. + ++ Special note about SXSSF implementation: You must register the columns you wish to track with + the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}. + This is needed because the rows needed to compute the column width may have fallen outside the + random access window and been flushed to disk. + Tracking columns is required even if all rows are in the random access window. +
+New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.
+ + @param column the column index to auto-size + @param useMergedCells whether to use the contents of merged cells when calculating the width of the column +null if not found+ groupRows requires all rows in the group to be in the current window. + This is not always practical. Instead use setRowOutlineLevel to + explicitly set the group level. Level 1 is the top level group, + followed by 2, etc. It is up to the user to ensure that level 2 + groups are correctly nested under level 1, etc. +
+ + @param rownum index of row to update (0-based) + @param level outline level (greater than 0) +column is already tracked, this call does nothing.
+
+ @param column the column to track for autosizing
+ @since 3.14beta1
+ @see #trackColumnsForAutoSizing(Collection)
+ @see #trackAllColumnsForAutoSizing()
+ columns that are already tracked are ignored by this call.
+
+ @param columns the columns to track for autosizing
+ @since 3.14beta1
+ column is not tracked, it will be ignored by this call.
+
+ @param column the index of the column to track for auto-sizing
+ @return true if column was tracked prior to this call, false if no action was taken
+ @since 3.14beta1
+ @see #untrackColumnsForAutoSizing(Collection)
+ @see #untrackAllColumnsForAutoSizing(int)
+ columns that is not tracked will be ignored by this call.
+
+ @param columns the indices of the columns to track for auto-sizing
+ @return true if one or more columns were untracked as a result of this call
+
+ @param columns the columns to track for autosizing
+ @since 3.14beta1
+ + When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. ++ There are three use-cases to use SXSSFWorkbook(XSSFWorkbook) : +
+ When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. ++ When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. + @param compressTmpFiles whether to use gzip compression for temporary files ++ When a new node is created via createRow() and the total number + of unflushed records would exceed the specified value, then the + row with the lowest index value is flushed and cannot be accessed + via getRow() anymore. +
++ A value of -1 indicates unlimited access. In this case all + records that have not been flushed by a call to flush() are available + for random access. +
++ A value of 0 is not allowed because it would flush any newly created row + without having a chance to specify any cells. +
+ + @param workbook the template workbook + @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above. + @param compressTmpFiles whether to use gzip compression for temporary files + @param useSharedStringsTable whether to use a shared strings table +
+ SXSSF writes sheet data in temporary files (a temp file per-sheet)
+ and the size of these temp files can grow to to a very large size,
+ e.g. for a 20 MB csv data the size of the temp xml file become few GB large.
+ If the "compress" flag is set to true then the temporary XML is gzipped.
+
+ Please note the the "compress" option may cause performance penalty. +
+ @param compress whether to compress temp files +null
+ + The idea is to parse every formula and render it back to string + with the updated sheet name. This is done by parsing into Ptgs, + looking for ones with sheet references in them, and changing those +
+ + @param sheetIndex the 0-based index of the sheet being changed + @param oldName the old sheet name + @param newName the new sheet name +null if the formula wasn't modified
+ + Autofit specifies that a shape should be auto-fit to fully contain the text described within it. + Auto-fitting is when text within a shape is scaled in order to contain all the text inside +
++ Example: Consider the situation where a user is building a diagram and needs + to have the text for each shape that they are using stay within the bounds of the shape. + An easy way this might be done is by using NORMAL autofit +
++ Example: Consider the situation where a user is building a diagram and needs to have + the text for each shape that they are using stay within the bounds of the shape. + An easy way this might be done is by using SHAPE autofit +
++ Cells can be numeric, formula-based or string-based (text). The cell type + specifies this. String cells cannot conatin numbers and numeric cells cannot + contain strings (at least according to our model). Client apps should do the + conversions themselves. Formula cells have the formula string, as well as + the formula result, which can be numeric or string. +
++ Cells should have their number (0 based) before being Added to a row. Only + cells that have values should be Added. +
++ For strings, numbers, and errors, we throw an exception. For blank cells we return a false. +
+ @return the value of the cell as a bool + @throws InvalidOperationException if the cell type returned by {@link #CellType} + is not CellType.Boolean, CellType.Blank or CellType.Formula ++ For strings we throw an exception. For blank cells we return a 0. + For formulas or error cells we return the precalculated value; +
+ @return the value of the cell as a number + @throws InvalidOperationException if the cell type returned by {@link #CellType} is CellType.String + @exception NumberFormatException if the cell value isn't a parsabledouble.
+ @see DataFormatter for turning this number into a string similar to that which Excel would render this number as.
+ + For numeric cells we throw an exception. For blank cells we return an empty string. + For formulaCells that are not string Formulas, we throw an exception +
+ @return the value of the cell as a string ++ For numeric cells we throw an exception. For blank cells we return an empty string. + For formula cells we return the pre-calculated value if a string, otherwise an exception +
+ @return the value of the cell as a XSSFRichTextString +SUM(C4:E4)
+ + Note, this method only Sets the formula string and does not calculate the formula value. + To Set the precalculated value use {@link #setCellValue(double)} or {@link #setCellValue(String)} +
+ + @param formula the formula to Set, e.g."SUM(C4:E4)".
+ If the argument is null then the current formula is Removed.
+ @throws NPOI.ss.formula.FormulaParseException if the formula has incorrect syntax or is otherwise invalid
+ @throws InvalidOperationException if the operation is not allowed, for example,
+ when the cell is a part of a multi-cell array formula
+ + If the cell Contains a string, then this value is an index into + the shared string table, pointing to the actual string value. Otherwise, + the value of the cell is expressed directly in this element. Cells Containing formulas express + the last calculated result of the formula in this element. +
+ + @return the raw cell value as Contained in the underlying CT_Cell bean, +null for blank cells.
+ -1 means no xf.
+ @param stylesSource Styles Source to work off
+ null if not Set
+ + Note - many cells are actually Filled with a foreground + Fill, not a background fill - see {@link #getFillForegroundColor()} +
+ @see NPOI.xssf.usermodel.XSSFColor#getRgb() + @return XSSFColor - fill color ornull if not Set
+ + Many cells are Filled with this, instead of a + background color ({@link #getFillBackgroundColor()}) +
+ @see IndexedColors + @return fill color, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC} +null if not Set
+ @see NPOI.ss.usermodel.IndexedColors
+ [degrees below horizon] = 90 - textRotation.
+ application/vnd.Openxmlformats-officedocument.Drawingml.chart+xml
+ @param rel the namespace relationship holding this chart,
+ the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/chart
+ + Chart sheet is a special kind of Sheet that Contains only chart and no data. +
+ + @author Yegor Kozlov ++ If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final + ctColor applied. +
++ The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and + 1.0 means 100% lighten. Also, 0.0 means no Change. +
++ In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where + HLSMAX is currently 255. +
+ Here are some examples of how to apply tint to ctColor: +++ + @return the tint value ++ If (tint < 0) + Lum' = Lum * (1.0 + tint) + + For example: Lum = 200; tint = -0.5; Darken 50% + Lum' = 200 * (0.5) => 100 + For example: Lum = 200; tint = -1.0; Darken 100% (make black) + Lum' = 200 * (1.0-1.0) => 0 + If (tint > 0) + Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint)) + For example: Lum = 100; tint = 0.75; Lighten 75% + + Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75)) + = 100 * .25 + (255 - 255 * .25) + = 25 + (255 - 63) = 25 + 192 = 217 + For example: Lum = 100; tint = 1.0; Lighten 100% (make white) + Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1)) + = 100 * 0 + (255 - 255 * 0) + = 0 + (255 - 0) = 255 ++
null
+ null.
+ null otherwise
+ null.
+ null otherwise
+ null.
+ null otherwise
+ + MUST be a constant from {@link NPOI.ss.usermodel.ComparisonOperator} +
+ + @return the conditional format operator ++ If the condition type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}, + this field is the first operand of the comparison. + If type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}, this formula is used + to determine if the conditional formatting is applied. +
++ If comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function +
+ + @return the first formula +fmt
+ This may be used to override built-in number formats.
+
+ @param index the number format ID
+ @param format the number format code
+ null
+ application/vnd.openxmlformats-officedocument.Drawing+xml
+ @param rel the namespace relationship holding this Drawing,
+ the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing
+ + Even page header value. Corresponds to even printed pages. + Even page(s) in the sheet may not be printed, for example, if the print area is specified to be + a range such that it falls outside an even page's scope. + If no even header is specified, then odd header value is assumed for even page headers. +
+ +null
+ for the (conservative) assumption that any cell may have its defInition Changed After
+ Evaluation begins.
+ @param udfFinder pass null for default (AnalysisToolPak only)
+
+ Defined names are descriptive text that is used to represents a cell, range of cells, formula, or constant value.
+ Use easy-to-understand names, such as Products, to refer to hard to understand ranges, such as Sales!C20:C30.
+
+ + @author Nick Burch + @author Yegor Kozlov ++ XSSFWorkbook wb = new XSSFWorkbook(); + XSSFSheet sh = wb.CreateSheet("Sheet1"); + + //applies to the entire workbook + XSSFName name1 = wb.CreateName(); + name1.SetNameName("FMLA"); + name1.SetRefersToFormula("Sheet1!$B$3"); + + //applies to Sheet1 + XSSFName name2 = wb.CreateName(); + name2.SetNameName("SheetLevelName"); + name2.SetComment("This name is scoped to Sheet1"); + name2.SetLocalSheetId(0); + name2.SetRefersToFormula("Sheet1!$B$3"); + +
true indicates the name refers to a function.
+ true if this name refers to a user-defined function
+ true if the argument is XSSFName and the
+ underlying CTDefinedName bean Equals to the CTDefinedName representing this name
+
+ @param o the object to compare this XSSFName against.
+ @return true if the XSSFName are Equal;
+ false otherwise.
+ + Please note, that this method works correctly only for workbooks + with the default font size (Calibri 11pt for .xlsx). + If the default font is Changed the resized image can be streched vertically or horizontally. +
++ Please note, that this method works correctly only for workbooks + with the default font size (Calibri 11pt for .xlsx). + If the default font is changed the resized image can be streched vertically or horizontally. +
+
+ resize(1.0,1.0) keeps the original size,
+ resize(0.5,0.5) resize to 50% of the original,
+ resize(2.0,2.0) resizes to 200% of the original.
+ resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE}) resizes to the dimension of the embedded image.
+
http://schemas.openxmlformats.org/officeDocument/2006/relationships/image
+ @return registered POIXMLRelation or null if not found
+ + Most strings in a workbook have formatting applied at the cell level, that is, the entire string in the cell has the + same formatting applied. In these cases, the formatting for the cell is stored in the styles part, + and the string for the cell can be shared across the workbook. The following code illustrates the example. +
+ +
+
+ cell1.SetCellValue(new XSSFRichTextString("Apache POI"));
+ cell2.SetCellValue(new XSSFRichTextString("Apache POI"));
+ cell3.SetCellValue(new XSSFRichTextString("Apache POI"));
+
+
+ In the above example all three cells will use the same string cached on workbook level.
+
+ + Some strings in the workbook may have formatting applied at a level that is more granular than the cell level. + For instance, specific characters within the string may be bolded, have coloring, italicizing, etc. + In these cases, the formatting is stored along with the text in the string table, and is treated as + a unique entry in the workbook. The following xml and code snippet illustrate this. +
+ +
+
+ XSSFRichTextString s1 = new XSSFRichTextString("Apache POI");
+ s1.ApplyFont(boldArial);
+ cell1.SetCellValue(s1);
+
+ XSSFRichTextString s2 = new XSSFRichTextString("Apache POI");
+ s2.ApplyFont(italicCourier);
+ cell2.SetCellValue(s2);
+
+
+
+
+ @author Yegor Kozlov
+ null if no formatting is required
+
+ Example: The Unicode character 0D is invalid in an XML 1.0 document,
+ so it shall be escaped as _x000D_.
+
+ for(Cell cell : row){
+ ...
+ }
+ XSSFRow objects. Two rows are equal if they belong to the same worksheet and
+ their row indexes are equal.
+
+ @param row the XSSFRow to be compared.
+ @return 0 if the row number of this XSSFRow is
+ equal to the row number of the argument XSSFRow
+ 0 if the row number of this this XSSFRow is
+ numerically less than the row number of the argument XSSFRow
+ 0 if the row number of this this XSSFRow is
+ numerically greater than the row number of the argument XSSFRow
+
+ short minColIx = row.GetFirstCellNum();
+ short maxColIx = row.GetLastCellNum();
+ for(short colIx=minColIx; colIx<maxColIx; colIx++) {
+ XSSFCell cell = row.GetCell(colIx);
+ if(cell == null) {
+ continue;
+ }
+ //... do something with cell
+ }
+
+
+ @return short representing the last logical cell in the row PLUS ONE,
+ or -1 if the row does not contain any cells.
+ + Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work. + The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can + contain text, numbers, dates, and formulas. Cells can also be formatted. +
++ This process can be relatively slow on large sheets, so this should + normally only be called once per column, at the end of your + Processing. +
+ You can specify whether the content of merged cells should be considered or ignored. + Default is to ignore merged cells. + + @param column the column index + @param useMergedCells whether to use the contents of merged cells when calculating the width of the column +null if the drawing was not found and autoCreate=false
+ + If both colSplit and rowSplit are zero then the existing freeze pane is Removed +
+ + @param colSplit Horizonatal position of split. + @param rowSplit Vertical position of split. + @param leftmostColumn Left column visible in right pane. + @param topRow Top row visible in bottom pane +null if not foundnull
+ + Note, the returned value is always gerater that {@link #GetDefaultColumnWidth()} because the latter does not include margins. + Actual column width measured as the number of characters of the maximum digit width of the + numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin + pAdding (two on each side), plus 1 pixel pAdding for the gridlines. +
+ + @param columnIndex - the column to set (0-based) + @return width - the width in units of 1/256th of a character width ++ Please note, that this method works correctly only for workbooks + with the default font size (Calibri 11pt for .xlsx). +
++ Note, this value is different from {@link #GetColumnWidth(int)}. The latter is always greater and includes + 4 pixels of margin pAdding (two on each side), plus 1 pixel pAdding for the gridlines. +
+ @return column width, default value is 8 +true
+ null to remove protection
+ XSSFRow representing the rownumber or null if its not defined on the sheet
+ null
+ + When true a summary row is inserted below the detailed data being summarized and a + new outline level is established on that row. +
++ When false a summary row is inserted above the detailed data being summarized and a new outline level + is established on that row. +
+ @returntrue if row summaries appear below detail in the outline
+ + When true a summary column is inserted to the right of the detailed data being summarized + and a new outline level is established on that column. +
++ When false a summary column is inserted to the left of the detailed data being + summarized and a new outline level is established on that column. +
+ @returntrue if col summaries appear right of the detail in the outline
+ false if the column is visible
+ true if this sheet should display formulas.
+ true if this sheet displays gridlines.
+ @see #isPrintGridlines() to check if printing of gridlines is turned on or off
+ + Row heading are the row numbers to the side of the sheet +
++ Column heading are the letters or numbers that appear above the columns of the sheet +
+ + @returntrue if this sheet should display row and column headings.
+ true if there is a page break at the indicated row
+ sheet.SetColumnBreak(2); breaks the sheet into two parts
+ with columns A,B,C in the first and D,E,... in the second. Simuilar, sheet.SetRowBreak(2);
+ breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
+ and rows starting with rownum=4 in the second.
+
+ @param row the row to break, inclusive
+ true if the sheet displays Automatic Page Breaks.
+ sheet.SetColumnBreak(2); breaks the sheet into two parts
+ with columns A,B,C in the first and D,E,... in the second. Simuilar, sheet.SetRowBreak(2);
+ breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
+ and rows starting with rownum=4 in the second.
+
+ @param column the column to break, inclusive
+ + * The maximum column width for an individual cell is 255 characters. + * This value represents the number of characters that can be displayed + * in a cell that is formatted with the standard font (first font in the workbook). + *
+ * + *
+ * Character width is defined as the maximum digit width
+ * of the numbers 0, 1, 2, ... 9 as rendered
+ * using the default font (first font in the workbook).
+ *
+ * Unless you are using a very special font, the default character is '0' (zero),
+ * this is true for Arial (default font font in HSSF) and Calibri (default font in XSSF)
+ *
+ * Please note, that the width set by this method includes 4 pixels of margin pAdding (two on each side), + * plus 1 pixel pAdding for the gridlines (Section 3.3.1.12 of the OOXML spec). + * This results is a slightly less value of visible characters than passed to this method (approx. 1/2 of a character). + *
+ *+ * To compute the actual number of visible characters, + * Excel uses the following formula (Section 3.3.1.12 of the OOXML spec): + *
+ *
+ * width = TRuncate([{Number of Visible Characters} *
+ * {Maximum Digit Width} + {5 pixel pAdding}]/{Maximum Digit Width}*256)/256
+ *
+ * Using the Calibri font as an example, the maximum digit width of 11 point font size is 7 pixels (at 96 dpi).
+ * If you set a column width to be eight characters wide, e.g. SetColumnWidth(columnIndex, 8*256),
+ * then the actual value of visible characters (the value Shown in Excel) is derived from the following equation:
+ *
+ TRuncate([numChars*7+5]/7*256)/256 = 8;
+ *
+ *
+ * which gives 7.29.
+ *
+ 10 - 10% + 20 - 20% + ... + 100 - 100% + ... + 400 - 400% ++ + Current view can be Normal, Page Layout, or Page Break Preview. + + @param scale window zoom magnification + @throws ArgumentException if scale is invalid +
+ Additionally Shifts merged regions that are completely defined in these + rows (ie. merged 2 cells on a row to be Shifted).
+ @param startRow the row to start Shifting + @param endRow the row to end Shifting + @param n the number of rows to shift ++ Additionally Shifts merged regions that are completely defined in these + rows (ie. merged 2 cells on a row to be Shifted).
+ + @param startRow the row to start Shifting + @param endRow the row to end Shifting + @param n the number of rows to shift + @param copyRowHeight whether to copy the row height during the shift + @param reSetOriginalRowHeight whether to set the original row's height to the default ++ When only 1 sheet is selected and active, this value should be in synch with the activeTab value. + In case of a conflict, the Start Part Setting wins and Sets the active sheet tab. +
+ Note: multiple sheets can be selected, but only one sheet can be active at one time. + + @returntrue if this sheet is selected
+ A1.
+
+ @return the location of the active cell.
+ null if not found
+ +
CTTable.
+ Thus, {@link #updateReferences()} is inexpensive.
+
+ @since POI 3.15 beta 3
+ column.
+ The column index is relative to the left-most column in the table, 0-indexed.
+ Returns -1 if column is not a header name in table.
+
+ Column Header names are case-insensitive
+
+ Note: this function caches column names for performance. To flush the cache (because columns
+ have been moved or column headers have been changed), {@link #updateHeaders()} must be called.
+
+ @since 3.15 beta 2
+ null value means to use the text font color.
+ + Note that the closest properties object to the text is used, therefore if there is + a conflict between the text paragraph properties and the list style properties for + this level then the text paragraph properties will take precedence. +
+ Returns the level of text properties that this paragraph will follow. + + @return the text level of this paragraph (0-based). Default is 0. +null unsets the Typeface attribute from the underlying xml.
+ + The size is specified using a percentage. + Positive values indicate superscript, negative values indicate subscript. +
+ + @param baselineOffset ++ In Excel 2007 VML Drawings are used to describe properties of cell comments, + although the spec says that VML is deprecated: +
++ The VML format is a legacy format originally introduced with Office 2000 and is included and fully defined + in this Standard for backwards compatibility reasons. The DrawingML format is a newer and richer format + Created with the goal of eventually replacing any uses of VML in the Office Open XML formats. VML should be + considered a deprecated format included in Office Open XML for legacy reasons only and new applications that + need a file format for Drawings are strongly encouraged to use preferentially DrawingML +
+ ++ Warning - Excel is known to Put invalid XML into these files! + For example, >br< without being closed or escaped crops up. +
+ + See 6.4 VML - SpreadsheetML Drawing in Office Open XML Part 4 - Markup Language Reference.pdf + + @author Yegor Kozlov +application/vnd.Openxmlformats-officedocument.Drawing+xml
+ @param rel the namespace relationship holding this Drawing,
+ the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/drawing
+ null
+ Package object,
+ see http://poi.apache.org/oxml4j/.
+
+ Once you have finished working with the Workbook, you should close the package
+ by calling pkg.close, to avoid leaving file handles open.
+
+ Creating a XSSFWorkbook from a file-backed OPC Package has a lower memory
+ footprint than an InputStream backed one.
+
+ @param pkg the OpenXML4J OPC Package object.
+
+ OPCPackage pkg = OPCPackage.open(path);
+ XSSFWorkbook wb = new XSSFWorkbook(pkg);
+ // work with the wb object
+ ......
+ pkg.close(); // gracefully closes the underlying zip file
+ + Note that Excel allows sheet names up to 31 chars in length but other applications + (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars, + others - tRuncate such names to 31 character. +
++ POI's SpreadsheetAPI silently tRuncates the input argument to 31 characters. + Example: + +
+ Sheet sheet = workbook.CreateSheet("My very long sheet name which is longer than 31 chars"); // will be tRuncated
+ assert 31 == sheet.SheetName.Length;
+ assert "My very long sheet name which i" == sheet.SheetName;
+ + Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters: +
+ See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} + for a safe way to create valid names +
+ @param sheetname sheetname to set for the sheet. + @return Sheet representing the new sheet. + @throws IllegalArgumentException if the name is null or invalid + or workbook already contains a sheet with this name + @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal) +null is returned no named range could be found.null if it does not exist
+
+ XSSFWorkbook wb = new XSSFWorkbook(package);
+ for(XSSFSheet sheet : wb){
+
+ }
+ + Note that a sheet could instead be Set to be very hidden, which is different + ({@link #isSheetVeryHidden(int)}) +
+ @param sheetIx Number + @returntrue if sheet is hidden
+ + This is different from the normal hidden status + ({@link #isSheetHidden(int)}) +
+ @param sheetIx sheet index to check + @returntrue if sheet is very hidden
+
+ Calling setSheetHidden(sheetIndex, true) is equivalent to
+ setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN).
+
+ Calling setSheetHidden(sheetIndex, false) is equivalent to
+ setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE).
+
Workbook constants:
+ Workbook.SHEET_STATE_VISIBLE,
+ Workbook.SHEET_STATE_HIDDEN, or
+ Workbook.SHEET_STATE_VERY_HIDDEN.
+ @throws ArgumentException if the supplied sheet index or state is invalid
+ + The calculation chain object specifies the order in which the cells in a workbook were last calculated +
+ + @return theCalculationChain object or null if not defined
+ The external links table specifies details of named ranges etc + * that are referenced from other workbooks, along with the last seen + * values of what they point to.
+ * + *Note that Excel uses index 0 for the current workbook, so the first + * External Links in a formula would be '[1]Foo' which corresponds to + * entry 0 in this list.
+ + * @return theExternalLinksTable list, which may be empty
+ + The default instance : the built-in functions with the Excel Analysis Tool Pack. + To Set / Evaluate custom functions you need to register them as follows: + + + +
+ @return wrapped instance of UDFFinder that allows seeking functions both by index and name ++ Typically you want to force formula recalculation when you modify cell formulas or values + of a workbook previously Created by Excel. When Set to true, this flag will tell Excel + that it needs to recalculate all formulas in the workbook the next time the file is opened. +
++ Note, that recalculation updates cached formula results and, thus, modifies the workbook. + Depending on the version, Excel may prompt you with "Do you want to save the Changes in filename?" + on close. +
+ + @param value true if the application will perform a full recalculation of + workbook values when the workbook is opened + @since 3.8 ++ 9 Jan 2010 +
++ // TODO insert Javadoc here! +
+ @author epp + ++ if the border is on the left or right, no border is displayed. +
++ If the current section is not divided into columns, or the column break + occurs in the last column on the current page when displayed, then the + restart location for text shall be the next page in the document. +
+High(ish) level class for working with .docx files.
+ +This class tries to hide some of the complexity + of the underlying file format, but as it's not a + mature and stable API yet, certain parts of the + XML structure come through. You'll therefore almost + certainly need to refer to the OOXML specifications + from + http://www.ecma-international.org/publications/standards/Ecma-376.htm + at some point in your use.
++ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option any +
+ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option ReadOnly +
+ <w:settings ... > + <w:documentProtection w:edit="forms" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option forms +
+ <w:settings ... > + <w:documentProtection w:edit="comments" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option comments +
+ <w:settings ... > + <w:documentProtection w:edit="trackedChanges" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option trackedChanges +
+ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++
+ <w:settings ... > + <w:documentProtection w:edit="forms" w:enforcement="1"/> ++
+ <w:settings ... > + <w:documentProtection w:edit="comments" w:enforcement="1"/> ++
+ <w:settings ... > + <w:documentProtection w:edit="trackedChanges" w:enforcement="1"/> ++
true if revision tracking is turned on
+ A Paragraph within a Document, Table, Header etc.
+ +A paragraph has a lot of styling information, but the + actual text (possibly along with more styling) is held on + the child {@link XWPFRun}s.
++ If the line height (before any Added spacing) is larger than one or more + characters on the line, all characters will be aligned to each other as + specified by this element. +
++ If this element is omitted on a given paragraph, its value is determined + by the Setting previously Set at any level of the style hierarchy (i.e. + that previous Setting remains unChanged). If this Setting is never + specified in the style hierarchy, then the vertical alignment of all + characters on the line shall be automatically determined by the consumer. +
+ + @return the vertical alignment of this paragraph. ++ If this element is omitted on a given paragraph, + its value is determined by the Setting previously Set at any level of the + style hierarchy (i.e. that previous Setting remains unChanged). If this + Setting is never specified in the style hierarchy, then this property + shall not be applied. Since the paragraph is specified to start on a new + page, it begins page two even though it could have fit on page one. +
+ + @return bool - if page break is Set ++ If this attribute is omitted, its value shall be assumed to be zero. + Negative values are defined such that the text is Moved past the text margin, + positive values Move the text inside the text margin. +
+ + @return indentation or null if indentation is not Set ++ If this attribute is omitted, its value shall be assumed to be zero. + Negative values are defined such that the text is Moved past the text margin, + positive values Move the text inside the text margin. +
+ + @return indentation or null if indentation is not Set +
+ Note, that this call might be expensive since all the picture data is copied into a temporary byte array.
+ You can grab the picture data directly from the underlying package part as follows:
+
+
+ InputStream is1 = GetPackagePart().InputStream;
+
+
http://schemas.openxmlformats.org/officeDocument/2006/relationships/image
+ @return registered POIXMLRelation or null if not found
+ null if parent structure (paragraph > document) is not properly Set.
+
+ This formatting property is a toggle property, which specifies that its
+ behavior differs between its use within a style defInition and its use as
+ direct formatting. When used as part of a style defInition, Setting this
+ property shall toggle the current state of that property as specified up
+ to this point in the hierarchy (i.e. applied to not applied, and vice
+ versa). Setting it to false (or an equivalent) shall
+ result in the current Setting remaining unChanged. However, when used as
+ direct formatting, Setting this property to true or false shall Set the
+ absolute state of the resulting property.
+
+ If this element is not present, the default value is to leave the + formatting applied at previous level in the style hierarchy. If this + element is never applied in the style hierarchy, then bold shall not be + applied to non-complex script characters. +
+ + @param valuetrue if the bold property is applied to
+ this run
+ null if not Set
+ true if the italic property is applied
+ true if the strike property is applied
+ + This formatting property is a toggle property, which specifies that its + behavior differs between its use within a style defInition and its use as + direct formatting. When used as part of a style defInition, Setting this + property shall toggle the current state of that property as specified up + to this point in the hierarchy (i.e. applied to not applied, and vice + versa). Setting it to false (or an equivalent) shall result in the + current Setting remaining unChanged. However, when used as direct + formatting, Setting this property to true or false shall Set the absolute + state of the resulting property. +
++ If this element is not present, the default value is to leave the + formatting applied at previous level in the style hierarchy. If this + element is never applied in the style hierarchy, then strikethrough shall + not be applied to the contents of this run. +
+ + @param valuetrue if the strike property is applied to
+ this run
+ true if the double strike property is applied
+ + The behavior of this break character (the + location where text shall be restarted After this break) shall be + determined by its type values. +
+ @see BreakType ++ The behavior of this break character (the + location where text shall be restarted After this break) shall be + determined by its type (in this case is BreakType.TEXT_WRAPPING as default) and clear attribute values. +
+ @see BreakClear ++ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option any +
+ <w:settings ... > + <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ++ + @return true if documentProtection is enforced with option ReadOnly +
+ <w:settings ... > + <w:documentProtection w:edit="[passed editValue]" w:enforcement="1"/> ++
Sketch of XWPFTable class. Only table's text is being hold.
+Specifies the contents of a table present in the document. A table is a set + of paragraphs (and other block-level content) arranged in rows and columns.
+Returns the character count including whitespace, or 0 if the + {@link DocumentSummaryInformation} does not contain this char count.
+ This is the whitespace-including version of {@link SummaryInformation#getCharCount()} + + @return The character count ornull
+ Get if the User Defined Property Set has been updated outside of the + Application.
+If it has (true), the hyperlinks should be updated on document load.
+Gets the version of the Application which wrote the + Property set, stored with the two high order bytes having the major + version number, and the two low order bytes the minor version number.
+This will be 0 if no version is set.
+Returns the VBA digital signature for the VBA project
+ embedded in the document (or null).
Gets the content type of the file (or null).
Gets the content status of the file (or null).
Gets the document language, which is normally unset and empty
+ (or null).
Gets the document version as a string, which is normally unset and empty
+ (or null).
Creates the most specific {@link PropertySet} from an entry + in the specified POIFS Directory. This is preferrably a {@link + DocumentSummaryInformation} or a {@link SummaryInformation}. If + the specified entry does not contain a property Set stream, an + exception is thrown. If no entry is found with the given name, + an exception is thrown.
+ + @param dir The directory to find the PropertySet in + @param name The name of the entry Containing the PropertySet + @return The Created {@link PropertySet}. + @if there is no entry with that name + @if the stream does not + contain a property Set. + @if some I/O problem occurs. + @exception EncoderFallbackException if the specified codepage is not + supported. +To process this data, you may wish to make use of the + {@link Thumbnail} class. The raw data is generally + an image in WMF or Clipboard (BMP?) format
+typedef struct tagCLIPDATA {
+ // cbSize is the size of the buffer pointed To
+ // by pClipData, plus sizeof(ulClipFmt)
+ ULONG cbSize;
+ long ulClipFmt;
+ BYTE* pClipData;
+ } CLIPDATA;
+
+ See
+ msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp.
+ Turns a codepage number into the equivalent character encoding's + name.
+ + @param codepage The codepage number + + @return The character encoding's name. If the codepage number is 65001, + the encoding name is "UTF-8". All other positive numbers are mapped to + "cp" followed by the number, e.g. if the codepage number is 1252 the + returned character encoding name will be "cp1252". + + @exception UnsupportedEncodingException if the specified codepage is + less than zero. +| Value | +Description | +
|---|---|
| 0 | +No restriction | +
| 2 | +Read-only recommended | +
| 4 | +Read-only enforced | +
The highest well-known property ID. Applications are free to use + higher values for custom purposes. (This value is based on Office 12, + earlier versions of Office had lower values)
++ Returns much (but not all) of the textual content of the file, + suitable for indexing by something like Apache Lucene, or used + by Apache Tika, but not really intended for display to the user. +
+-1 means that
+ the scope of the name will be ignored and the parser will match named ranges only by name
+
+ @return the parsed formula tokens
+ null, typically empty array
+ null if there isn't one for the given name.
+ null
+ null
+ null if the formula cell is not shared/array/table,
+ or if the specified formula is not the the first in the group.
+ null.
+ null.
+ null to remove all protection
+ shouldProtectObjects are protected
+ shouldProtectScenarios are protected
+ true, this record represents an error cell value, otherwise this record represents a boolean cell value
+ null
+ null
+ @return encoded size of the formula tokens (does not include 2 bytes for ushort length)
+ Description: the default characterset. for the workbook
+REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
+Use {@link CodePageUtil} to turn these values into Java code pages + to encode/decode strings.
+ @version 2.0-pre ++ Most records construct themselves from {@link RecordInputStream}. + This class assumes that a {@link ContinueRecord} record break always occurs at the type boundary, + however, it is not always so. +
+ Two attachments to Bugzilla 50779 + demonstrate that a CONTINUE break can appear right in between two bytes of a unicode character + or between two bytes of ashort. The problematic portion of the data is
+ in a Asian Phonetic Settings Block (ExtRst) of a UnicodeString.
+
+ {@link RecordInputStream} greedily requests the bytes to be read and stumbles on such files with a
+ "Not enough data (1) to read requested (2) bytes" exception. The ContinuableRecordInput
+ class circumvents this "type boundary" rule and Reads data byte-by-byte rolling over CONTINUE if necessary.
+
+ YK: For now (March 2011) this class is only used to read + @link NPOI.HSSF.Record.Common.UnicodeString.ExtRst} blocks of a UnicodeString. + +
+ + @author Yegor Kozlov +| Mask | Description |
|---|---|
| 0x01 | is16bitEncoded |
| 0x04 | hasExtendedData |
| 0x08 | isRichText |
null if it is currently unSet.
+ DConRef Structure
+ [MS-XLS s.
+ 2.4.86], and the contained DConFile structure
+
+ [MS-XLS s. 2.5.69]. This in turn contains a XLUnicodeStringNoCch
+
+ [MS-XLS s. 2.5.296].
+
+ + _______________________________ + | DConRef | + (bytes) +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+ + | ref |cch| stFile | un| + +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+ + | + _________|_____________________ + |DConFile / XLUnicodeStringNoCch| + +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+ + (bits) |h| reserved | rgb | + +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+ ++ Where +
DConFile.h = 0x00 if the characters inrgb are single byte, and
+ DConFile.h = 0x01 if they are double byte. DConRef.un = 2. Otherwise it is 1.DConFile.rgb = (2 * DConRef.cch). Otherwise it is equal to
+ DConRef.cchDConRef.rgb starts with 0x01 if it is an external reference,
+ and with 0x02 if it is a self-reference.sid = {@value}
+ rgb field of a
+ XLUnicodeStringNoCch. Therefore it will contain at least one leading special
+ character (0x01 or 0x02) and probably other ones.
+ @see
+ DConFile [MS-XLS s. 2.5.77] and
+
+ VirtualPath [MS-XLS s. 2.5.69]
+
+ true if drop down arrow should be suppressed when list validation is
+ used, false otherwise
+ + If the type of the SupBook record is same-sheet referencing, Add-In referencing, + DDE data source referencing, or OLE data source referencing, + then no scope is specified and this value MUST be -2. Otherwise, + the scope must be set as follows: +
-2 Workbook-level reference that applies to the entire workbook.-1 Sheet-level reference. >=0 Sheet-level reference. This specifies the first sheet in the reference.
+ + If the SupBook type is unused or external workbook referencing, + then this value specifies the zero-based index of an external sheet name, + see {@link org.apache.poi.hssf.record.SupBookRecord#getSheetNames()}. + This referenced string specifies the name of the first sheet within the external workbook that is in scope. + This sheet MUST be a worksheet or macro sheet. +
++ If the supporting link type is self-referencing, then this value specifies the zero-based index of a + {@link org.apache.poi.hssf.record.BoundSheetRecord} record in the workbook stream that specifies + the first sheet within the scope of this reference. This sheet MUST be a worksheet or a macro sheet. +
+FtCblsSubRecord and
+ fill its data with the default values
+ FtPioGrbitSubRecord and
+ fill its data with the default values
+ FtPioGrbitSubRecord and
+ fill its data with the default values
+ null
+ null if the specified record is not interpreted by POI.
+ null
+ if stream was empty
+ null if not present.
+ null if
+ this pass didn't return a record that's
+ suitable for returning (eg was a continue record).
+ null if unknown to POI
+ null if textExpr does not begin with '='
+ null if numberStr is null
+ null if timeStr is null
+ null for default YYYYMMDD
+ @return null if timeStr is null
+ null
+ + One important concept worth considering Is that of font size. One of the + difficulties in Converting Graphics calls into escher Drawing calls Is that + Excel does not have the concept of absolute pixel positions. It measures + it's cell widths in 'Chars' and the cell heights in points. + Unfortunately it's not defined exactly what a type of Char it's + measuring. Presumably this Is due to the fact that the Excel will be + using different fonts on different platforms or even within the same + platform. + + Because of this constraint we've had to calculate the + verticalPointsPerPixel. This the amount the font should be scaled by when + you Issue commands such as DrawString(). A good way to calculate this + Is to use the follow formula: + ++ + @author Glen Stampoultzis (glens at apache.org) ++ multipler = GroupHeightInPoints / heightOfGroup ++ + The height of the Group Is calculated fairly simply by calculating the + difference between the y coordinates of the bounding box of the shape. The + height of the Group can be calculated by using a convenience called +HSSFClientAnchor.GetAnchorHeightInPoints() . +
0 means Context (Default), 1 means Left To Right, + and 2 means Right to Left
+ + @return order - the reading order (0,1,2) +s.
+ null otherwise
+ null otherwise
+ null otherwise
+ +
null
+ for the (conservative) assumption that any cell may have its definition changed after
+ evaluation begins.
+ null for default (AnalysisToolPak only)
+ null
+ for the (conservative) assumption that any cell may have its definition changed after
+ evaluation begins.
+ @param udfFinder pass null for default (AnalysisToolPak only)
+ + int EvaluatedCellType = evaluator.EvaluateInCell(cell).CellType; ++ Be aware that your cell value will be Changed to hold the + result of the formula. If you simply want the formula + value computed for you, use {@link #EvaluateFormulaCell(HSSFCell)} + @param cell +
+ Please note, that this method works correctly only for workbooks + with default font size (Arial 10pt for .xls). + If the default font is changed the resized image can be streched vertically or horizontally. +
+
+ resize(1.0,1.0) keeps the original size,
+ resize(0.5,0.5) resize to 50% of the original,
+ resize(2.0,2.0) resizes to 200% of the original.
+ resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE}) resizes to the dimension of the embedded image.
+
null to remove protection
+ + 10 - 10% + 20 - 20% + ... + 100 - 100% + ... + 400 - 400% ++ + @param scale window zoom magnification + @throws IllegalArgumentException if scale is invalid +
indexes.
+
+ @param indexes
+ Title: HSSFCellRangeAddress
+Description: + Implementation of the cell range Address lists,like Is described in + OpenOffice.org's Excel Documentation . + In BIFF8 there Is a common way to store absolute cell range Address + lists in several records (not formulas). A cell range Address list + consists of a field with the number of ranges and the list of the range + Addresses. Each cell range Address (called an AddR structure) Contains + 4 16-bit-values.
+Copyright: Copyright (c) 2004
+Company:
+ @author Dragos Buleandra (dragos.buleandra@trade2b.ro) + @version 2.0-pre +A class describing attributes of the Big Block Size
+2.3.4.7 ECMA-376 Document Encryption Key Generation (Standard Encryption)
+ 2.3.4.11 Encryption Key Generation (Agile Encryption)
The encryption key for ECMA-376 document encryption [ECMA-376] using agile + encryption MUST be generated by using the following method, which is derived from PKCS #5: + Password-Based Cryptography Version 2.0 [RFC2898].
+ +Let H() be a hashing algorithm as determined by the PasswordKeyEncryptor.hashAlgorithm + element, H_n be the hash data of the n-th iteration, and a plus sign (+) represent concatenation. + The password MUST be provided as an array of Unicode characters. Limitations on the length of the + password and the characters used by the password are implementation-dependent. + The initial password hash is generated as follows:
+ + +H_0 = H(salt + password)+ +
The salt used MUST be generated randomly. The salt MUST be stored in the + PasswordKeyEncryptor.saltValue element contained within the \EncryptionInfo stream as + specified in section 2.3.4.10. The hash is then iterated by using the following approach:
+ +H_n = H(iterator + H_n-1)+ +
where iterator is an unsigned 32-bit value that is initially set to 0x00000000 and then incremented + monotonically on each iteration until PasswordKey.spinCount iterations have been performed. + The value of iterator on the last iteration MUST be one less than PasswordKey.spinCount.
+ +For POI, H_final will be calculated by {@link #generateKey(byte[],HashAlgorithm,byte[],int)}
+ + @param password + @param hashAlgorithm + @param salt + @param spinCount + @return the hashed password +2.3.4.12 Initialization Vector Generation (Agile Encryption)
+ +Initialization vectors are used in all cases for agile encryption. An initialization vector MUST be + generated by using the following method, where H() is a hash function that MUST be the same as + specified in section 2.3.4.11 and a plus sign (+) represents concatenation:
+2.3.4.11 Encryption Key Generation (Agile Encryption)
+ +The final hash data that is used for an encryption key is then generated by using the following + method:
+ +H_final = H(H_n + blockKey)+ +
where blockKey represents an array of bytes used to prevent two different blocks from encrypting + to the same cipher text.
+ +If the size of the resulting H_final is smaller than that of PasswordKeyEncryptor.keyBits, the key + MUST be padded by appending bytes with a value of 0x36. If the hash value is larger in size than + PasswordKeyEncryptor.keyBits, the key is obtained by truncating the hash value.
+ + @param passwordHash + @param hashAlgorithm + @param blockKey + @param keySize + @return intermediate key ++ Use {@link #getLength()} to Get the size of that data that can be safely read from the stream. + Just Reading to the end of the input stream is not sufficient because there are + normally pAdding bytes that must be discarded +
+ + @param dir the node to read from + @return decrypted stream ++ The length variable is Initialized in {@link #getDataStream(NPOI.POIFS.FileSystem.DirectoryNode)}, + an attempt to call GetLength() prior to GetDataStream() will result in InvalidOperationException. +
+ + @return length of the encrypted data + @throws InvalidOperationException if {@link #getDataStream(NPOI.POIFS.FileSystem.DirectoryNode)} + was not called +true always
+ Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream. The File will be opened read-only
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ + @param file the File from which to read the data + + @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream.
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ + @param file the File from which to read or read/write the data + @param readOnly whether the POIFileSystem will only be used in read-only mode + + @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from an open FileChannel. This uses + * less memory than creating from an InputStream. The stream will + * be used in read-only mode.
+ * + *Note that with this constructor, you will need to call {@link #close()} + * when you're done to have the underlying Channel closed, as the channel is + * kept open during normal operation to read the data out.
+ * + * @param channel the FileChannel from which to read the data + * + * @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from an open FileChannel. This uses + less memory than creating from an InputStream.
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying Channel closed, as the channel is + kept open during normal operation to read the data out.
+ + @param channel the FileChannel from which to read or read/write the data + @param readOnly whether the POIFileSystem will only be used in read-only mode + + @exception IOException on errors reading, or on invalid data +true
+ for markSupported()). In the unlikely case that the caller has such a stream
+ and needs to use it After this constructor completes, a work around is to wrap the
+ stream in order to trap the close() call. A convenience method (
+ CreateNonClosingInputStream()) has been provided for this purpose:
+ + InputStream wrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is); + HSSFWorkbook wb = new HSSFWorkbook(wrappedStream); + is.Reset(); + doSomethingElse(is); ++ Note also the special case of MemoryStream for which the close() + method does nothing. +
+ MemoryStream bais = ... + HSSFWorkbook wb = new HSSFWorkbook(bais); // calls bais.Close() ! + bais.Reset(); // no problem + doSomethingElse(bais); ++ + @param stream the InputStream from which to read the data + + @exception IOException on errors Reading, or on invalid data +
false if an exception is currently being thrown in the calling method
+ null.
+
+ @return the dataSize
+ null
+ if no data was embedded. Note that an embedding may provide information about
+ the data, but the actual data is not included. (So label, filename etc. are
+ available, but this method returns null.)
+
+ @return the dataBuffer
+ Returns the last name in the document path's name sequence. + If the document path's name sequence is empty, then the empty string is returned.
+ + @since 2016-04-09 + @return The last name in the document path's name sequence, or empty string if this is the root path +Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream.
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ @param readOnly whether the POIFileSystem will only be used in read-only mode + + @param file the File from which to read the data + + @exception IOException on errors reading, or on invalid data +Creates a POIFSFileSystem from a File. This uses less memory than + creating from an InputStream. The File will be opened read-only
+ +Note that with this constructor, you will need to call {@link #close()} + when you're done to have the underlying file closed, as the file is + kept open during normal operation to read the data out.
+ + @param file the File from which to read the data + + @exception IOException on errors reading, or on invalid data +The value returned by this method is equal to the value that would + be returned by Arrays.asList(a).toString(), unless a + is null, in which case "null" is returned.
+ + @param a the array whose string representation to return + @return a string representation of a + @see #deepToString(Object[]) + @since 1.5 +read() method if
+ the current position is less than the limit.
+ Creates a {@link ClassID} from a human-readable representation of the Class ID in standard
+ format "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}".
Provides constants for understanding numeric codepages, + along with utilities to translate these into Java Character Sets.
+Codepage 037, a special case
+Codepage for SJIS
+Codepage for GBK, aka MS936
+Codepage for MS949
+Codepage for UTF-16
+Codepage for UTF-16 big-endian
+Codepage for Windows 1250
+Codepage for Windows 1251
+Codepage for Windows 1252
+Codepage for Windows 1253
+Codepage for Windows 1254
+Codepage for Windows 1255
+Codepage for Windows 1256
+Codepage for Windows 1257
+Codepage for Windows 1258
+Codepage for Johab
+Codepage for Macintosh Roman (Java: MacRoman)
+Codepage for Macintosh Japan (Java: unknown - use SJIS, cp942 or + cp943)
+Codepage for Macintosh Chinese Traditional (Java: unknown - use Big5, + MS950, or cp937)
+Codepage for Macintosh Korean (Java: unknown - use EUC_KR or + cp949)
+Codepage for Macintosh Arabic (Java: MacArabic)
+Codepage for Macintosh Hebrew (Java: MacHebrew)
+Codepage for Macintosh Greek (Java: MacGreek)
+Codepage for Macintosh Cyrillic (Java: MacCyrillic)
+Codepage for Macintosh Chinese Simplified (Java: unknown - use + EUC_CN, ISO2022_CN_GB, MS936 or cp935)
+Codepage for Macintosh Romanian (Java: MacRomania)
+Codepage for Macintosh Ukrainian (Java: MacUkraine)
+Codepage for Macintosh Thai (Java: MacThai)
+Codepage for Macintosh Central Europe (Latin-2) + (Java: MacCentralEurope)
+Codepage for Macintosh Iceland (Java: MacIceland)
+Codepage for Macintosh Turkish (Java: MacTurkish)
+Codepage for Macintosh Croatian (Java: MacCroatian)
+Codepage for US-ASCII
+Codepage for KOI8-R
+Codepage for ISO-8859-1
+Codepage for ISO-8859-2
+Codepage for ISO-8859-3
+Codepage for ISO-8859-4
+Codepage for ISO-8859-5
+Codepage for ISO-8859-6
+Codepage for ISO-8859-7
+Codepage for ISO-8859-8
+Codepage for ISO-8859-9
+Codepage for ISO-2022-JP
+Another codepage for ISO-2022-JP
+Yet another codepage for ISO-2022-JP
+Codepage for ISO-2022-KR
+Codepage for EUC-JP
+Codepage for EUC-KR
+Codepage for GB2312
+Codepage for GB18030
+Another codepage for US-ASCII
+Codepage for UTF-8
+Codepage for Unicode
+Turns a codepage number into the equivalent character encoding's + name.
+ + @param codepage The codepage number + + @return The character encoding's name. If the codepage number is 65001, + the encoding name is "UTF-8". All other positive numbers are mapped to + "cp" followed by the number, e.g. if the codepage number is 1252 the + returned character encoding name will be "cp1252". + + @exception UnsupportedEncodingException if the specified codepage is + less than zero. +bytesToDump bytes to an output stream.
+
+ @param in The stream to read from
+ @param out The output stream
+ @param start The index to use as the starting position for the left hand side label
+ @param bytesToDump The number of bytes to output. Use -1 to read until the end of file.
+ If the length of
The first byte read is stored into element
The
+read(b, 0, b.length)
This method blocks until input data is available, end of file is + detected, or an exception is thrown.
+ + If
The first byte read is stored into element
In every case, elements
The
The
Note that while some implementations of {@code InputStream} will return + the total number of bytes in the stream, many will not. It is + never correct to use the return value of this method to allocate + a buffer intended to hold all data in this stream.
+ +A subclass' implementation of this method may choose to throw an + {@link IOException} if this input stream has been closed by + invoking the {@link #close()} method.
+ +The {@code available} method for class {@code InputStream} always + returns {@code 0}.
+ +This method should be overridden by subclasses.
+ The
The
The general contract of
Marking a closed stream should not have any effect on the stream.
+ + The
The general contract of
The method
+ hashCode = 1;
+ Iterator i = list.Iterator();
+ while (i.HasNext()) {
+ Object obj = i.Next();
+ hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
+ }
+
+
+ This ensures that list1.Equals(list2) implies that
+ list1.HashCode()==list2.HashCode() for any two lists, list1 and
+ list2, as required by the general contract of Object.HashCode.
+
+ I am happy is someone wants to re-implement this without using the + internal list and hashmap. If so could you please make sure that + you can add elements half way into the list and have the value-key mappings + update
+byte.length bytes of data from this
+ input stream into an array of bytes. This method blocks until some
+ input is available.
+
+ simulate java FilterInputStream
+ len bytes of data from this input stream
+ into an array of bytes.If len is not zero, the method
+ blocks until some input is available; otherwise, no
+ bytes are read and0 is returned.
+
+ simulate java FilterInputStream
+
+ hashCode = 1;
+ Iterator i = list.Iterator();
+ while (i.HasNext()) {
+ Object obj = i.Next();
+ hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
+ }
+
+
+ This ensures that list1.Equals(list2) implies that
+ list1.HashCode()==list2.HashCode() for any two lists, list1 and
+ list2, as required by the general contract of Object.HashCode.
+ + References: +
epsilon of value, in absolute terms.
+ @param maxDenominator maximum denominator value allowed.
+ @param maxIterations maximum number of convergents
+ @throws RuntimeException if the continued fraction failed to
+ converge.
+ @throws IllegalArgumentException if value > Integer.MAX_VALUE
+ + Syntax: MAXIFS(data_range, criteria_range1, criteria1, [criteria_range2, criteria2]) +
++ Syntax: MINIFS(min_range, criteria_range1, criteria1, [criteria_range2, criteria2]) +
+true if date is weekend, false otherwise.
+ true if date is a holiday, false otherwise.
+ 1 is not a workday, 0 otherwise.
+ true if aDate is between start and end dates, false otherwise.
+ | Value | Days per Month | Days per Year |
|---|---|---|
| 0 (default) | 30 | 360 |
| 1 | actual | actual |
| 2 | actual | 360 |
| 3 | actual | 365 |
| 4 | 30 | 360 |
null signifying that the cell is not present (or blank)
+ @return null if the supplied cell is null or blank
+ + int EvaluatedCellType = Evaluator.EvaluateInCell(cell).CellType; ++ Be aware that your cell value will be Changed to hold the + result of the formula. If you simply want the formula + value computed for you, use {@link #EvaluateFormulaCellEnum(Cell)}} + @param cell + @return the {@code cell} that was passed in, allowing for chained calls +
+ int EvaluatedCellType = Evaluator.EvaluateFormulaCell(cell); ++ Be aware that your cell will hold both the formula, and the result. If you want the cell + Replaced with the result of the formula, use {@link #EvaluateInCell(NPOI.SS.UserModel.Cell)} + @param cell The cell to Evaluate + @return -1 for non-formula cells, or the type of the formula result +
+ ICellType EvaluatedCellType = Evaluator.EvaluateFormulaCellEnum(cell); ++ Be aware that your cell will hold both the formula, + and the result. If you want the cell Replaced with + the result of the formula, use {@link #Evaluate(NPOI.SS.UserModel.Cell)} } + @param cell The cell to Evaluate + @return The type of the formula result (the cell's type remains as CellType.FORMULA however) + If cell is not a formula cell, returns {@link CellType#_NONE} rather than throwing an exception. + @since POI 3.15 beta 3 +
Return will have no workbook set if it's actually in our own workbook
+Return will have no workbook set if it's actually in our own workbook
+null (possibly {@link BlankEval}). The specified indexes should be absolute
+ indexes in the sheet and not relative indexes within the area.
+
+ public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
+ // ...
+ Eval arg0 = args[0];
+ if(arg0 is ErrorEval) {
+ return arg0;
+ }
+ if(!(arg0 is AreaEval)) {
+ return ErrorEval.VALUE_INVALID;
+ }
+ double temp = 0;
+ AreaEval area = (AreaEval)arg0;
+ ValueEval[] values = area.LittleEndianConstants.BYTE_SIZE;
+ for (int i = 0; i < values.Length; i++) {
+ ValueEval ve = values[i];
+ if(ve is ErrorEval) {
+ return ve;
+ }
+ if(!(ve is NumericValueEval)) {
+ return ErrorEval.VALUE_INVALID;
+ }
+ temp += ((NumericValueEval)ve).NumberValue;
+ }
+ // ...
+ }
+
+ In this example, if any error is encountered while Processing the arguments, an error is
+ returned immediately. This code is difficult to refactor due to all the points where errors
+ are returned.
+ public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
+ try {
+ // ...
+ AreaEval area = GetAreaArg(args[0]);
+ double temp = sumValues(area.LittleEndianConstants.BYTE_SIZE);
+ // ...
+ } catch (EvaluationException e) {
+ return e.GetErrorEval();
+ }
+ }
+
+ private static AreaEval GetAreaArg(Eval arg0){
+ if (arg0 is ErrorEval) {
+ throw new EvaluationException((ErrorEval) arg0);
+ }
+ if (arg0 is AreaEval) {
+ return (AreaEval) arg0;
+ }
+ throw EvaluationException.InvalidValue();
+ }
+
+ private double sumValues(ValueEval[] values){
+ double temp = 0;
+ for (int i = 0; i < values.Length; i++) {
+ ValueEval ve = values[i];
+ if (ve is ErrorEval) {
+ throw new EvaluationException((ErrorEval) ve);
+ }
+ if (!(ve is NumericValueEval)) {
+ throw EvaluationException.InvalidValue();
+ }
+ temp += ((NumericValueEval) ve).NumberValue;
+ }
+ return temp;
+ }
+
+ It is not mandatory to use EvaluationException, doing so might give the following advantages:null for default (AnalysisToolPak only)
+ null if the supplied cell is null or blank
+ null.
+ | A | B | C | D | |
|---|---|---|---|---|
| 1 | 15 | 20 | 25 | |
| 2 | 200 | |||
| 3 | 300 | |||
| 3 | 400 |
| A | B | C | D | |
|---|---|---|---|---|
| 1 | 15 | 20 | 25 | |
| 2 | 1215 | 1220 | #VALUE! | 200 |
| 3 | 1315 | 1320 | #VALUE! | 300 |
| 4 | #VALUE! | #VALUE! | #VALUE! | 400 |
null, possibly empty string.
+ null.
+ nulls OK.
+ @param ptgs may be null
+ @return Never null (Possibly empty if the supplied null)
+ nulls OK.
+
+ @param formula may be null
+ @return possibly null (if the supplied null)
+ null if this formula is not part of an array or shared formula.
+ -1 means that
+ * the scope of the name will be ignored and the parser will match names only by name
+ *
+ * @return array of parsed tokens
+ * @throws FormulaParseException if the formula is unparsable
+ + A$1 + $A$1 : $B1 + A1 ....... C2 + Sheet1 !$A1 + a..b!A1 + 'my sheet'!A1 + .my.sheet!A1 + 'my sheet':'my alt sheet'!A1 + .my.sheet1:.my.sheet2!$B$2 + my.named..range. + 'my sheet'!my.named.range + .my.sheet!my.named.range + foo.bar(123.456, "abc") + 123.456 + "abc" + true + [Foo.xls]!$A$1 + [Foo.xls]'my sheet'!$A$1 + [Foo.xls]!my.named.range ++ +
+ Table1[col] + Table1[[#Totals],[col]] + Table1[#Totals] + Table1[#All] + Table1[#Data] + Table1[#Headers] + Table1[#Totals] + Table1[#This Row] + Table1[[#All],[col]] + Table1[[#Headers],[col]] + Table1[[#Totals],[col]] + Table1[[#All],[col1]:[col2]] + Table1[[#Data],[col1]:[col2]] + Table1[[#Headers],[col1]:[col2]] + Table1[[#Totals],[col1]:[col2]] + Table1[[#Headers],[#Data],[col2]] + Table1[[#This Row], [col1]] + Table1[ [col1]:[col2] ] ++ @param tableName + @return +
+ my.named...range. + foo.bar(123.456, "abc") + 123.456 + "abc" + true ++
null
+ @param part1
+ @param part2 may be null
+ null (and leaves {@link #_pointer} unchanged if a proper range part does not parse out
+ null result
+ @return The sheet name as an identifier null if '!' is not found in the right place
+ null
+ * @return Ptg a null is returned if we're in an IF formula, it needs extreme manipulation and is handled in this Function
+
+
+ Syntax :
+ AVERAGEIF ( range, criteria, avg_range )
+
| range | The range over which criteria is applied. Also used for included values when the third parameter is not present |
|---|---|
| criteria | The value or expression used to filter rows from range |
| avg_range | Locates the top-left corner of the corresponding range of addends - values to be included (after being selected by the criteria) |
+ Syntax :
+ AverageIfs ( average_range, criteria_range1, criteria1,
+ [criteria_range2, criteria2], ...)
+
criteriaRanges argument contains the same number of rows and columns
+ as the avgRange argument
+
+ @throws EvaluationException if
+ aeAvg
+ @param predicates array of predicates, a predicate for each value in ranges
+ @param aeAvg the range to calculate
+
+ @return the computed value
+ Some utils for Converting from and to any base
+ + @author cedric dot walter @ gmail dot com ++ If there are other subtotals within argument refs (or nested subtotals), + these nested subtotals are ignored to avoid double counting. +
+ + @see Subtotal ++ Syntax: COUNTBLANK ( range ) +
| range | is the range of cells to count blanks |
|---|
| range | is the range of cells to be Counted based on the criteria |
|---|---|
| criteria | is used to determine which cells to Count |
null if the arg evaluates to blank.
+ + Syntax: COUNTIFS(criteria_range1, criteria1, [criteria_range2, criteria2]) +
+Calculates the number of days between two dates based on a 360-day year + (twelve 30-day months), which is used in some accounting calculations. Use + this function to help compute payments if your accounting system is based on + twelve 30-day months.
+ + {@code DAYS360(start_date,end_date,[method])} + +
+ Syntax:
+ ERROR.TYPE(errorValue)
+ Returns a number corresponding to the error type of the supplied argument.
++
| errorValue | Return Value |
| #NULL! | 1 |
| #DIV/0! | 2 |
| #VALUE! | 3 |
| #REF! | 4 |
| #NAME? | 5 |
| #NUM! | 6 |
| #N/A! | 7 |
| everything else | #N/A! |
double representing periodic payment amount.
+ double representing interest portion of payment.
+
+ @see #pmt(double, int, double, double, int)
+ @see #fv(double, int, double, double, int)
+ double representing principal portion of payment.
+
+ @see #pmt(double, int, double, double, int)
+ @see #ipmt(double, int, int, double, double, bool)
+ double representing future principal value.
+
+ p(1+r)^n + y(1+rt)((1+r)^n-1)/r + f=0 ...{when r!=0}
+ ny + p + f=0 ...{when r=0}
+
+ null,
+ nor are any of its elements.
+ @param ec primarily used to identify the source cell Containing the formula being Evaluated.
+ may also be used to dynamically create reference evals.
+ @return never null. Possibly an instance of | reference | typically an area reference, possibly a union of areas |
|---|---|
| array | a literal array value (currently not supported) |
| row_num | selects the row within the array or area reference |
| column_num | selects column within the array or area reference. default Is 1 |
| area_num | used when reference Is a union of areas |
null if text cannot be parsed.
+ null if there is a syntax error in any escape sequence
+ (the typical syntax error is a single quote character not followed by another).
+ + Starting with the guess, the method cycles through the calculation until the result + is accurate within 0.00001 percent. If IRR can't find a result that works + after 20 tries, the Double.NaN is returned. +
++ The implementation is inspired by the NewtonSolver from the Apache Commons-Math library, + @see http://commons.apache.org +
+ + @param values the income values. + @param guess the initial guess of irr. + @return the irr value. The method returnsDouble.NaN
+ if the maximum iteration count is exceeded
+
+ @see
+ http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution
+ @see
+ http://en.wikipedia.org/wiki/Newton%27s_method
+ | Input Return | Value | Thrown Error |
|---|---|---|
| 5 | 4 | |
| 2.9 | 2 | |
| "5" | 4 | |
| "2.18e1" | 21 | |
| "-$2" | -3 | * |
| FALSE | -1 | * |
| TRUE | 0 | |
| "TRUE" | #REF! | |
| "abc" | #REF! | |
| "" | #REF! | |
| <blank> | #VALUE! |
| Value | Matching Behaviour |
|---|---|
| 1 | (default) Find the largest value that Is less than or equal to lookup_value. + The lookup_array must be in ascending order*. |
| 0 | Find the first value that Is exactly equal to lookup_value. + The lookup_array can be in any order. |
| -1 | Find the smallest value that Is greater than or equal to lookup_value. + The lookup_array must be in descending order*. |
Returns the modified internal rate of return for a series of periodic cash flows. MIRR considers both the cost + of the investment and the interest received on reinvestment of cash.
+ + Values is an array or a reference to cells that contain numbers. These numbers represent a series of payments (negative values) and income (positive values) occurring at regular periods. +Implementation for Excel Oct2Dec() function.
++ Converts an octal number to decimal. +
+
+ Syntax:
Oct2Dec (number )
+
Implementation for Excel QUOTIENT () function.
+
+ Syntax:
QUOTIENT(Numerator,Denominator)
+
+ Numerator is the dividend. + Denominator is the divisor. + + Returns the integer portion of a division. Use this function when you want to discard the remainder of a division. +
+ + If either enumerator/denominator is non numeric, QUOTIENT returns the #VALUE! error value. + If denominator is Equals to zero, QUOTIENT returns the #DIV/0! error value. + + @author cedric dot walter @ gmail dot com +
+
+ Syntax :
+ SUBTOTAL ( functionCode, ref1, ref2 ... )
+
| functionCode | (1-11) Selects the underlying aggregate function to be used (see table below) |
| ref1, ref2 ... | Arguments to be passed to the underlying aggregate function |
| functionCode | Aggregate Function |
|---|---|
| 1 | AVERAGE |
| 2 | COUNT |
| 3 | COUNTA |
| 4 | MAX |
| 5 | MIN |
| 6 | PRODUCT |
| 7 | STDEV |
| 8 | STDEVP * |
| 9 | SUM |
| 10 | VAR * |
| 11 | VARP * |
| 101-111 | * |
+
+ Syntax :
+ SUMIF ( range, criteria, sum_range )
+
| range | The range over which criteria is applied. Also used for addend values when the third parameter is not present |
|---|---|
| criteria | The value or expression used to filter rows from range |
| sum_range | Locates the top-left corner of the corresponding range of addends - values to be added (after being selected by the criteria) |
+ Syntax :
+ SUMIFS ( sum_range, criteria_range1, criteria1,
+ [criteria_range2, criteria2], ...)
+
criteria predicate is valid, i.e. not an error
+
+ @throws EvaluationException if there are criteria which resulted in Errors.
+ criteriaRanges argument contains the same number of rows and columns
+ as the sumRange argument
+
+ @throws EvaluationException if
+ aeSum
+ @param predicates array of predicates, a predicate for each value in ranges
+ @param aeSum the range to sum
+
+ @return the computed value
+ null if there is any problem converting the text
+ null if either workbook or sheet is not found
+ null
+ the current workbook is assumed. Note - to Evaluate formulas which use multiple workbooks,
+ a {@link CollaboratingWorkbooksEnvironment} must be set up.
+ @param sheetName the name of the sheet Containing the reference. May be null
+ (when null.
+ @param refStrPart2 the second part of the area reference. For single cell references this
+ parameter must be null
+ @param isA1Style specifies the format for Title: Area 3D Ptg - 3D reference (Sheet + Area)
+Description: Defined an area in Extern Sheet.
+REFERENCE:
+ + This is HSSF only, as it matches the HSSF file format way of + referring to the sheet by an extern index. The XSSF equivalent + is {@link Area3DPxg} +Title: XSSF Area 3D Reference (Sheet + Area)
+Description: Defined an area in an external or different sheet.
+REFERENCE:
+ +This is XSSF only, as it stores the sheet / book references + in String form. The HSSF equivalent using indexes is {@link Area3DPtg}
+For example, $E5:B$10 becomes B5:$E$10
This is XSSF only, as it stores the sheet / book references + in String form. The HSSF equivalent using indexes is {@link NameXPtg}
+Title: XSSF 3D Reference
+Description: Defines a cell in an external or different sheet.
+REFERENCE:
+ +This is XSSF only, as it stores the sheet / book references + in String form. The HSSF equivalent using indexes is {@link Ref3DPtg}
+null
+ null or {@link #RefErrorPtg} if no change was made
+
+ @param aptg
+ @return
+ null or {@link #AreaErrPtg} if no change was made
+
+ @param aptg
+ @return null, AreaErrPtg, or modified aptg
+ Ptg
+ tokens into human readable text form. In formula expressions, a sheet name always has a
+ trailing '!' so there is little chance for ambiguity. It doesn't matter too much what this
+ method returns but it is worth noting the likely consumers of these formula text strings:
+ + + @return+
+ Input Result Comments + "A1" true + "a111" true + "AA" false + "aa1" true + "A1A" false + "A1A1" false + "A$1:$C$20" false Not a plain cell reference + "SALES20080101" true +Still needs delimiting even though well out of range
null if the function name is unknown.
+
+ @param name Name of function.
+ @return Function executor.
+ + In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable. + With this method you can control how POI handles such missing references: +
GetMaxRows() - 1
+ GetMaxColumns() - 1
+ IV or XFD).
+ + Filtering data is a quick and easy way to find and work with a subset of data in a range of cells or table. + For example, you can filter to see only the values that you specify, filter to see the top or bottom values, + or filter to quickly see duplicate values. +
+ + TODO YK: For now (Aug 2010) POI only supports Setting a basic autofilter on a range of cells. + In future, when we support more auto-filter functions like custom criteria, sort, etc. we will add + corresponding methods to this interface. +null if there is not a built-in format at that index
+ + Automatically converts "text" to excel's format string to represent text. +
+ @param pFmt string matching a built-in format + @return index of format or -1 if undefined. ++ Cells can be numeric, formula-based or string-based (text). The cell type + specifies this. String cells cannot conatin numbers and numeric cells cannot + contain strings (at least according to our model). Client apps should do the + conversions themselves. Formula cells have the formula string, as well as + the formula result, which can be numeric or string. +
++ Cells should have their number (0 based) before being Added to a row. +
+If the cell currently contains a value, the value will + be converted to match the new type, if possible. Formatting + is generally lost in the process however.
+If what you want to do is get a String value for your + numeric cell, stop!. This is not the way to do it. + Instead, for fetching the string value of a numeric or boolean + or date cell, use {@link DataFormatter} instead.
+"SUM(C4:E4)".
+ A1 style address of this cell
+ @since 3.14beta2
+ null.
+ null.
+ + Specifies that the current drawing shall move and + resize to maintain its row and column anchors (i.e. the + object is anchored to the actual from and to row and column) +
++ Specifies that the current drawing shall move with its + row and column (i.e. the object is anchored to the + actual from row and column), but that the size shall remain absolute. +
++ If Additional rows/columns are Added between the from and to locations of the drawing, + the drawing shall move its to anchors as needed to maintain this same absolute size. +
++ Specifies that the current start and end positions shall + be maintained with respect to the distances from the + absolute start point of the worksheet. +
++ If Additional rows/columns are Added before the + drawing, the drawing shall move its anchors as needed + to maintain this same absolute position. +
++ 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells. +
+ @return the anchor type + @see #MOVE_AND_RESIZE + @see #MOVE_DONT_RESIZE + @see #DONT_MOVE_AND_RESIZE ++ For example, "highlight cells that begin with "M2" and contain "Mountain Gear". +
+ + @author Dmitriy Kumshayev + @author Yegor Kozlov ++ ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index); + newSheet.AddConditionalFormatting(cf); ++ +
+
+ // Define a Conditional Formatting rule, which triggers formatting
+ // when cell's value is greater or equal than 100.0 and
+ // applies patternFormatting defined below.
+ ConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
+ ComparisonOperator.GE,
+ "100.0", // 1st formula
+ null // 2nd formula is not used for comparison operator GE
+ );
+
+ // Create pattern with red background
+ PatternFormatting patternFmt = rule.CretePatternFormatting();
+ patternFormatting.FillBackgroundColor(IndexedColor.RED.Index);
+
+ // Define a region Containing first column
+ Region [] regions =
+ {
+ new Region(1,(short)1,-1,(short)1)
+ };
+
+ // Apply Conditional Formatting rule defined above to the regions
+ sheet.AddConditionalFormatting(regions, rule);
+
+
+ @author Dmitriy Kumshayev
+ @author Yegor Kozlov
+ null
+ null.
+ null otherwise
+ null.
+ null otherwise
+ null.
+ null otherwise
+ null otherwise
+ null otherwise
+ null otherwise
+ + MUST be either {@link #CONDITION_TYPE_CELL_VALUE_IS} or {@link #CONDITION_TYPE_FORMULA} +
+ + @return the type of condition ++ MUST be a constant from {@link ComparisonOperator} +
+ + @return the conditional format operator ++ If the condition type is {@link #CONDITION_TYPE_CELL_VALUE_IS}, + this field is the first operand of the comparison. + If type is {@link #CONDITION_TYPE_FORMULA}, this formula is used + to determine if the conditional formatting is applied. +
++ If comparison type is {@link #CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function +
+ + @return the first formula +This defines how to calculate the ranges for a conditional + formatting rule, eg which values Get a Green Traffic Light + icon and which Yellow or Red.
+If you change the range type, you need to + ensure that the Formula and Value parameters + are compatible with it before saving
+ Formula to use to calculate the threshold, + ornull if no formula
+ null is given.
+ Gets the value used for the threshold, or
+ null if there isn't one.
+ null
+ null
+ null
+ null
+ formula1 was comma-separated literal values rather than a range or named range,
+ returns list of literal values.
+ Otherwise returns null.
+ null
+ null
+ excelDate == GetExcelDate(GetJavaDate(excelDate,false))
+ Is not always true. For example if default timezone Is
+ + If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final + ctColor applied. +
++ The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and + 1.0 means 100% lighten. Also, 0.0 means no Change. +
++ In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where + HLSMAX is currently 255. +
+ Here are some examples of how to apply tint to ctColor: +++ + @return the tint value ++ If (tint < 0) + Lum' = Lum * (1.0 + tint) + + For example: Lum = 200; tint = -0.5; Darken 50% + Lum' = 200 * (0.5) => 100 + For example: Lum = 200; tint = -1.0; Darken 100% (make black) + Lum' = 200 * (1.0-1.0) => 0 + If (tint > 0) + Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint)) + For example: Lum = 100; tint = 0.75; Lighten 75% + + Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75)) + = 100 * .25 + (255 - 255 * .25) + = 25 + (255 - 63) = 25 + 192 = 217 + For example: Lum = 100; tint = 1.0; Lighten 100% (make white) + Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1)) + = 100 * 0 + (255 - 255 * 0) + = 0 + (255 - 0) = 255 ++
Example: + In the case of SUM(B1 C1), the space between B1 and C1 is treated as the binary + intersection operator, when a comma was intended. end example] +
+Example: + In the case of a function argument, text was expected, but a number was provided +
+Example: + If a formula Contains a reference to a cell, and then the row or column Containing that cell is deleted, + a #REF! error results. If a worksheet does not support 20,001 columns, + OFFSET(A1,0,20000) will result in a #REF! error. +
+Example: + Certain calls to ASIN, ATANH, FACT, and SQRT might result in domain errors. +
+ Intended to indicate that the result of a function cannot be represented in a value of + the specified type, typically due to extreme magnitude. (This is known as a range + error.) +Example: FACT(1000) might result in a range error.
+Example: + Some functions, such as SUMX2MY2, perform a series of operations on corresponding + elements in two arrays. If those arrays do not have the same number of elements, then + for some elements in the longer array, there are no corresponding elements in the + shorter one; that is, one or more values in the shorter array are not available. +
+ This error value can be produced by calling the function NA ++ int EvaluatedCellType = Evaluator.evaluateFormulaCell(cell); ++ Be aware that your cell will hold both the formula, + and the result. If you want the cell Replaced with + the result of the formula, use {@link #EvaluateInCell(Cell)} + @param cell The cell to Evaluate + @return The type of the formula result, i.e. -1 if the cell is not a formula, + or one of Cell.CELL_TYPE_NUMERIC, Cell.CELL_TYPE_STRING, Cell.CELL_TYPE_BOOLEAN, Cell.CELL_TYPE_ERROR + Note: the cell's type remains as Cell.CELL_TYPE_FORMULA however. +
+ int EvaluatedCellType = Evaluator.evaluateInCell(cell).getCellType(); ++ Be aware that your cell value will be Changed to hold the + result of the formula. If you simply want the formula + value comPuted for you, use {@link #EvaluateFormulaCell(Cell)} + @param cell +
Format class that handles Excel style fractions, such as "# #/#" and "#/###"
+ +As of this writing, this is still not 100% accurate, but it does a reasonable job + of trying to mimic Excel's fraction calculations. It does not currently + maintain Excel's spacing.
+ +This class relies on a method lifted nearly verbatim from org.apache.math.fraction. + If further uses for Commons Math are found, we will consider Adding it as a dependency. + For now, we have in-lined the one method to keep things simple.
++ Additional rules: +
+ When there is also an indent value to apply, both the left and right side of the cell + are pAdded by the indent value. +
+A 'word' is a set of characters with no space character in them.
+Two lines inside a cell are Separated by a carriage return.
+If the new Icon Set has a different number of + icons to the old one, you must update the + thresholds before saving!
+ Should Icon + Value be displayed, or only the Icon? ++ Each element corresponds to a color index (zero-based). When using the default indexed color palette, + the values are not written out, but instead are implied. When the color palette has been modified from default, + then the entire color palette is used. +
+ + @author Yegor Kozlov +null if it has not been set yet. Never empty string
+ @see #SetRefersToFormula(String)
+ + Please note, that this method works correctly only for workbooks + with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx). + If the default font is changed the resized image can be streched vertically or horizontally. +
+
+ resize(1.0,1.0) keeps the original size,
+ resize(0.5,0.5) resize to 50% of the original,
+ resize(2.0,2.0) resizes to 200% of the original.
+ resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE}) resizes to the dimension of the embedded image.
+
SetCellValue or SetCellType.
+
+ short minColIx = row.GetFirstCellNum();
+ short maxColIx = row.GetLastCellNum();
+ for(short colIx=minColIx; colIx<maxColIx; colIx++) {
+ Cell cell = row.GetCell(colIx);
+ if(cell == null) {
+ continue;
+ }
+ //... do something with cell
+ }
+
+ nullnullnull to remove protection
+ + Sheet1!$1:$1 + Sheet2!$5:$8 ++ The {@link CellRangeAddress} returned contains a column part which spans + all columns, and a row part which specifies the contiguous range of + repeating rows. + + If the Sheet does not have any repeating rows defined, null is returned. +
+ Sheet1!$A:$A + Sheet2!$C:$F ++ The {@link CellRangeAddress} returned contains a row part which spans all + rows, and a column part which specifies the contiguous range of + repeating columns. + + If the Sheet does not have any repeating columns defined, null is + returned. +
A1.
+ + The Created conditional formatting rule Compares a cell value + to a formula calculated result, using the specified operator. + The type of the Created condition is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS} +
+ + @param comparisonOperation - MUST be a constant value from ++
XSSFTable.UpdateHeaders() is called to reset the cache.
+ @param columnHeader the column header name to Get the table column index of
+ @return column index corresponding to columnHeader
+ + When text direction is horizontal: the vertical alignment of lines of text is distributed vertically, + where each line of text inside the cell is evenly distributed across the height of the cell, + with flush top and bottom margins. +
++ When text direction is vertical: similar behavior as horizontal justification. + The alignment is justified (flush top and bottom in this case). For each line of text, each + line of the wrapped text in a cell is aligned to the top and bottom (except the last line). + If no single line of text wraps in the cell, then the text is not justified. +
++ When text direction is horizontal: the vertical alignment of lines of text is distributed vertically, + where each line of text inside the cell is evenly distributed across the height of the cell, + with flush top +
++ When text direction is vertical: behaves exactly as distributed horizontal alignment. + The first words in a line of text (appearing at the top of the cell) are flush + with the top edge of the cell, and the last words of a line of text are flush with the bottom edge of the cell, + and the line of text is distributed evenly from top to bottom. +
++ This is different from the normal hidden status + ({@link #isSheetHidden(int)}) +
+ @param sheetIx sheet index to check + @returntrue if sheet is very hidden
+ + 0 = not hidden + 1 = hidden + 2 = very hidden. ++ @param sheetIx The sheet number + @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden +
| Result | Comment |
|---|---|
| A1:A1 | Single cell area reference without sheet |
| A1:$C$1 | Multi-cell area reference without sheet |
| Sheet1!A$1:B4 | Standard sheet name |
| 'O''Brien''s Sales'!B5:C6' | Sheet name with special Chars |
This class is a Container for POI usermodel row=0 column=0 cell references. + It is barely a Container for these two coordinates. The implementation + of the Comparable interface sorts by "natural" order top left to bottom right.
+ +Use CellAddress when you want to refer to the location of a cell in a sheet + when the concept of relative/absolute does not apply (such as the anchor location + of a cell comment). Use {@link CellReference} when the concept of + relative/absolute does apply (such as a cell reference in a formula). + CellAddresses do not have a concept of "sheet", while CellReferences do.
+Common conversion functions between Excel style A1, C27 style + cell references, and POI usermodel style row=0, column=0 + style references. Handles sheet-based and sheet-free references + as well, eg "Sheet1!A1" and "$B$72"
+ +Use CellReference when the concept of + relative/absolute does apply (such as a cell reference in a formula). + Use {@link CellAddress} when you want to refer to the location of a cell in a sheet + when the concept of relative/absolute does not apply (such as the anchor location + of a cell comment). + CellReferences have a concept of "sheet", while CellAddresses do not.
+| Result | Comment |
|---|---|
| A1 | Cell reference without sheet |
| Sheet1!A1 | Standard sheet name |
| 'O''Brien''s Sales'!A1' | Sheet name with special characters |
+ POI currently targets BIFF8 (Excel 97-2003), so the following behaviour can be observed for + this method: ++
+ Version File Format +Last Column Last Row + 97-2003 BIFF8 "IV" (2^8) 65536 (2^14) + 2007 BIFF12 "XFD" (2^14) 1048576 (2^20)
+ + @param colStr a string of only letter characters + @param rowStr a string of only digit characters + @return+
+ Input +Result + "A", "1" true + "a", "111" true + "A", "65536" true + "A", "65537" false + "iv", "1" true + "IW", "1" false + "AAA", "1" false + "a", "111" true + "Sheet", "1" false
This method attempts to find an existing CellStyle that matches the cell's
+ current style plus styles properties in properties. A new style is created if the
+ workbook does not contain a matching style.
Modifies the cell style of cell without affecting other cells that use the
+ same style.
This is necessary because Excel has an upper limit on the number of styles that it supports.
+ +This function is more efficient than multiple calls to + {@link #setCellStyleProperty(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.usermodel.Workbook, String, Object)} + if adding multiple cell styles.
+ +For performance reasons, if this is the only cell in a workbook that uses a cell style, + this method does NOT remove the old style from the workbook. + +
+ + @param cell The cell to change the style of + @param properties The properties to be added to a cell style, as {propertyName: propertyValue}. + @since POI 3.14 beta 2 +This method attempts to find an existing CellStyle that matches the cell's
+ current style plus a single style property propertyName with value
+ propertyValue.
+ A new style is created if the workbook does not contain a matching style.
Modifies the cell style of cell without affecting other cells that use the
+ same style.
If setting more than one cell style property on a cell, use + {@link #setCellStyleProperties(org.apache.poi.ss.usermodel.Cell, Map)}, + which is faster and does not add unnecessary intermediate CellStyles to the workbook.
+ + @param cell The cell that is to be changed. + @param propertyName The name of the property that is to be changed. + @param propertyValue The value of the property that is to be changed. +This method attempts to find an existing CellStyle that matches the cell's
+ current style plus a single style property propertyName with value
+ propertyValue.
+ A new style is created if the workbook does not contain a matching style.
Modifies the cell style of cell without affecting other cells that use the
+ same style.
If setting more than one cell style property on a cell, use + {@link #setCellStyleProperties(Cell, Map)}, + which is faster and does not add unnecessary intermediate CellStyles to the workbook.
+ + @param workbook The workbook that is being worked with. + @param propertyName The name of the property that is to be changed. + @param propertyValue The value of the property that is to be changed. + @param cell The cell that needs it's style changes +style, so subsequent changes
+ to style will not modify the map, and changes to the returned
+ map will not modify the cell style. The returned map is mutable.
+ @param style cell style
+ @return map of format properties (String -> Object)
+ @see #setFormatProperties(org.apache.poi.ss.usermodel.CellStyle, org.apache.poi.ss.usermodel.Workbook, java.util.Map)
+ | 1 | 2 |
| 3 | 4 |
25.4/HorizontalPixelSize
+ and 25.4/VerticalPixelSize. Where 25.4 is the number of mm in inch.
+
+ @return array of two elements: {horisontalPdi, verticalDpi}.
+ {96, 96} is the default.
+ negative, 0, or positive according to the standard Excel comparison
+ of values isNegative ? -1 : +1
+ java.util.Date or java.util.Calendar
+ instances become date cells.Object.toString()
+ method call.If the cell at the given co-ordinates is a merged cell, this will + return the primary (top-left) most cell of the merged region.
+If the cell at the given co-ordinates is not in a merged region, + then will return the cell itself.
+If there is no cell defined at the given co-ordinates, will return + null.
+
+ The character count
+ 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.
++ 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.
+1.3.6.1.4.1.22554
+1.3.6.1.4.1.22554.1
+1.3.6.1.4.1.22554.1.1
+
+ LinkedCertificate := SEQUENCE {
+ digest DigestInfo, -- digest of PQC certificate
+ certLocation GeneralName, -- location of PQC certificate
+ certIssuer [0] Name OPTIONAL, -- issuer of PQC cert (if different from current certificate)
+ cACerts [1] GeneralNames OPTIONAL, -- CA certificates for PQC cert (one of more locations)
+ }
+
+
+ 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.
+
+ 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. +
+ 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.
+
+ 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)
+
+ + PkiFreeText ::= SEQUENCE SIZE (1..MAX) OF UTF8String ++
+ 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.
+
+ 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. +
+ 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. +
+ Attribute ::= SEQUENCE {
+ attrType OBJECT IDENTIFIER,
+ attrValues SET OF AttributeValue
+ }
+
+ + Attributes ::= + SET SIZE(1..MAX) OF Attribute -- according to RFC 5652 ++ @return +
+ 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
+
+
+ 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
+
+
+ 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 }
+
+
+ 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 }
+
+
+ CompressedData ::= Sequence {
+ version CMSVersion,
+ compressionAlgorithm CompressionAlgorithmIdentifier,
+ encapContentInfo EncapsulatedContentInfo
+ }
+
+
+ CompressedData ::= SEQUENCE {
+ version CMSVersion,
+ compressionAlgorithm CompressionAlgorithmIdentifier,
+ encapContentInfo EncapsulatedContentInfo
+ }
+
+
+ ContentInfo ::= Sequence {
+ contentType ContentType,
+ content
+ [0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
+
+
+ ContentInfo ::= SEQUENCE {
+ contentType ContentType,
+ content
+ [0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
+
+
+ MQVuserKeyingMaterial ::= SEQUENCE {
+ ephemeralPublicKey OriginatorPublicKey,
+ addedukm [0] EXPLICIT UserKeyingMaterial OPTIONAL }
+
+
+ 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.
+
+ EnvelopedData ::= Sequence {
+ version CMSVersion,
+ originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
+ recipientInfos RecipientInfos,
+ encryptedContentInfo EncryptedContentInfo,
+ unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL
+ }
+
+
+ EnvelopedData ::= SEQUENCE {
+ version CMSVersion,
+ originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
+ recipientInfos RecipientInfos,
+ encryptedContentInfo EncryptedContentInfo,
+ unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL
+ }
+
+
+ KekIdentifier ::= Sequence {
+ keyIdentifier OCTET STRING,
+ date GeneralizedTime OPTIONAL,
+ other OtherKeyAttribute OPTIONAL
+ }
+
+
+ KekRecipientInfo ::= Sequence {
+ version CMSVersion, -- always set to 4
+ kekID KekIdentifier,
+ keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
+ encryptedKey EncryptedKey
+ }
+
+
+ KeyAgreeRecipientIdentifier ::= CHOICE {
+ issuerAndSerialNumber IssuerAndSerialNumber,
+ rKeyId [0] IMPLICIT RecipientKeyIdentifier
+ }
+
+
+ * KeyAgreeRecipientInfo ::= Sequence {
+ * version CMSVersion, -- always set to 3
+ * originator [0] EXPLICIT OriginatorIdentifierOrKey,
+ * ukm [1] EXPLICIT UserKeyingMaterial OPTIONAL,
+ * keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
+ * recipientEncryptedKeys RecipientEncryptedKeys
+ * }
+ *
+ * UserKeyingMaterial ::= OCTET STRING
+ *
+
+ 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
+
+ OriginatorIdentifierOrKey ::= CHOICE {
+ issuerAndSerialNumber IssuerAndSerialNumber,
+ subjectKeyIdentifier [0] SubjectKeyIdentifier,
+ originatorKey [1] OriginatorPublicKey
+ }
+
+ SubjectKeyIdentifier ::= OCTET STRING
+
+
+ OriginatorInfo ::= Sequence {
+ certs [0] IMPLICIT CertificateSet OPTIONAL,
+ crls [1] IMPLICIT CertificateRevocationLists OPTIONAL
+ }
+
+
+ OriginatorPublicKey ::= Sequence {
+ algorithm AlgorithmIdentifier,
+ publicKey BIT STRING
+ }
+
+
+ OtherKeyAttribute ::= Sequence {
+ keyAttrId OBJECT IDENTIFIER,
+ keyAttr ANY DEFINED BY keyAttrId OPTIONAL
+ }
+
+
+ OtherRecipientInfo ::= Sequence {
+ oriType OBJECT IDENTIFIER,
+ oriValue ANY DEFINED BY oriType }
+
+
+ OtherRevocationInfoFormat ::= SEQUENCE {
+ otherRevInfoFormat OBJECT IDENTIFIER,
+ otherRevInfo ANY DEFINED BY otherRevInfoFormat }
+
+
+ PasswordRecipientInfo ::= Sequence {
+ version CMSVersion, -- Always set to 0
+ keyDerivationAlgorithm [0] KeyDerivationAlgorithmIdentifier
+ OPTIONAL,
+ keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
+ encryptedKey EncryptedKey }
+
+
+ RecipientEncryptedKey ::= SEQUENCE {
+ rid KeyAgreeRecipientIdentifier,
+ encryptedKey EncryptedKey
+ }
+
+
+ RecipientIdentifier ::= CHOICE {
+ issuerAndSerialNumber IssuerAndSerialNumber,
+ subjectKeyIdentifier [0] SubjectKeyIdentifier
+ }
+
+ SubjectKeyIdentifier ::= OCTET STRING
+
+
+ RecipientInfo ::= CHOICE {
+ ktri KeyTransRecipientInfo,
+ kari [1] KeyAgreeRecipientInfo,
+ kekri [2] KekRecipientInfo,
+ pwri [3] PasswordRecipientInfo,
+ ori [4] OtherRecipientInfo }
+
+
+ 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.
+
+ 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
+ }
+
+
+ SignerIdentifier ::= CHOICE {
+ issuerAndSerialNumber IssuerAndSerialNumber,
+ subjectKeyIdentifier [0] SubjectKeyIdentifier
+ }
+
+ SubjectKeyIdentifier ::= OCTET STRING
+
+
+ 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
+
+
+ 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. +
+ 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.
+
+ 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.
+
+ 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 }
+
+
+ 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.
+
+ 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.
+
+ 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.
+
+ Gost28147-89-Parameters ::=
+ SEQUENCE {
+ iv Gost28147-89-IV,
+ encryptionParamSet OBJECT IDENTIFIER
+ }
+
+ Gost28147-89-IV ::= OCTET STRING (SIZE (8))
+
+ 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.
+ 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
+ 0 single-ASN1-type1 OCTET STRING2 BIT STRING+ 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.
+ + @param time the time string.
++ 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.
+
+ CertificateValues ::= SEQUENCE OF Certificate
+
+
+ CommitmentTypeIndication ::= SEQUENCE {
+ commitmentTypeId CommitmentTypeIdentifier,
+ commitmentTypeQualifier SEQUENCE SIZE (1..MAX) OF
+ CommitmentTypeQualifier OPTIONAL }
+
+
+ CommitmentTypeQualifier ::= SEQUENCE {
+ commitmentTypeIdentifier CommitmentTypeIdentifier,
+ qualifier ANY DEFINED BY commitmentTypeIdentifier OPTIONAL }
+
+ CommitmentTypeQualifier instance.
+
+ @param commitmentTypeIdentifier a CommitmentTypeIdentifier value
+ CommitmentTypeQualifier instance.
+
+ @param commitmentTypeIdentifier a CommitmentTypeIdentifier value
+ @param qualifier the qualifier, defined by the above field.
+ CommitmentTypeQualifier instance.
+
+ @param as CommitmentTypeQualifier structure
+ encoded as an Asn1Sequence.
+ Asn1Object value
+
+ CompleteCertificateRefs ::= SEQUENCE OF OtherCertID
+
+
+ CompleteRevocationRefs ::= SEQUENCE OF CrlOcspRef
+
+
+ CrlIdentifier ::= SEQUENCE
+ {
+ crlissuer Name,
+ crlIssuedTime UTCTime,
+ crlNumber INTEGER OPTIONAL
+ }
+
+
+ CRLListID ::= SEQUENCE
+ {
+ crls SEQUENCE OF CrlValidatedID
+ }
+
+
+ CrlOcspRef ::= SEQUENCE {
+ crlids [0] CRLListID OPTIONAL,
+ ocspids [1] OcspListID OPTIONAL,
+ otherRev [2] OtherRevRefs OPTIONAL
+ }
+
+
+ CrlValidatedID ::= SEQUENCE {
+ crlHash OtherHash,
+ crlIdentifier CrlIdentifier OPTIONAL}
+
+
+ OcspIdentifier ::= SEQUENCE {
+ ocspResponderID ResponderID,
+ -- As in OCSP response data
+ producedAt GeneralizedTime
+ -- As in OCSP response data
+ }
+
+
+ OcspListID ::= SEQUENCE {
+ ocspResponses SEQUENCE OF OcspResponsesID
+ }
+
+
+ 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
+
+
+ OtherHashAlgAndValue ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ hashValue OtherHashValue
+ }
+
+ OtherHashValue ::= OCTET STRING
+
+
+ OtherRevRefs ::= SEQUENCE
+ {
+ otherRevRefType OtherRevRefType,
+ otherRevRefs ANY DEFINED BY otherRevRefType
+ }
+
+ OtherRevRefType ::= OBJECT IDENTIFIER
+
+
+ OtherRevVals ::= SEQUENCE
+ {
+ otherRevValType OtherRevValType,
+ otherRevVals ANY DEFINED BY otherRevValType
+ }
+
+ OtherRevValType ::= OBJECT IDENTIFIER
+
+
+ OtherSigningCertificate ::= SEQUENCE {
+ certs SEQUENCE OF OtherCertID,
+ policies SEQUENCE OF PolicyInformation OPTIONAL
+ }
+
+
+ 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.
+
+
+ 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
+
+
+ ContentHints ::= SEQUENCE {
+ contentDescription UTF8String (SIZE (1..MAX)) OPTIONAL,
+ contentType ContentType }
+
+ + 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 } +
+ 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
+ }
+
+
+ OtherCertID ::= SEQUENCE {
+ otherCertHash OtherHash,
+ issuerSerial IssuerSerial OPTIONAL }
+
+ OtherHash ::= CHOICE {
+ sha1Hash OCTET STRING,
+ otherHash OtherHashAlgAndValue }
+
+ OtherHashAlgAndValue ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ hashValue OCTET STRING }
+
+
+
+ OtherSigningCertificate ::= SEQUENCE {
+ certs SEQUENCE OF OtherCertID,
+ policies SEQUENCE OF PolicyInformation OPTIONAL
+ }
+
+ id-aa-ets-otherSigCert OBJECT IDENTIFIER ::= { iso(1)
+ member-body(2) us(840) rsadsi(113549) pkcs(1) pkcs9(9)
+ smime(16) id-aa(2) 19 }
+
+ 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 }
+
+ 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 }
+ + If you use this interface your class should also implement the getInstance + pattern which takes a tag object and the tagging mode used. +
+
+ CscaMasterList ::= SEQUENCE {
+ version CscaMasterListVersion,
+ certList SET OF Certificate }
+
+ CscaMasterListVersion :: INTEGER {v0(0)}
+
+
+ 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) }
+
+
+
+ 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
+ + DateOfCertGenSyntax ::= GeneralizedTime ++
+ ICCSNSyntax ::= OCTET STRING (SIZE(8..20)) ++
+ PKReferenceSyntax ::= OCTET STRING (SIZE(20)) ++
+ RestrictionSyntax ::= DirectoryString (SIZE(1..1024)) ++ + @see Org.BouncyCastle.Asn1.IsisMtt.X509.Restriction +
+ RetrieveIfAllowed ::= BOOLEAN ++
+ CertInDirSince ::= GeneralizedTime ++
+ NameAtBirth ::= DirectoryString(SIZE(1..64) ++ + Used in + {@link Org.BouncyCastle.Asn1.X509.SubjectDirectoryAttributes SubjectDirectoryAttributes} +
+ AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048)) ++ + @see Org.BouncyCastle.Asn1.IsisMtt.X509.AdditionalInformationSyntax +
+ LiabilityLimitationFlagSyntax ::= BOOLEAN ++
+ CertHash ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ certificateHash OCTET STRING
+ }
+
+
+ CertHash ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ certificateHash OCTET STRING
+ }
+
+
+ @param seq The ASN.1 sequence.
+
+ CertHash ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ certificateHash OCTET STRING
+ }
+
+
+ @return an Asn1Object
+
+ RequestedCertificate ::= CHOICE {
+ Certificate Certificate,
+ publicKeyCertificate [0] EXPLICIT OCTET STRING,
+ attributeCertificate [1] EXPLICIT OCTET STRING
+ }
+
+ null.
+
+ @param certificate Given as Certificate
+
+ RequestedCertificate ::= CHOICE {
+ Certificate Certificate,
+ publicKeyCertificate [0] EXPLICIT OCTET STRING,
+ attributeCertificate [1] EXPLICIT OCTET STRING
+ }
+
+
+ @return an Asn1Object
+ + AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048)) ++
+ AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048)) ++ + @return an Asn1Object +
+ 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
+
+ Admissions ::= SEQUENCE
+ {
+ admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
+ namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
+ professionInfos SEQUENCE OF ProfessionInfo
+ }
+
+
+ @param seq The ASN.1 sequence.
+ professionInfos is mandatory.
+
+ @param admissionAuthority The admission authority.
+ @param namingAuthority The naming authority.
+ @param professionInfos The profession infos.
+
+ Admissions ::= SEQUENCE
+ {
+ admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
+ namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
+ professionInfos SEQUENCE OF ProfessionInfo
+ }
+
+
+
+ @return an Asn1Object
+
+ 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:
+
+ 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.
+
+ 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
+
+ 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.
+
+ 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
+
+ MonetaryLimitSyntax ::= SEQUENCE
+ {
+ currency PrintableString (SIZE(3)),
+ amount INTEGER,
+ exponent INTEGER
+ }
+
+
+ currency must be the ISO code.
+
+ value = amount�10*exponent
+
+ MonetaryLimitSyntax ::= SEQUENCE
+ {
+ currency PrintableString (SIZE(3)),
+ amount INTEGER,
+ exponent INTEGER
+ }
+
+
+ @return an Asn1Object
+
+ NamingAuthority ::= SEQUENCE
+ {
+ namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
+ namingAuthorityUrl IA5String OPTIONAL,
+ namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
+ }
+
+ @see Org.BouncyCastle.Asn1.IsisMtt.X509.AdmissionSyntax
+
+
+ NamingAuthority ::= SEQUENCE
+ {
+ namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
+ namingAuthorityUrl IA5String OPTIONAL,
+ namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
+ }
+
+
+ @param seq The ASN.1 sequence.
+
+ NamingAuthority ::= SEQUENCE
+ {
+ namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
+ namingAuthorityUrl IA5String OPTIONAL,
+ namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
+ }
+
+
+ @return an Asn1Object
+ + 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
+ }
+
+
+
+ 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.
+ 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.
+ 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.
+
+ 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
+
+ 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
+
+ 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.
+ 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.
+
+ 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
+ + RestrictionSyntax ::= DirectoryString (SIZE(1..1024)) ++
+ RestrictionSyntax ::= DirectoryString (SIZE(1..1024)) ++ + @param restriction A IAsn1String. +
+ RestrictionSyntax ::= DirectoryString (SIZE(1..1024)) + ++ + @return an Asn1Object +
+ cast5CBCParameters ::= Sequence {
+ iv OCTET STRING DEFAULT 0,
+ -- Initialization vector
+ keyLength Integer
+ -- Key length, in bits
+ }
+
+
+ IDEA-CBCPar ::= Sequence {
+ iv OCTET STRING OPTIONAL -- exactly 8 octets
+ }
+
+
+ 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) }
+
+
+ PublicKeyAndChallenge ::= SEQUENCE {
+ spki SubjectPublicKeyInfo,
+ challenge IA5STRING
+ }
+
+
+
+ BasicOcspResponse ::= Sequence {
+ tbsResponseData ResponseData,
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING,
+ certs [0] EXPLICIT Sequence OF Certificate OPTIONAL }
+
+
+ CertID ::= Sequence {
+ hashAlgorithm AlgorithmIdentifier,
+ issuerNameHash OCTET STRING, -- Hash of Issuer's DN
+ issuerKeyHash OCTET STRING, -- Hash of Issuers public key
+ serialNumber CertificateSerialNumber }
+
+
+ CertStatus ::= CHOICE {
+ good [0] IMPLICIT Null,
+ revoked [1] IMPLICIT RevokedInfo,
+ unknown [2] IMPLICIT UnknownInfo }
+
+
+ CrlID ::= Sequence {
+ crlUrl [0] EXPLICIT IA5String OPTIONAL,
+ crlNum [1] EXPLICIT Integer OPTIONAL,
+ crlTime [2] EXPLICIT GeneralizedTime OPTIONAL }
+
+
+ OcspRequest ::= Sequence {
+ tbsRequest TBSRequest,
+ optionalSignature [0] EXPLICIT Signature OPTIONAL }
+
+
+ OcspResponse ::= Sequence {
+ responseStatus OcspResponseStatus,
+ responseBytes [0] EXPLICIT ResponseBytes OPTIONAL }
+
+
+ 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
+ }
+
+
+ Request ::= Sequence {
+ reqCert CertID,
+ singleRequestExtensions [0] EXPLICIT Extensions OPTIONAL }
+
+
+ ResponderID ::= CHOICE {
+ byName [1] Name,
+ byKey [2] KeyHash }
+
+
+ ResponseBytes ::= Sequence {
+ responseType OBJECT IDENTIFIER,
+ response OCTET STRING }
+
+
+ ResponseData ::= Sequence {
+ version [0] EXPLICIT Version DEFAULT v1,
+ responderID ResponderID,
+ producedAt GeneralizedTime,
+ responses Sequence OF SingleResponse,
+ responseExtensions [1] EXPLICIT Extensions OPTIONAL }
+
+
+ RevokedInfo ::= Sequence {
+ revocationTime GeneralizedTime,
+ revocationReason [0] EXPLICIT CRLReason OPTIONAL }
+
+
+ ServiceLocator ::= Sequence {
+ issuer Name,
+ locator AuthorityInfoAccessSyntax OPTIONAL }
+
+
+ Signature ::= Sequence {
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING,
+ certs [0] EXPLICIT Sequence OF Certificate OPTIONAL}
+
+
+ SingleResponse ::= Sequence {
+ certID CertID,
+ certStatus CertStatus,
+ thisUpdate GeneralizedTime,
+ nextUpdate [0] EXPLICIT GeneralizedTime OPTIONAL,
+ singleExtensions [1] EXPLICIT Extensions OPTIONAL }
+
+
+ TBSRequest ::= Sequence {
+ version [0] EXPLICIT Version DEFAULT v1,
+ requestorName [1] EXPLICIT GeneralName OPTIONAL,
+ requestList Sequence OF Request,
+ requestExtensions [2] EXPLICIT Extensions OPTIONAL }
+
+
+ Attr ::= Sequence {
+ attrType OBJECT IDENTIFIER,
+ attrValues Set OF AttributeValue
+ }
+
+
+ CertificationRequest ::= Sequence {
+ certificationRequestInfo CertificationRequestInfo,
+ signatureAlgorithm AlgorithmIdentifier{{ SignatureAlgorithms }},
+ signature BIT STRING
+ }
+
+
+ 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})
+ }
+
+
+ ContentInfo ::= Sequence {
+ contentType ContentType,
+ content
+ [0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
+
+
+ EncryptedData ::= Sequence {
+ version Version,
+ encryptedContentInfo EncryptedContentInfo
+ }
+
+
+ EncryptedContentInfo ::= Sequence {
+ contentType ContentType,
+ contentEncryptionAlgorithm ContentEncryptionAlgorithmIdentifier,
+ encryptedContent [0] IMPLICIT EncryptedContent OPTIONAL
+ }
+
+ EncryptedContent ::= OCTET STRING
+
+
+ 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.
+
+ id-alg-AEADChaCha20Poly1305 OBJECT IDENTIFIER ::=
+ { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1)
+ pkcs9(9) smime(16) alg(3) 18 }
+
+ AEADChaCha20Poly1305Nonce ::= OCTET STRING (SIZE(12))
+
+
+ [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 } }
+
+
+ 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.
+
+ 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.
+
+ 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.
+
+ SignedData ::= Sequence {
+ version Version,
+ digestAlgorithms DigestAlgorithmIdentifiers,
+ contentInfo ContentInfo,
+ certificates
+ [0] IMPLICIT ExtendedCertificatesAndCertificates
+ OPTIONAL,
+ crls
+ [1] IMPLICIT CertificateRevocationLists OPTIONAL,
+ signerInfos SignerInfos }
+
+
+ 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
+
+ + SMIMECapabilities ::= Sequence OF SMIMECapability ++
+ SMIMECapability ::= Sequence {
+ capabilityID OBJECT IDENTIFIER,
+ parameters ANY DEFINED BY capabilityID OPTIONAL
+ }
+
+
+ SmimeEncryptionKeyPreference ::= CHOICE {
+ issuerAndSerialNumber [0] IssuerAndSerialNumber,
+ receipentKeyId [1] RecipientKeyIdentifier,
+ subjectAltKeyIdentifier [2] SubjectKeyIdentifier
+ }
+
+
+ Accuracy ::= SEQUENCE {
+ seconds INTEGER OPTIONAL,
+ millis [0] INTEGER (1..999) OPTIONAL,
+ micros [1] INTEGER (1..999) OPTIONAL
+ }
+
+
+ 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 }
+
+
+
+ AttributeTypeAndValue ::= SEQUENCE {
+ type OBJECT IDENTIFIER,
+ value ANY DEFINED BY type }
+
+ @return 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)) }
+
+
+ * RelativeDistinguishedName ::=
+ * SET OF AttributeTypeAndValue
+
+ * AttributeTypeAndValue ::= SEQUENCE {
+ * type AttributeType,
+ * value AttributeValue }
+ *
+ * @return this object as its ASN1Primitive type
+
+ AccessDescription ::= SEQUENCE {
+ accessMethod OBJECT IDENTIFIER,
+ accessLocation GeneralName }
+
+
+ AlgorithmIdentifier ::= Sequence {
+ algorithm OBJECT IDENTIFIER,
+ parameters ANY DEFINED BY algorithm OPTIONAL }
+
+
+ AttCertIssuer ::= CHOICE {
+ v1Form GeneralNames, -- MUST NOT be used in this
+ -- profile
+ v2Form [0] V2Form -- v2 only
+ }
+
+
+ AttCertValidityPeriod ::= Sequence {
+ notBeforeTime GeneralizedTime,
+ notAfterTime GeneralizedTime
+ }
+
+
+ Attr ::= Sequence {
+ attrType OBJECT IDENTIFIER,
+ attrValues Set OF AttributeValue
+ }
+
+
+ AttributeCertificate ::= Sequence {
+ acinfo AttributeCertificateInfo,
+ signatureAlgorithm AlgorithmIdentifier,
+ signatureValue BIT STRING
+ }
+
+
+ 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) }
+
+
+ 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 }
+
+
+ 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
+
+
+ + * SubjectPublicKeyInfo apki = new SubjectPublicKeyInfo((ASN1Sequence)new ASN1InputStream( + * publicKey.getEncoded()).readObject()); + * AuthorityKeyIdentifier aki = new AuthorityKeyIdentifier(apki); + *+ * + * +
+ BasicConstraints := Sequence {
+ cA Boolean DEFAULT FALSE,
+ pathLenConstraint Integer (0..MAX) OPTIONAL
+ }
+
+
+ CertificateList ::= Sequence {
+ tbsCertList TbsCertList,
+ signatureAlgorithm AlgorithmIdentifier,
+ signatureValue BIT STRING }
+
+
+ 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 -- }
+
+
+ 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.
+
+ CertificatePair ::= SEQUENCE {
+ forward [0] Certificate OPTIONAL,
+ reverse [1] Certificate OPTIONAL,
+ -- at least one of the pair shall be present -- }
+
+
+ @return a DERObject
+
+ CertificatePolicies ::= SEQUENCE SIZE {1..MAX} OF PolicyInformation
+
+ + CertPolicyId ::= OBJECT IDENTIFIER ++
+ CrlDistPoint ::= Sequence SIZE {1..MAX} OF DistributionPoint
+
+ + CRLNumber::= Integer(0..MAX) ++
+ CRLReason ::= Enumerated {
+ unspecified (0),
+ keyCompromise (1),
+ cACompromise (2),
+ affiliationChanged (3),
+ superseded (4),
+ cessationOfOperation (5),
+ certificateHold (6),
+ removeFromCRL (8),
+ privilegeWithdrawn (9),
+ aACompromise (10)
+ }
+
+
+ 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
+ DisplayTextMaximumSize here.
+
+ DisplayText instance.
+
+ @param type the desired encoding type for the text.
+ @param text the text to store. Strings longer than 200
+ characters are truncated.
+ DisplayText instance.
+
+ @param text the text to encapsulate. Strings longer than 200
+ characters are truncated.
+ DisplayText instance.
+ Useful when reading back a DisplayText class
+ from it's Asn1Encodable form.
Asn1Encodable instance.
+ string object.
+
+ @return the stored text as a string.
+
+ DistributionPoint ::= Sequence {
+ distributionPoint [0] DistributionPointName OPTIONAL,
+ reasons [1] ReasonFlags OPTIONAL,
+ cRLIssuer [2] GeneralNames OPTIONAL
+ }
+
+
+ DistributionPointName ::= CHOICE {
+ fullName [0] GeneralNames,
+ nameRelativeToCRLIssuer [1] RDN
+ }
+
+ + extendedKeyUsage ::= Sequence SIZE (1..MAX) OF KeyPurposeId ++
+ 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 }
+
+ + This constructor can handle: +
+ 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. +
+ GeneralNames ::= Sequence SIZE {1..MAX} OF GeneralName
+
+
+
+ GeneralSubtree ::= SEQUENCE
+ {
+ baseName GeneralName,
+ minimum [0] BaseDistance DEFAULT 0,
+ maximum [1] BaseDistance OPTIONAL
+ }
+
+
+ @see org.bouncycastle.asn1.x509.NameConstraints
+
+
+ If minimum is null, zero is assumed, if
+ maximum is null, maximum is absent.
+ GeneralSubtree ::= SEQUENCE
+ {
+ baseName GeneralName,
+ minimum [0] BaseDistance DEFAULT 0,
+ maximum [1] BaseDistance OPTIONAL
+ }
+
+
+ @return a DERObject
+ + 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
+
+
+
+ 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
+ }
+
+ IetfAttrSyntax as specified by RFC3281.
+
+
+ IetfAttrSyntax ::= Sequence {
+ policyAuthority [0] GeneralNames OPTIONAL,
+ values Sequence OF CHOICE {
+ octets OCTET STRING,
+ oid OBJECT IDENTIFIER,
+ string UTF8String
+ }
+ }
+
+
+
+ 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 }
+
+ true then the CRL contains revocation
+ information about certificates ssued by other CAs.
+ @param onlyContainsAttributeCerts Covers revocation information for attribute certificates.
+ + KeyPurposeID ::= OBJECT IDENTIFIER ++
+ 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) }
+
+ 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
+ NoticeReference instance.
+
+ @param organization a String value
+ @param numbers a Vector value
+ NoticeReference instance.
+
+ @param organization a String value
+ @param noticeNumbers an ASN1EncodableVector value
+ NoticeReference instance.
+
+ @param organization displayText
+ @param noticeNumbers an ASN1EncodableVector value
+ NoticeReference instance.
+ Useful for reconstructing a NoticeReference
+ instance from its encodable/encoded form.
Asn1Sequence value obtained from either
+ calling @{link ToAsn1Object()} for a NoticeReference
+ instance or from parsing it from a Der-encoded stream.
+ ToAsn1Object method here.
+
+ @return a Asn1Object value
+
+
+ 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
+ }
+
+
+
+
+ If digestedObjectType is not {@link #publicKeyCert} or
+ {@link #publicKey} otherObjectTypeID must be given,
+ otherwise it is ignored.
otherObjectDigest.
+ @param digestAlgorithm The algorithm identifier for the hash.
+ @param objectDigest The hash value.
+
+
+ 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
+ }
+
+
+
+ OtherName ::= SEQUENCE {
+ type-id OBJECT IDENTIFIER,
+ value [0] EXPLICIT ANY DEFINED BY type-id }
+
+
+ OtherName. It must be an instance of OtherName
+ or ASN1Sequence.
+ @return the instance of OtherName built from the
+ supplied object.
+ @throws java.lang.IllegalArgumentException if the object passed
+ to the factory is not an instance of OtherName or something that
+ can be converted into an appropriate ASN1Sequence.
+
+ PolicyMappings ::= Sequence SIZE (1..MAX) OF Sequence {
+ issuerDomainPolicy CertPolicyId,
+ subjectDomainPolicy CertPolicyId }
+
+
+ @see RFC 3280, section 4.2.1.6
+ PolicyMappings instance.
+
+ @param seq an Asn1Sequence constructed as specified
+ in RFC 3280
+ PolicyMappings instance.
+
+ @param mappings a HashMap value that maps
+ string oids
+ to other string oids.
+
+ 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 )
+
+
+ PolicyQualifierInfo ::= Sequence {
+ policyQualifierId PolicyQualifierId,
+ qualifier ANY DEFINED BY policyQualifierId }
+
+ PolicyQualifierInfo instance.
+
+ @param policyQualifierId a PolicyQualifierId value
+ @param qualifier the qualifier, defined by the above field.
+ PolicyQualifierInfo containing a
+ cPSuri qualifier.
+
+ @param cps the CPS (certification practice statement) uri as a
+ string.
+ PolicyQualifierInfo instance.
+
+ @param as PolicyQualifierInfo X509 structure
+ encoded as an Asn1Sequence.
+ Asn1Object value
+
+ PrivateKeyUsagePeriod ::= SEQUENCE
+ {
+ notBefore [0] GeneralizedTime OPTIONAL,
+ notAfter [1] GeneralizedTime OPTIONAL }
+
+
+ BiometricData ::= SEQUENCE {
+ typeOfBiometricData TypeOfBiometricData,
+ hashAlgorithm AlgorithmIdentifier,
+ biometricDataHash OCTET STRING,
+ sourceDataUri IA5String OPTIONAL }
+
+
+ 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
+
+
+ MonetaryValue ::= SEQUENCE {
+ currency Iso4217CurrencyCode,
+ amount INTEGER,
+ exponent INTEGER }
+ -- value = amount * 10^exponent
+
+
+ QCStatement ::= SEQUENCE {
+ statementId OBJECT IDENTIFIER,
+ statementInfo ANY DEFINED BY statementId OPTIONAL}
+
+
+ SemanticsInformation ::= SEQUENCE {
+ semanticsIdentifier OBJECT IDENTIFIER OPTIONAL,
+ nameRegistrationAuthorities NameRegistrationAuthorities
+ OPTIONAL }
+ (WITH COMPONENTS {..., semanticsIdentifier PRESENT}|
+ WITH COMPONENTS {..., nameRegistrationAuthorities PRESENT})
+
+ NameRegistrationAuthorities ::= SEQUENCE SIZE (1..MAX) OF
+ GeneralName
+
+
+ TypeOfBiometricData ::= CHOICE {
+ predefinedBiometricType PredefinedBiometricType,
+ biometricDataOid OBJECT IDENTIFIER }
+
+ PredefinedBiometricType ::= INTEGER {
+ picture(0),handwritten-signature(1)}
+ (picture|handwritten-signature)
+
+
+ ReasonFlags ::= BIT STRING {
+ unused(0),
+ keyCompromise(1),
+ cACompromise(2),
+ affiliationChanged(3),
+ superseded(4),
+ cessationOfOperation(5),
+ certficateHold(6)
+ }
+
+
+ RoleSyntax ::= SEQUENCE {
+ roleAuthority [0] GeneralNames OPTIONAL,
+ roleName [1] GeneralName
+ }
+
+
+ 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.
+ new RoleSyntax(null, roleName).
+ @param roleName the role name of this RoleSyntax.
+ string argument representing
+ the role name, builds a GeneralName to hold the role name
+ and calls the constructor that takes a GeneralName.
+ @param roleName
+ 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.
+ GeneralNames holding the
+ role authority of this RoleSyntax.
+ GeneralName holding the
+ role name of this RoleSyntax.
+ java.lang.string object.
+ @return the role name of this RoleSyntax represented as a
+ string object.
+ string[] object.
+ @return the role authority of this RoleSyntax represented as a
+ string[] array.
+ ToAsn1Object as
+ required by the superclass ASN1Encodable.
+
+
+ RoleSyntax ::= SEQUENCE {
+ roleAuthority [0] GeneralNames OPTIONAL,
+ roleName [1] GeneralName
+ }
+
+
+ RSAPublicKey ::= Sequence {
+ modulus Integer, -- n
+ publicExponent Integer, -- e
+ }
+
+
+ NameOrPseudonym ::= CHOICE {
+ surAndGivenName SEQUENCE {
+ surName DirectoryString,
+ givenName SEQUENCE OF DirectoryString
+ },
+ pseudonym DirectoryString
+ }
+
+
+ @see org.bouncycastle.asn1.x509.sigi.PersonalData
+
+
+ NameOrPseudonym ::= CHOICE {
+ surAndGivenName SEQUENCE {
+ surName DirectoryString,
+ givenName SEQUENCE OF DirectoryString
+ },
+ pseudonym DirectoryString
+ }
+
+ @param pseudonym pseudonym value to use.
+
+ NameOrPseudonym ::= CHOICE {
+ surAndGivenName SEQUENCE {
+ surName DirectoryString,
+ givenName SEQUENCE OF DirectoryString
+ },
+ pseudonym DirectoryString
+ }
+
+
+ @param seq The ASN.1 sequence.
+
+ NameOrPseudonym ::= CHOICE {
+ surAndGivenName SEQUENCE {
+ surName DirectoryString,
+ givenName SEQUENCE OF DirectoryString
+ },
+ pseudonym DirectoryString
+ }
+
+
+ @return an Asn1Object
+
+ 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
+
+ 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.
+
+ 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
+
+ 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.X509Name for AttributeType ObjectIdentifiers.
+
+ 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.
+
+ 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
+ + SubjectKeyIdentifier::= OCTET STRING ++
+ (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. +
+ (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 GetEncoded() method in the public keys in the JCE produces a DER + encoded one of these.
+
+ SubjectPublicKeyInfo ::= Sequence {
+ algorithm AlgorithmIdentifier,
+ publicKey BIT STRING }
+
+
+ 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.
+
+ obj can be a Target or a {@link Asn1TaggedObject}
+ Exactly one of the parameters must be not null.
+ Target ::= CHOICE {
+ targetName [0] GeneralName,
+ targetGroup [1] GeneralName,
+ targetCert [2] TargetCert
+ }
+
+
+ @return an Asn1Object
+ + SEQUENCE OF Targets ++ +
+ obj can be a TargetInformation or a {@link Asn1Sequence}
+ The ArrayList is cloned before it is returned.
+ + @return Returns the targets. ++ 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 ::= 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
+
+ obj can be a Targets or a {@link Asn1Sequence}
+ The ArrayList is copied.
+ + @param targets AnArrayList of {@link Target}s.
+ @see Target
+ @throws ArgumentException if the ArrayList contains not only Targets.
+ ArrayList.
+ + The ArrayList is cloned before it is returned.
+ + @return Returns the targets. ++ Targets ::= SEQUENCE OF Target ++ + @return an Asn1Object +
+ 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.
+
+ 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
+ }
+
+
+ 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
+ UserNotice instance.
+
+ @param noticeRef a NoticeReference value
+ @param explicitText a DisplayText value
+ UserNotice instance.
+
+ @param noticeRef a NoticeReference value
+ @param str the explicitText field as a string.
+ 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.
+ TbsCertificate ::= Sequence {
+ version [ 0 ] Version DEFAULT v1(0),
+ serialNumber CertificateSerialNumber,
+ signature AlgorithmIdentifier,
+ issuer Name,
+ validity Validity,
+ subject Name,
+ subjectPublicKeyInfo SubjectPublicKeyInfo,
+ }
+
+
+
+ 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
+ }
+
+
+
+ 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
+ }
+
+
+ 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
+
+ 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
+ }
+
+
+
+ Certificate ::= Sequence {
+ tbsCertificate TbsCertificate,
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING
+ }
+
+ + it's is assumed the table contains Oid/string pairs.
++ It's is assumed the table contains Oid/string pairs.
++ it's is assumed the table contains Oid/string pairs.
++ It's is assumed the table contains Oid/string pairs.
+
+ Extensions ::= SEQUENCE SIZE (1..MAX) OF Extension
+
+ Extension ::= SEQUENCE {
+ extnId EXTENSION.&id ({ExtensionSet}),
+ critical BOOLEAN DEFAULT FALSE,
+ extnValue OCTET STRING }
+
+
+ RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
+
+ RelativeDistinguishedName ::= SET SIZE (1..MAX) OF AttributeTypeAndValue
+
+ AttributeTypeAndValue ::= SEQUENCE {
+ type OBJECT IDENTIFIER,
+ value ANY }
+
+ Note: if you're trying to be ultra orthodox, don't use this! It shouldn't be in here.
++ it's is assumed the table contains OID/string pairs, and the contents + of the table are copied into an internal table as part of the + construction process. The ordering ArrayList should contain the OIDs + in the order they are meant to be encoded or printed in ToString.
++ it's is assumed the table contains OID/string pairs, and the contents + of the table are copied into an internal table as part of the + construction process. The ordering ArrayList should contain the OIDs + in the order they are meant to be encoded or printed in ToString.
++ The passed in converter will be used to convert the strings into their + ASN.1 counterparts.
++ The passed in converter will be used to convert the strings into their + ASN.1 counterparts.
++ * An example of an encoder look like below: + *
+ * public class X509DirEntryConverter
+ * : X509NameEntryConverter
+ * {
+ * public Asn1Object GetConvertedValue(
+ * DerObjectIdentifier oid,
+ * string value)
+ * {
+ * if (str.Length() != 0 && str.charAt(0) == '#')
+ * {
+ * return ConvertHexEncoded(str, 1);
+ * }
+ * if (oid.Equals(EmailAddress))
+ * {
+ * return new DerIA5String(str);
+ * }
+ * else if (CanBePrintable(str))
+ * {
+ * return new DerPrintableString(str);
+ * }
+ * else if (CanBeUTF8(str))
+ * {
+ * return new DerUtf8String(str);
+ * }
+ * else
+ * {
+ * return new DerBmpString(str);
+ * }
+ * }
+ * }
+ *
+ *
+
+ KeySpecificInfo ::= Sequence {
+ algorithm OBJECT IDENTIFIER,
+ counter OCTET STRING SIZE (4..4)
+ }
+
+
+ OtherInfo ::= Sequence {
+ keyInfo KeySpecificInfo,
+ partyAInfo [0] OCTET STRING OPTIONAL,
+ suppPubInfo [2] OCTET STRING
+ }
+
+
+ Parameters ::= CHOICE {
+ ecParameters ECParameters,
+ namedCurve CURVES.&id({CurveNames}),
+ implicitlyCA Null
+ }
+
+
+ Curve ::= Sequence {
+ a FieldElement,
+ b FieldElement,
+ seed BIT STRING OPTIONAL
+ }
+
+
+ ECParameters ::= Sequence {
+ version Integer { ecpVer1(1) } (ecpVer1),
+ fieldID FieldID {{FieldTypes}},
+ curve X9Curve,
+ base X9ECPoint,
+ order Integer,
+ cofactor Integer OPTIONAL
+ }
+
+ + ECPoint ::= OCTET STRING ++
+ Octet string produced using ECPoint.GetEncoded().
++ FieldElement ::= OCTET STRING ++
+
F2.
+ @param primeP The prime p defining the prime field.
+ F2m.
+ @param m The exponent m of
+ F2m.
+ @param k1 The integer k1 where xm +
+ xk1 + 1
+ represents the reduction polynomial f(z).
+ 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)..
+
+ FieldID ::= Sequence {
+ fieldType FIELD-ID.&id({IOSet}),
+ parameters FIELD-ID.&Type({IOSet}{@fieldType})
+ }
+
+ + Return an output stream which will save the data being written to + the compressed object. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Return an output stream which will compress the data as it is written to it. + The stream will be written out in chunks according to the size of the passed in buffer. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Note: if the buffer is not a power of 2 in length only the largest power of 2 + bytes worth of the buffer will be used. +
++ Note: using this may break compatibility with RFC 1991 compliant tools. + Only recent OpenPGP implementations are capable of accepting these streams. +
++ If buffer is non null stream assumed to be partial, otherwise the length will be used + to output a fixed length packet. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Return an output stream which will encrypt the data as it is written to it. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Return an output stream which will encrypt the data as it is written to it. + The stream will be written out in chunks according to the size of the passed in buffer. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Note: if the buffer is not a power of 2 in length only the largest power of 2 + bytes worth of the buffer will be used. +
++ Close off the encrypted object - this is equivalent to calling Close() on the stream + returned by the Open() method. +
++ Note: This does not close the underlying output stream, only the stream on top of + it created by the Open() method. +
++ A word for the unwary, the KeyId for an OpenPGP public key is calculated from + a hash that includes the time of creation, if you pass a different date to the + constructor below with the same public private key pair the KeyIs will not be the + same as for previous generations of the key, so ideally you only want to do + this once. +
++ Open a literal data packet, returning a stream to store the data inside the packet. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Open a literal data packet, returning a stream to store the data inside the packet, + as an indefinite length stream. The stream is written out as a series of partial + packets with a chunk size determined by the size of the passed in buffer. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Note: if the buffer is not a power of 2 in length only the largest power of 2 + bytes worth of the buffer will be used.
+
+ Open a literal data packet for the passed in
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Note: if this class finds a PgpPublicKey or a PgpSecretKey it + will create a PgpPublicKeyRing, or a PgpSecretKeyRing for each + key found. If all you are trying to do is read a key ring file use + either PgpPublicKeyRingBundle or PgpSecretKeyRingBundle.
+
+ Often PGP keyring files consist of multiple master keys, if you are trying to process
+ or construct one of these you should use the
+ Often PGP keyring files consist of multiple master keys, if you are trying to process
+ or construct one of these you should use the
+ Note: this overrides the generation of a creation time when the signature + is generated.
++ Format documented here: + http://git.gnupg.org/cgi-bin/gitweb.cgi?p=gnupg.git;a=blob;f=agent/keyformat.txt;h=42c4b1f06faf1bbe71ffadc2fee0fad6bec91a97;hb=refs/heads/master +
++ CMSAuthenticatedDataGenerator fact = new CMSAuthenticatedDataGenerator(); + + fact.addKeyTransRecipient(cert); + + CMSAuthenticatedData data = fact.generate(content, algorithm, "BC"); ++
+ Note: that because we are in a streaming mode only one recipient can be tried and it is important + that the methods on the parser are called in the appropriate order. +
++ Example of use - assuming the first recipient matches the private key we have. +
+ CMSAuthenticatedDataParser ad = new CMSAuthenticatedDataParser(inputStream);
+
+ RecipientInformationStore recipients = ad.getRecipientInfos();
+
+ Collection c = recipients.getRecipients();
+ Iterator it = c.iterator();
+
+ if (it.hasNext())
+ {
+ RecipientInformation recipient = (RecipientInformation)it.next();
+
+ CMSTypedStream recData = recipient.getContentStream(privateKey, "BC");
+
+ processDataStream(recData.getContentStream());
+
+ if (!Arrays.equals(ad.getMac(), recipient.getMac())
+ {
+ System.err.println("Data corrupted!!!!");
+ }
+ }
+
+ Note: this class does not introduce buffering - if you are processing large files you should create
+ the parser with:
+ + CMSAuthenticatedDataParser ep = new CMSAuthenticatedDataParser(new BufferedInputStream(inputStream, bufSize)); ++ where bufSize is a suitably large buffer size. + +
+ A simple example of usage. +
+ CMSAuthenticatedDataStreamGenerator edGen = new CMSAuthenticatedDataStreamGenerator(); + + edGen.addKeyTransRecipient(cert); + + ByteArrayOutputStream bOut = new ByteArrayOutputStream(); + + OutputStream out = edGen.open( + bOut, CMSAuthenticatedDataGenerator.AES128_CBC, "BC");* + out.write(data); + + out.close(); ++ +
+ * A simple example of usage.
+ *+ *
+ * CMSCompressedDataGenerator fact = new CMSCompressedDataGenerator(); + * CMSCompressedData data = fact.Generate(content, algorithm); + *+ * +
+ CMSCompressedDataParser cp = new CMSCompressedDataParser(inputStream); + + process(cp.GetContent().GetContentStream()); ++ Note: this class does not introduce buffering - if you are processing large files you should create + the parser with: +
+ CMSCompressedDataParser ep = new CMSCompressedDataParser(new BufferedInputStream(inputStream, bufSize)); ++ where bufSize is a suitably large buffer size. +
+ A simple example of usage. +
++ CMSCompressedDataStreamGenerator gen = new CMSCompressedDataStreamGenerator(); + + Stream cOut = gen.Open(outputStream, CMSCompressedDataStreamGenerator.ZLIB); + + cOut.Write(data); + + cOut.Close(); ++
+ CmsEnvelopedDataGenerator fact = new CmsEnvelopedDataGenerator(); + + fact.AddKeyTransRecipient(cert); + + CmsEnvelopedData data = fact.Generate(content, algorithm); ++
+ Note: that because we are in a streaming mode only one recipient can be tried and it is important + that the methods on the parser are called in the appropriate order. +
++ Example of use - assuming the first recipient matches the private key we have. +
+ CmsEnvelopedDataParser ep = new CmsEnvelopedDataParser(inputStream);
+
+ RecipientInformationStore recipients = ep.GetRecipientInfos();
+
+ Collection c = recipients.getRecipients();
+ Iterator it = c.iterator();
+
+ if (it.hasNext())
+ {
+ RecipientInformation recipient = (RecipientInformation)it.next();
+
+ CMSTypedStream recData = recipient.getContentStream(privateKey);
+
+ processDataStream(recData.getContentStream());
+ }
+
+ Note: this class does not introduce buffering - if you are processing large files you should create
+ the parser with:
+ + CmsEnvelopedDataParser ep = new CmsEnvelopedDataParser(new BufferedInputStream(inputStream, bufSize)); ++ where bufSize is a suitably large buffer size. + +
+ A simple example of usage. +
+ CmsEnvelopedDataStreamGenerator edGen = new CmsEnvelopedDataStreamGenerator(); + + edGen.AddKeyTransRecipient(cert); + + MemoryStream bOut = new MemoryStream(); + + Stream out = edGen.Open( + bOut, CMSEnvelopedDataGenerator.AES128_CBC);* + out.Write(data); + + out.Close(); ++ +
+ CMSEnvelopedDataGenerator fact = new CMSEnvelopedDataGenerator(); + + fact.addKeyTransRecipient(cert); + + CMSEnvelopedData data = fact.generate(content, algorithm, "BC"); ++
+ IX509Store certs = s.GetCertificates();
+ SignerInformationStore signers = s.GetSignerInfos();
+
+ foreach (SignerInformation signer in signers.GetSigners())
+ {
+ ArrayList certList = new ArrayList(certs.GetMatches(signer.SignerID));
+ X509Certificate cert = (X509Certificate) certList[0];
+
+ if (signer.Verify(cert.GetPublicKey()))
+ {
+ verified++;
+ }
+ }
+
+ + * A simple example of usage. + * + *
+ * IX509Store certs... + * IX509Store crls... + * CmsSignedDataGenerator gen = new CmsSignedDataGenerator(); + * + * gen.AddSigner(privKey, cert, CmsSignedGenerator.DigestSha1); + * gen.AddCertificates(certs); + * gen.AddCrls(crls); + * + * CmsSignedData data = gen.Generate(content); + *+ * +
+ Note: that because we are in a streaming mode only one signer can be tried and it is important + that the methods on the parser are called in the appropriate order. +
++ A simple example of usage for an encapsulated signature. +
++ Two notes: first, in the example below the validity of + the certificate isn't verified, just the fact that one of the certs + matches the given signer, and, second, because we are in a streaming + mode the order of the operations is important. +
+
+ CmsSignedDataParser sp = new CmsSignedDataParser(encapSigData);
+
+ sp.GetSignedContent().Drain();
+
+ IX509Store certs = sp.GetCertificates();
+ SignerInformationStore signers = sp.GetSignerInfos();
+
+ foreach (SignerInformation signer in signers.GetSigners())
+ {
+ ArrayList certList = new ArrayList(certs.GetMatches(signer.SignerID));
+ X509Certificate cert = (X509Certificate) certList[0];
+
+ Console.WriteLine("verify returns: " + signer.Verify(cert));
+ }
+
+ Note also: this class does not introduce buffering - if you are processing large files you should create
+ the parser with:
+ + CmsSignedDataParser ep = new CmsSignedDataParser(new BufferedInputStream(encapSigData, bufSize)); ++ where bufSize is a suitably large buffer size. +
+ The output stream is returned unclosed. +
+ @param original the signed data stream to be used as a base. + @param signerInformationStore the new signer information store to use. + @param out the stream to Write the new signed data object to. + @return out. ++ The output stream is returned unclosed. +
+ @param original the signed data stream to be used as a base. + @param certsAndCrls the new certificates and CRLs to be used. + @param out the stream to Write the new signed data object to. + @return out. + @exception CmsException if there is an error processing the CertStore ++ A simple example of usage. +
+
+ IX509Store certs...
+ CmsSignedDataStreamGenerator gen = new CmsSignedDataStreamGenerator();
+
+ gen.AddSigner(privateKey, cert, CmsSignedDataStreamGenerator.DIGEST_SHA1);
+
+ gen.AddCertificates(certs);
+
+ Stream sigOut = gen.Open(bOut);
+
+ sigOut.Write(Encoding.UTF8.GetBytes("Hello World!"));
+
+ sigOut.Close();
+
+ + note: This uses MTI/A0 key agreement in order to make the key agreement + secure against passive attacks. If you're doing Diffie-Hellman and both + parties have long term public keys you should look at using this. For + further information have a look at RFC 2631.
++ It's possible to extend this to more than two parties as well, for the moment + that is left as an exercise for the reader.
++ 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.
++ 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!).
++ 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. +
++ NOTE: This algorithm is only included for backwards compatibility + with legacy applications, it's not secure, don't use it for anything new!
+Implementation of RipeMD256.
+Note: this algorithm offers the same level of security as RipeMD128.
+Implementation of RipeMD 320.
+Note: this algorithm offers the same level of security as RipeMD160.
++ 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 ++
+ block word digest + SHA-1 512 32 160 + SHA-256 512 32 256 + SHA-384 1024 64 384 + SHA-512 1024 64 512 ++
+ block word digest + SHA-1 512 32 160 + SHA-256 512 32 256 + SHA-384 1024 64 384 + SHA-512 1024 64 512 ++
+ block word digest + SHA-1 512 32 160 + SHA-256 512 32 256 + SHA-384 1024 64 384 + SHA-512 1024 64 512 ++
null to use no parameters.
+ null to use no parameters.
+ + The static property is checked during construction of the encoding object, it is set to + true by default. +
++ 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. +
++ 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 fast version with 8Kbytes of static tables for round precomputation +
++ 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 slowest performance version with no static tables + for round precomputation, but it has the smallest foot print. +
++ * Note: + *
+ http://www.ecrypt.eu.org/stream/p3ciphers/hc/hc128_p3.pdf +
+ It is a third phase candidate in the eStream contest, and is patent-free. + No attacks are known as of today (April 2007). See + + http://www.ecrypt.eu.org/stream/hcp3.html +
++ http://www.ecrypt.eu.org/stream/p3ciphers/hc/hc256_p3.pdf +
+ Its brother, HC-128, is a third phase candidate in the eStream contest. + The algorithm is patent-free. No attacks are known as of today (April 2007). + See + + http://www.ecrypt.eu.org/stream/hcp3.html +
++ This implementation is based on the "HOWTO: INTERNATIONAL DATA ENCRYPTION ALGORITHM" + implementation summary by Fauzan Mirza (F.U.Mirza@sheffield.ac.uk). (barring 1 typo at the + end of the MulInv function!). +
++ It can be found at ftp://ftp.funet.fi/pub/crypt/cryptography/symmetric/idea/ +
++ Note: This algorithm was patented in the USA, Japan and Europe. These patents expired in 2011/2012. +
++ i.e. x * MulInv(x) == 1 (modulo BASE) +
++ i.e. x + AddInv(x) == 0 +
+RC5 Encryption Algorithm
+ publication in RSA CryptoBytes, Spring of 1995.
+ http://www.rsasecurity.com/rsalabs/cryptobytes.
+ + This implementation has a word size of 32 bits.
+RC5 Encryption Algorithm
+ publication in RSA CryptoBytes, Spring of 1995.
+ http://www.rsasecurity.com/rsalabs/cryptobytes.
+ + This implementation is set to work with a 64 bit word size.
++ Note: this implementation is based on information prior to readonly NIST publication. +
++ * 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 + *
+null to use the current key.
+ the 2 word (128 bit) tweak, or null to use the current tweak.
+ + Tnepres is based on Serpent which was designed by Ross Anderson, Eli Biham and Lars Knudsen as a + candidate algorithm for the NIST AES Quest. Unfortunately there was an endianness issue + with test vectors in the AES submission and the resulting confusion lead to the Tnepres cipher + as well, which is a byte swapped version of Serpent. +
++ For full details see The Serpent home page +
++ *
+ * G(x) = x^4 + (a+1/a)x^3 + ax^2 + (a+1/a)x + 1 + *+ * where a = primitive root of field generator 0x14D + * +
+ This implementation does not correspondent to the 1999 published paper + "A Future-Adaptable Password Scheme" of Niels Provos and David Mazières, + see: https://www.usenix.org/legacy/events/usenix99/provos/provos_html/node1.html. + In contrast to the paper, the order of key setup and salt setup is reversed: + state <- ExpandKey(state, 0, key) + state %lt;- ExpandKey(state, 0, salt) + This corresponds to the OpenBSD reference implementation of Bcrypt. +
+ Note: + There is no successful cryptanalysis (status 2015), but + the amount of memory and the band width of Bcrypt + may be insufficient to effectively prevent attacks + with custom hardware like FPGAs, ASICs +
+ This implementation uses some parts of Bouncy Castle's BlowfishEngine. +
++ This implements the raw bcrypt function as defined in the bcrypt specification, not + the crypt encoded version implemented in OpenBSD. +
+ @param password the password bytes (up to 72 bytes) to use for this invocation. + @param salt the 128 bit salt to use for this invocation. + @param cost the bcrypt cost parameter. The cost of the bcrypt function grows as +2^cost. Legal values are 4..31 inclusive.
+ @return the output of the raw bcrypt operation: a 192 bit (24 byte) hash.
+ + Note: can take a while...
++ This Generates keys consistent for use with ElGamal as described in + page 164 of "Handbook of Applied Cryptography".
++ * Note: can take a while... + *
++ The scheme is a simple extension of PKCS 5 V2.0 Scheme 1 using MD5 with an + iteration count of 1. +
++ The document this implementation is based on can be found at + + RSA's Pkcs12 Page +
++ The document this implementation is based on can be found at + + RSA's Pkcs5 Page +
++ The document this implementation is based on can be found at + + RSA's Pkcs5 Page
+k[0] ... k[15], r[0] ... r[15] with the required bits in r cleared
+ as per r (second 16 bytes) portion of the key.k[0] ... k[15], r[0] ... r[15]
+ k[0] ... k[15], r[0] ... r[15] with the required bits in r cleared
+ as per r portion of the key.2^(128 * r / 8).
+ the block size, must be >= 1.
+ Parallelization parameter. Must be a positive integer less than or equal to
+ Int32.MaxValue / (128 * r * 8).
+ the length of the key to generate.
+ + 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. ++ 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. ++ 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. ++ 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 cfbBitSize the size of an output block produced by the CFB mode. + @param macSizeInBits the size of the MAC in bits, must be a multiple of 8. ++ 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 cfbBitSize the size of an output block produced by the CFB mode. + @param macSizeInBits the size of the MAC in bits, must be a multiple of 8. + @param padding a padding to be used. ++ 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. +
++ 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. ++ 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. +null to use no parameters.
+ + Note: this mode is a packet mode - it needs all the data up front. +
++License for + Open-Source Software Implementations of OCB (Jan 9, 2013) - 'License 1'
+ Under this license, you are authorized to make, use, and distribute open-source software + implementations of OCB. This license terminates for you if you sue someone over their open-source + software implementation of OCB claiming that you have a patent covering their implementation. ++ This is a non-binding summary of a legal document (the link above). The parameters of the license + are specified in the license document and that document is controlling.
+ * For further info see RFC 2440. + *
++ This padding pads the block out compliment of the last bit + of the plain text. +
++ Note: this assumes that the last block of plain text is always + passed to it inside in. i.e. if inOff is zero, indicating the + entire block is to be overwritten with padding the value of in + should be the same as the last block of plain text. +
++ See "Applied + Cryptography" by Bruce Schneier for more information. +
+ @return true if the given DES key material is weak or semi-weak, + false otherwise. +null if not
+ set.
+ null if not set.
+ null if not set.
+ null if not set.
+ null if
+ not set.
+ YYYYMMDD email@address distinguisher, encoded to a byte
+ sequence using UTF-8 encoding.
+ null to use the current key.null to use the current tweak.+ Internal access to the digest is synchronized so a single one of these can be shared. +
++ 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). ++ 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). ++ 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). ++ Access to internals is synchronized so a single one of these can be shared. +
++ 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. +
++ Any SecureRandom created from a builder constructed like this will make use of input passed to SecureRandom.setSeed() if + the passed in SecureRandom does for its generateSeed() call. +
+ @param entropySource + @param predictionResistant ++ Note: If this constructor is used any calls to setSeed() in the resulting SecureRandom will be ignored. +
+ @param entropySourceProvider a provider of EntropySource objects. ++ Based on an idea from Marcus Lippert. +
++ If fast is set to true, the code should be round about 8 times faster when + generating a long sequence of random bytes. 20 bytes of random values using + the fast mode take less than half a second on a Nokia e70. If fast is set to false, + it takes round about 2500 ms. +
+ @param numBytes the number of bytes to generate + @param fast true if fast mode should be used +
+ // First 1850 fractional digit of Pi number.
+ byte[] key = new BigInteger("14159265358979323846...5068006422512520511").ToByteArray();
+ s = 0;
+ P = new byte[256];
+ for (int i = 0; i < 256; i++)
+ {
+ P[i] = (byte) i;
+ }
+ for (int m = 0; m < 768; m++)
+ {
+ s = P[(s + P[m & 0xff] + key[m % key.length]) & 0xff];
+ byte temp = P[m & 0xff];
+ P[m & 0xff] = P[s & 0xff];
+ P[s & 0xff] = temp;
+ }
+ + 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. +
++ Any SecureRandom created from a builder constructed like this will make use of input passed to SecureRandom.setSeed() if + the passed in SecureRandom does for its generateSeed() call. +
+ @param entropySource + @param predictionResistant ++ Note: If this constructor is used any calls to setSeed() in the resulting SecureRandom will be ignored. +
+ @param entropySourceProvider a provider of EntropySource objects. ++ Note: the usual length for the salt is the length of the hash + function used in bytes.
++ Note: the usual value for the salt length is the number of + bytes in the hash function.
++ 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. +
+ This file could be more optimized. +
+
+ opaque ASN.1Cert<2^24-1>;
+
+ struct {
+ ASN.1Cert certificate_list<0..2^24-1>;
+ } Certificate;
+
+
+ @see Org.BouncyCastle.Asn1.X509.X509CertificateStructure
+ true if this certificate chain contains no certificates, or
+ false otherwise.
+
+ struct {
+ ClientCertificateType certificate_types<1..2^8-1>;
+ DistinguishedName certificate_authorities<3..2^16-1>
+ } CertificateRequest;
+
+
+ @see ClientCertificateType
+ @see X509Name
+ close_notify warning alert.
+ true if the handshake should be aborted when the peer does not negotiate the
+ extended_master_secret extension, or false to support legacy interoperability.
+ true if the current time should be used in the gmt_unix_time field of
+ Random, or false if gmt_unix_time should contain a cryptographically
+ random value.
+ OfferInput(input, 0, input.length)
+ @see TlsProtocol#OfferInput(byte[], int, int)
+ @param input The input buffer to offer
+ @throws IOException If an error occurs while decrypting or processing a record
+ From Knuth Vol 2, pg 395.
+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.
+ 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.
+ SimpleBigDecimal. The value of the
+ constructed SimpleBigDecimal Equals bigInt /
+ 2scale.
+ @param bigInt The bigInt value parameter.
+ @param scale The scale of the constructed SimpleBigDecimal.
+ α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
+ αu's for a=0 as an array
+ of ZTauElements.
+ αu's for a=0 as an array
+ of TNAFs.
+ αu's for a=1 as an array
+ of ZTauElements.
+ αu's for a=1 as an array
+ of TNAFs.
+ λ of
+ Z[τ].
+ @param mu The parameter μ of the elliptic curve.
+ @param lambda The element λ of
+ Z[τ].
+ @return The norm of λ.
+ λ 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 λ.
+ λ 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.
+ 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.
+ τ-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 λ.
+ τ() to an
+ AbstractF2mPoint.
+ @param p The AbstractF2mPoint to which τ() is applied.
+ @return τ(p)
+ μ 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.
+ 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.
+ 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
+ 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).
+ (τ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)
+ 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
+ λ of Z[τ]
+ using the τ-adic NAF (TNAF) method.
+ @param p The AbstractF2mPoint to Multiply.
+ @param lambda The element λ of
+ Z[τ].
+ @return λ * p
+ λ 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
+ [τ]-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
+ λ.
+ ECPoint for which to do the precomputation.
+ @param a The parameter a of the elliptic curve.
+ @return The precomputation array for p.
+ 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.
+ λ.
+ τ-adic" part of λ.
+ λ of
+ Z[τ].
+ @param u The "real" part of λ.
+ @param v The "τ-adic" part of
+ λ.
+ kP.
+ 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.
+ ECCurve instance, and MUST already be normalized.
+ ECMultiplier, unless already set.
+
+ We avoid locking for performance reasons, so there is no uniqueness guarantee.
+ Fp (X9.62 s 4.2.1 pg 17).
+ @return The decoded point.
+ s0 and
+ s1 used for partial modular reduction for
+ Koblitz curves.
+ 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.
+ s0 and
+ s1 used for partial modular reduction for
+ Koblitz curves.
+ y2 + xy = x3 + ax2 + b.
+ m of F2m.
+ k where xm +
+ xk + 1 represents the reduction polynomial
+ f(z).k1 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).0k2 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).0k3 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).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.
+ 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.
+ 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.
+ 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.
+ 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.
+ m of F2m.
+ LongArray holding the bits.
+ 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.
+ 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.
+ 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).
+ F2m, either of
+ {@link F2mFieldElement.Tpb} (trinomial
+ basis representation) or
+ {@link F2mFieldElement.Ppb} (pentanomial
+ basis representation).
+ m of the reduction polynomial
+ f(z).
+ k where xm +
+ xk + 1 represents the reduction polynomial
+ f(z).k1 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).0k2 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).0k3 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).ECPoint by the given number.
+ @param k The multiplicator.
+ @return k * this.
+ ECPoints.
+ 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.
+ ECPoints used for a fixed point multiplication.
+ WNafMultiplier.
+ 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.
+ ECPoints used for a Window
+ NAF multiplication.
+ ECPoints used
+ for a Window NAF multiplication.
+ ECPoint representing Twice(this). Used for the
+ Window NAF multiplication to create or extend the precomputed values.
+ 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[].
+ τ-adic Non-Adjacent Form) algorithm.
+ 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.
+ λ 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 λ.
+ λ 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
+ τ-adic Non-Adjacent Form) algorithm.
+ AbstractF2mPoints used for the
+ WTNAF multiplication in
+ {@link org.bouncycastle.math.ec.multiplier.WTauNafMultiplier.multiply()
+ WTauNafMultiplier.multiply()}.
+ true if the candidate is found to have any small factors,
+ false otherwise.
+ 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).
+ false if the specified base is a witness to compositeness (so
+ candidate is definitely NOT prime), or else true.
+
+ BasicOcspResponse ::= SEQUENCE {
+ tbsResponseData ResponseData,
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING,
+ certs [0] EXPLICIT SEQUENCE OF Certificate OPTIONAL
+ }
+
+
+ OcspRequest ::= SEQUENCE {
+ tbsRequest TBSRequest,
+ optionalSignature [0] EXPLICIT Signature OPTIONAL }
+
+ TBSRequest ::= SEQUENCE {
+ version [0] EXPLICIT Version DEFAULT v1,
+ requestorName [1] EXPLICIT GeneralName OPTIONAL,
+ requestList SEQUENCE OF Request,
+ requestExtensions [2] EXPLICIT Extensions OPTIONAL }
+
+ Signature ::= SEQUENCE {
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING,
+ certs [0] EXPLICIT SEQUENCE OF Certificate OPTIONAL}
+
+ Version ::= INTEGER { v1(0) }
+
+ Request ::= SEQUENCE {
+ reqCert CertID,
+ singleRequestExtensions [0] EXPLICIT Extensions OPTIONAL }
+
+ CertID ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ issuerNameHash OCTET STRING, -- Hash of Issuer's DN
+ issuerKeyHash OCTET STRING, -- Hash of Issuers public key
+ serialNumber CertificateSerialNumber }
+
+ + In the case of PKCS7 objects the reader will return a CMS ContentInfo object. Keys and + Certificates will be returned using the appropriate java.security type.
+
+ CertificationRequest ::= Sequence {
+ certificationRequestInfo CertificationRequestInfo,
+ signatureAlgorithm AlgorithmIdentifier{{ SignatureAlgorithms }},
+ signature BIT STRING
+ }
+
+ 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})
+ }
+
+ see
+
+ CertificationRequest ::= Sequence {
+ certificationRequestInfo CertificationRequestInfo,
+ signatureAlgorithm AlgorithmIdentifier{{ SignatureAlgorithms }},
+ signature BIT STRING
+ }
+
+ 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})
+ }
+
+ see
+ Set of X.509 attribute certificate
+ extensions that this PkixAttrCertChecker supports or
+ null if no extensions are supported.
+
+ Each element of the set is a String representing the
+ Object Identifier (OID) of the X.509 extension that is supported.
+
+ All X.509 attribute certificate extensions that a
+ PkixAttrCertChecker might possibly be able to process
+ should be included in the set.
+
Set of X.509 extension OIDs (in
+ String format) supported by this
+ PkixAttrCertChecker, or null if no
+ extensions are supported
+ unresolvedCritExts
+ collection.
+
+ @param attrCert The attribute certificate to be checked.
+ @param certPath The certificate path which belongs to the attribute
+ certificate issuer public key certificate.
+ @param holderCertPath The certificate path which belongs to the holder
+ certificate.
+ @param unresolvedCritExts a Collection of OID strings
+ representing the current set of unresolved critical extensions
+ @throws CertPathValidatorException if the specified attribute certificate
+ does not pass the check.
+ PkixAttrCertChecker
+
+ params must be an instance of
+ ExtendedPkixParameters.
+
+ The target constraints in the params must be an
+ X509AttrCertStoreSelector with at least the attribute
+ certificate criterion set. Obey that also target informations may be
+ necessary to correctly validate this attribute certificate.
+
+ The attribute certificate issuer must be added to the trusted attribute + issuers with {@link ExtendedPkixParameters#setTrustedACIssuers(Set)}. +
+ @param certPath The certificate path which belongs to the attribute + certificate issuer public key certificate. + @param params The PKIX parameters. + @return APKIXCertPathValidatorResult of the result of
+ validating the certPath.
+ @throws InvalidAlgorithmParameterException if params is
+ inappropriate for this validator.
+ @throws CertPathValidatorException if the verification fails.
+ PkixBuilderParameters.
+
+ This method can be used to get a copy from other
+ PKIXBuilderParameters, PKIXParameters,
+ and ExtendedPKIXParameters instances.
+
PkixBuilderParameters instance.
+ ISet is null an
+ empty set is assumed.
+ ExtendedPKIXBuilderParameters and
+ PKIXBuilderParameters.
+
+ @param params Parameters to set.
+ @see org.bouncycastle.x509.ExtendedPKIXParameters#setParams(java.security.cert.PKIXParameters)
+ PKIXParameters object. Changes to the
+ copy will not affect the original and vice versa.
+
+ @return a copy of this PKIXParameters object
+ PKIXCertPathChecker.
+ *
+ * The forward flag specifies the order that certificates
+ * will be passed to the {@link #check check} method (forward or reverse). A
+ * PKIXCertPathChecker must support reverse checking
+ * and may support forward checking.
+ *
check method. If true,
+ * certificates are presented from target to most-trusted CA
+ * (forward); if false, from most-trusted CA to
+ * target (reverse).
+ * @exception CertPathValidatorException
+ * if this PKIXCertPathChecker is unable to
+ * check certificates in the specified order; it should never
+ * be thrown if the forward flag is false since reverse
+ * checking must be supported
+ PKIXCertPathChecker to perform its
+ checks when certificates are presented to the check method
+ in the forward direction (from target to most-trusted CA).
+
+ @return true if forward checking is supported,
+ false otherwise
+ Set of X.509 certificate extensions
+ * that this PKIXCertPathChecker supports (i.e. recognizes,
+ * is able to process), or null if no extensions are
+ * supported.
+ *
+ * Each element of the set is a String representing the
+ * Object Identifier (OID) of the X.509 extension that is supported. The OID
+ * is represented by a set of nonnegative integers separated by periods.
+ *
+ * All X.509 certificate extensions that a PKIXCertPathChecker
+ * might possibly be able to process should be included in the set.
+ *
Set of X.509 extension OIDs (in
+ * String format) supported by this
+ * PKIXCertPathChecker, or null if no
+ * extensions are supported
+ init method.
+
+ @param cert
+ the Certificate to be checked
+ @param unresolvedCritExts
+ a Collection of OID strings representing the
+ current set of unresolved critical extensions
+ @exception CertPathValidatorException
+ if the specified certificate does not pass the check
+ Object.clone()
+ method. All subclasses which maintain state must support and override
+ this method, if necessary.
+
+ @return a copy of this PKIXCertPathChecker
+ CertPathValidator implementations must include a class (the
+ SPI class) that extends this class (CertPathValidatorSpi)
+ and implements all of its methods. In general, instances of this class
+ should only be accessed through the CertPathValidator class.
+ For details, see the Java Cryptography Architecture.CertPathValidatorSpi instance concurrently should synchronize
+ amongst themselves and provide the necessary locking before calling the
+ wrapping CertPathValidator object.CertPathValidatorSpi may still
+ encounter concurrency issues, since multiple threads each
+ manipulating a different CertPathValidatorSpi instance need not
+ synchronize.
+ CertPathValidatorException provides support for wrapping
+ exceptions. The {@link #getCause getCause} method returns the throwable,
+ if any, that caused this exception to be thrown. CertPathValidatorException may also include the
+ certification path that was being validated when the exception was thrown
+ and the index of the certificate in the certification path that caused the
+ exception to be thrown. Use the {@link #getCertPath getCertPath} and
+ {@link #getIndex getIndex} methods to retrieve this information.PkixCertPathValidatorException with the given detail
+ message. A detail message is a String that describes this
+ particular exception.
+ PkixCertPathValidatorException with the specified
+ detail message and cause.
+ null
+ value is permitted, and indicates that the cause is
+ nonexistent or unknown.)
+ PkixCertPathValidatorException with the specified
+ detail message, cause, certification path, and index.
+ null if none)
+ the cause (or null if none)
+ the certification path that was in the process of being
+ validated when the error was encountered
+ the index of the certificate in the certification path that *
+ CertPathValidatorException.
+ null if neither the message nor cause were specifiedCertPath that was being validated when the
+ exception was thrown (or null if not specified)
+ CertPath is zero based. If no index has been set, -1 is
+ returned.
+
+ @return the index that has been set, or -1 if none has been set
+ TrustAnchor object if found or
+ null if not.
+ X500Principal.
+ This methods inherits DSA parameters from the indexed certificate or
+ previous certificates in the certificate chain to the returned
+ PublicKey. The list is searched upwards, meaning the end
+ certificate is at position 0 and previous certificates are following.
+
+ If the indexed certificate does not contain a DSA key this method simply + returns the public key. If the DSA key already contains DSA parameters + the key is also only returned. +
+ + @param certs The certification path. + @param index The index of the certificate which contains the public key + which should be extended with DSA parameters. + @return The public key of the certificate in list position +index extended with DSA parameters if applicable.
+ @throws Exception if DSA parameters cannot be inherited.
+ null.selector.
+
+ The issuerPrincipals are a collection with a single
+ X500Principal for X509Certificates. For
+ {@link X509AttributeCertificate}s the issuer may contain more than one
+ X500Principal.
+
issuerPrincipals does not
+ contain only X500Principals.
+ X509Certificate or
+ {@link org.bouncycastle.x509.X509AttributeCertificate} for
+ which the CRL should be searched.
+ @param currentDate The date for which the delta CRLs must be valid.
+ @param paramsPKIX The extended PKIX parameters.
+ @return A Set of X509CRLs with complete
+ CRLs.
+ @throws Exception if an exception occurs while picking the CRLs
+ or no CRLs are found.
+ Set of X509CRLs with delta CRLs.
+ @throws Exception if an exception occurs while picking the delta
+ CRLs.
+ Collection object containing the issuer
+ X509Certificates. Never null.
+
+ @exception Exception
+ if an error occurs.
+ null.
+ permitted with ip.
+
+ @param permitted A Set of permitted IP addresses with
+ their subnet mask as byte arrays.
+ @param ips The IP address with its subnet mask.
+ @return The Set of permitted IP ranges intersected with
+ ip.
+ excluded
+ with ip.
+
+ @param excluded A Set of excluded IP addresses with their
+ subnet mask as byte arrays.
+ @param ip The IP address with its subnet mask.
+ @return The Set of excluded IP ranges unified with
+ ip as byte arrays.
+ Set with the union of both addresses.
+ Set with the single IP address with its subnet
+ mask as a byte array or an empty Set.
+ ip is constrained by
+ constraint.
+
+ @param constraint The constraint. This is an IP address concatenated with
+ its subnetmask.
+ @param ip The IP address.
+ @return true if constrained, false
+ otherwise.
+ ip is included in the permitted ISet
+ permitted.
+
+ @param permitted A Set of permitted IP addresses with
+ their subnet mask as byte arrays.
+ @param ip The IP address.
+ @throws PkixNameConstraintValidatorException
+ if the IP is not permitted.
+ ip is included in the excluded ISet
+ excluded.
+
+ @param excluded A Set of excluded IP addresses with their
+ subnet mask as byte arrays.
+ @param ip The IP address.
+ @throws PkixNameConstraintValidatorException
+ if the IP is excluded.
+ email1 and email2 is
+ added to the union union. If email1 and
+ email2 have nothing in common they are added both.
+
+ @param email1 Email address constraint 1.
+ @param email2 Email address constraint 2.
+ @param union The union.
+ email1 and
+ email2 is added to the intersection intersect.
+
+ @param email1 Email address constraint 1.
+ @param email2 Email address constraint 2.
+ @param intersect The intersection.
+ name
+ name is
+ excluded.
+ ip1 with ip2. If ip1
+ is equal to ip2 0 is returned. If ip1 is bigger 1 is returned, -1
+ otherwise.
+
+ @param ip1 The first IP address.
+ @param ip2 The second IP address.
+ @return 0 if ip1 is equal to ip2, 1 if ip1 is bigger, -1 otherwise.
+ ip1 and
+ ip2.
+
+ @param ip1 The first IP address.
+ @param ip2 The second IP address.
+ @return The OR of ip1 and ip2.
+ (trustAnchors.isEmpty() == true)
+ @exception NullPointerException
+ if the specified Set is null
+ @exception ClassCastException
+ if any of the elements in the Set are not of type
+ java.security.cert.TrustAnchor
+ null, no constraints are defined.null)
+
+ @see #setTargetCertConstraints(CertSelector)
+ null)
+
+ @see #getTargetCertConstraints()
+ Set, which is
+ interpreted as meaning that any policy would be acceptable.
+
+ @return an immutable Set of initial policy OIDs in String
+ format, or an empty Set (implying any policy is
+ acceptable). Never returns null.
+
+ @see #setInitialPolicies(java.util.Set)
+ Set of initial policy identifiers (OID strings),
+ indicating that any one of these policies would be acceptable to the
+ certificate user for the purposes of certification path processing. By
+ default, any policy is acceptable (i.e. all policies), so a user that
+ wants to allow any policy as acceptable does not need to call this
+ method, or can call it with an empty Set (or
+ null).null)
+
+ @exception ClassCastException
+ if any of the elements in the set are not of type String
+
+ @see #getInitialPolicies()
+ List of additional certification path checkers. If
+ the specified List contains an object that is not a PKIXCertPathChecker,
+ it is ignored.PKIXCertPathChecker specified implements additional
+ checks on a certificate. Typically, these are checks to process and
+ verify private extensions contained in certificates. Each
+ PKIXCertPathChecker should be instantiated with any
+ initialization parameters needed to execute the check.CertPathValidator or CertPathBuilder. Each
+ of the specified PKIXCertPathCheckers will be called, in turn, by a PKIX
+ CertPathValidator or CertPathBuilder for
+ each certificate processed or validated.CertPathValidator or CertPathBuilder
+ must perform all of the required PKIX checks on each certificate. The one
+ exception to this rule is if the RevocationEnabled flag is set to false
+ (see the {@link #setRevocationEnabled(boolean) setRevocationEnabled}
+ method).java.security.cert.PKIXCertPathChecker
+ @see #getCertPathCheckers()
+ null)
+
+ @see #setCertPathCheckers(java.util.List)
+ PKIXCertPathChecker to the list of certification
+ path checkers. See the {@link #setCertPathCheckers setCertPathCheckers}
+ method for more details.
+
+ Note that the PKIXCertPathChecker is cloned to protect
+ against subsequent modifications.
PKIXCertPathChecker to add to the list of
+ checks. If null, the checker is ignored (not added to list).
+ Clone() under J2ME.
+ super.Clone() does not exist and fields are not copied.
+
+ @param params Parameters to set. If this are
+ ExtendedPkixParameters they are copied to.
+ false.
+
+ The IList is cloned.
+
stores is not
+ a {@link Store}.
+ + This method should be used to add local stores, like collection based + X.509 stores, if available. Local stores should be considered first, + before trying to use additional (remote) locations, because they do not + need possible additional network traffic. +
+ If store is null it is ignored.
+
+ You should not use this method. This method is used for adding additional + X.509 stores, which are used to add (remote) locations, e.g. LDAP, found + during X.509 object processing, e.g. in certificates or CRLs. This method + is used in PKIX certification path processing. +
+ If store is null it is ignored.
+
IList of additional Bouncy Castle
+ Stores used for finding CRLs, certificates, attribute
+ certificates or cross certificates.
+
+ @return an immutable IList of additional Bouncy Castle
+ Stores. Never null.
+
+ @see #addAddionalStore(Store)
+ IList of Bouncy Castle
+ Stores used for finding CRLs, certificates, attribute
+ certificates or cross certificates.
+
+ @return an immutable IList of Bouncy Castle
+ Stores. Never null.
+
+ @see #setStores(IList)
+ true if additional stores are used.
+ true if additional stores are used.
+ IX509Selector. If null, no constraints are
+ defined.
+
+ + The target certificate in a PKIX path may be a certificate or an + attribute certificate. +
+ Note that the IX509Selector returned is cloned to protect
+ against subsequent modifications.
+
IX509Selector specifying the constraints on the
+ target certificate or attribute certificate (or null)
+ @see #setTargetConstraints
+ @see X509CertStoreSelector
+ @see X509AttributeCertStoreSelector
+ IX509Selector. If null, no constraints are
+ defined.
+ + The target certificate in a PKIX path may be a certificate or an + attribute certificate. +
+ Note that the IX509Selector specified is cloned to protect
+ against subsequent modifications.
+
IX509Selector specifying the constraints on
+ the target certificate or attribute certificate (or
+ null)
+ @see #getTargetConstraints
+ @see X509CertStoreSelector
+ @see X509AttributeCertStoreSelector
+
+ The returned ISet consists of TrustAnchors.
+
+ The returned ISet is immutable. Never null
+
+ The trustedACIssuers must be a ISet of
+ TrustAnchor
+
+ The given set is cloned. +
+ + @param trustedACIssuers The trusted AC issuers to set. Is never +null.
+ @throws ClassCastException if an element of stores is not
+ a TrustAnchor.
+
+ The returned ISet is immutable and contains
+ Strings with the OIDs.
+
+ The ISet must contain Strings with the
+ OIDs.
+
+ The set is cloned. +
+ + @param necessaryACAttributes The necessary AC attributes to set. + @throws ClassCastException if an element of +necessaryACAttributes is not a
+ String.
+
+ The returned ISet is immutable and contains
+ Strings with the OIDs.
+
null.
+
+ The ISet must contain Strings with the
+ OIDs.
+
+ The set is cloned. +
+ + @param prohibitedACAttributes The prohibited AC attributes to set. + @throws ClassCastException if an element of +prohibitedACAttributes is not a
+ String.
+ null.
+
+ All elements in the ISet must a {@link PKIXAttrCertChecker}.
+
+ The given set is cloned. +
+ + @param attrCertCheckers The attribute certificate checkers to set. Is + nevernull.
+ @throws ClassCastException if an element of attrCertCheckers
+ is not a PKIXAttrCertChecker.
+ true if this reasons mask contains all possible
+ reasons.
+ + (i) If the distribution point name is present in the IDP CRL extension + and the distribution field is present in the DP, then verify that one of + the names in the IDP matches one of the names in the DP. If the + distribution point name is present in the IDP CRL extension and the + distribution field is omitted from the DP, then verify that one of the + names in the IDP matches one of the names in the cRLIssuer field of the + DP. +
++ (ii) If the onlyContainsUserCerts boolean is asserted in the IDP CRL + extension, verify that the certificate does not include the basic + constraints extension with the cA boolean asserted. +
++ (iii) If the onlyContainsCACerts boolean is asserted in the IDP CRL + extension, verify that the certificate includes the basic constraints + extension with the cA boolean asserted. +
++ (iv) Verify that the onlyContainsAttributeCerts boolean is not asserted. +
+ + @param dp The distribution point. + @param cert The certificate. + @param crl The CRL. + @throws AnnotatedException if one of the conditions is not met or an error occurs. +cert.
+ @throws AnnotatedException if one of the above conditions does not apply or an error
+ occurs.
+ cert.
+ @param cert The attribute certificate or certificate to check if it is
+ revoked.
+ @param defaultCRLSignCert The issuer certificate of the certificate cert.
+ @param defaultCRLSignKey The public key of the issuer certificate
+ defaultCRLSignCert.
+ @param paramsPKIX paramsPKIX PKIX parameters.
+ @param certPathCerts The certificates on the certification path.
+ @return A Set with all keys of possible CRL issuer
+ certificates.
+ @throws AnnotatedException if the CRL is not valid or the status cannot be checked or
+ some error occurs.
+ cert.
+
+ @param dp The distribution point to consider.
+ @param paramsPKIX PKIX parameters.
+ @param cert Certificate to check if it is revoked.
+ @param validDate The date when the certificate revocation status should be
+ checked.
+ @param defaultCRLSignCert The issuer certificate of the certificate cert.
+ @param defaultCRLSignKey The public key of the issuer certificate
+ defaultCRLSignCert.
+ @param certStatus The current certificate revocation status.
+ @param reasonMask The reasons mask which is already checked.
+ @param certPathCerts The certificates of the certification path.
+ @throws AnnotatedException if the certificate is revoked or the status cannot be checked
+ or some error occurs.
+ cert.
+ @param workingPublicKey The public key of the issuer certificate sign.
+ @param certPathCerts The certificates of the certification path.
+ @throws AnnotatedException if the certificate is revoked or the status cannot be checked
+ or some error occurs.
+ attrCert.
+ @param validDate The date when the certificate revocation status should
+ be checked.
+ @param certPathCerts The certificates of the certification path to be
+ checked.
+
+ @throws CertPathValidatorException if the certificate is revoked or the
+ status cannot be checked or some error occurs.
+ attrCert.
+
+ @param dp The distribution point to consider.
+ @param attrCert The attribute certificate which should be checked.
+ @param paramsPKIX PKIX parameters.
+ @param validDate The date when the certificate revocation status should
+ be checked.
+ @param issuerCert Certificate to check if it is revoked.
+ @param reasonMask The reasons mask which is already checked.
+ @param certPathCerts The certificates of the certification path to be
+ checked.
+ @throws Exception if the certificate is revoked or the status
+ cannot be checked or some error occurs.
+
+ NameConstraints ::= SEQUENCE {
+ permittedSubtrees [0] GeneralSubtrees OPTIONAL,
+ excludedSubtrees [1] GeneralSubtrees OPTIONAL }
+
+ GeneralSubtrees ::= SEQUENCE SIZE (1..MAX) OF GeneralSubtree
+
+ GeneralSubtree ::= SEQUENCE {
+ base GeneralName,
+ minimum [0] BaseDistance DEFAULT 0,
+ maximum [1] BaseDistance OPTIONAL }
+
+ BaseDistance ::= INTEGER (0..MAX)
+
+ 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}
+
+
+ Note that the name constraints byte array supplied is cloned to protect
+ against subsequent modifications.
+ + Name constraints are an optional parameter, and are intended to be used + as additional constraints when validating an X.509 certification path. +
+ The name constraints are specified as a byte array. This byte array + contains the DER encoded form of the name constraints, as they + would appear in the NameConstraints structure defined in RFC 2459 + and X.509. The ASN.1 notation for this structure is supplied in the + documentation for the other constructors. +
+ Note that the name constraints byte array supplied here is cloned to + protect against subsequent modifications. +
+TrustAnchor where the most-trusted
+ CA is specified as a distinguished name and public key. Name constraints
+ are an optional parameter, and are intended to be used as additional
+ constraints when validating an X.509 certification path.
+ TrustAnchor.
+ TrustAnchor+ If genTime is null a timeNotAvailable error response will be returned. + + @param request the request this response is for. + @param serialNumber serial number for the response token. + @param genTime generation time for the response token. + @param provider provider to use for signature calculation. + @return + @throws NoSuchAlgorithmException + @throws NoSuchProviderException + @throws TSPException +
++ To be valid the token must be signed by the passed in certificate and + the certificate must be the one referred to by the SigningCertificate + attribute included in the hashed attributes of the token. The + certificate must also have the ExtendedKeyUsageExtension with only + KeyPurposeID.IdKPTimeStamping and have been valid at the time the + timestamp was created. +
++ A successful call to validate means all the above are true. +
++ If a failure code is associated with the exception it can be retrieved using + the getFailureCode() method.
+buf at which the data is written.
+ @param len
+ the fixed length of data written (possibly padded with leading zeros).
+ + 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. +
++ 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. +
++ The exception extends InvalidCastException to enable users to have a single handling case, + only introducing specific handling of this one if required. +
+
+ 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
+ }
+
+
+ digestedObjectType can be one of the following:
+
otherObjectTypeID must not be empty.This cannot be used if a v1 attribute certificate is used.
+ + @param digestedObjectType The digest object type. + @param digestAlgorithm The algorithm identifier for the hash. + @param otherObjectTypeID The object type ID if +digestedObjectType is
+ otherObjectDigest.
+ @param objectDigest The hash value.
+ +
otherObjectTypeID must not be empty.null if no object
+ digest info is set.
+ null if no object digest info is set.
+ null if no object
+ digest info is set.
+ + Use this in preference to trying to recreate a principal from a string, not all + DNs are what they should be, so it's best to leave them encoded where they + can be.
+Selector like implementation to select
+ attribute certificates from a given set of criteria.
+
+ @see org.bouncycastle.x509.X509AttributeCertificate
+ @see org.bouncycastle.x509.X509Store
+ true if the object matches this selector.X509AttributeCertificate
+ must contain at least one of the specified target names.
+ + Each attribute certificate may contain a target information extension + limiting the servers where this attribute certificate can be used. If + this extension is not present, the attribute certificate is not targeted + and may be accepted by any server. +
+ + @param name The name as a GeneralName (notnull)
+ X509AttributeCertificate
+ must contain at least one of the specified target names.
+ + Each attribute certificate may contain a target information extension + limiting the servers where this attribute certificate can be used. If + this extension is not present, the attribute certificate is not targeted + and may be accepted by any server. +
+ + @param name a byte array containing the name in ASN.1 DER encoded form of a GeneralName + @throws IOException if a parsing error occurs. +null is
+ given any will do.
+ + The collection consists of either GeneralName objects or byte[] arrays representing + DER encoded GeneralName structures. +
+ + @param names A collection of target names. + @throws IOException if a parsing error occurs. + @see #AddTargetName(byte[]) + @see #AddTargetName(GeneralName) +Lists
+ made up of an Integer in the first entry and a DER encoded
+ byte array or a String in the second entry.
+ The returned collection is immutable.
+ + @return The collection of target names + @see #setTargetNames(Collection) +X509AttributeCertificate
+ must contain at least one of the specified target groups.
+ + Each attribute certificate may contain a target information extension + limiting the servers where this attribute certificate can be used. If + this extension is not present, the attribute certificate is not targeted + and may be accepted by any server. +
+ + @param group The group as GeneralName form (notnull)
+ X509AttributeCertificate
+ must contain at least one of the specified target groups.
+ + Each attribute certificate may contain a target information extension + limiting the servers where this attribute certificate can be used. If + this extension is not present, the attribute certificate is not targeted + and may be accepted by any server. +
+ + @param name a byte array containing the group in ASN.1 DER encoded form of a GeneralName + @throws IOException if a parsing error occurs. +null is
+ given any will do.
+
+ The collection consists of GeneralName objects or byte[]
+ representing DER encoded GeneralNames.
+
Lists
+ made up of an Integer in the first entry and a DER encoded
+ byte array or a String in the second entry.
+ The returned collection is immutable.
+ + @return The collection of target groups. + @see #setTargetGroups(Collection) +IX509Selector implementation to select
+ certificate pairs, which are e.g. used for cross certificates. The set of
+ criteria is given from two X509CertStoreSelector objects,
+ each of which, if present, must match the respective component of a pair.
+ X509CertificatePair, this method
+ returns false.
+ X509CertificatePair to be tested.
+ true if the object matches this selector.ISet of DerObjectIdentifier objects.
+ X509Stores.+ The collection is copied. +
+ICollection.ICollection of X509Name objects
+ null is specified, then no such
+ optional information is provided.
+
+ @param attrCert the IX509AttributeCertificate being checked (or
+ null)
+ @see #getAttrCertificateChecking()
+ true only complete CRLs are returned. Defaults to
+ false.
+
+ @return true if only complete CRLs are returned.
+ false.
+
+ @return Returns true if only CRLs with the delta CRL
+ indicator extension are selected.
+ + The issuing distribution point extension is a CRL extension which + identifies the scope and the distribution point of a CRL. The scope + contains among others information about revocation reasons contained in + the CRL. Delta CRLs and complete CRLs must have matching issuing + distribution points.
++ The byte array is cloned to protect against subsequent modifications.
++ You must also enable or disable this criteria with + {@link #setIssuingDistributionPointEnabled(bool)}.
+ + @param issuingDistributionPoint The issuing distribution point to set. + This is the DER encoded OCTET STRING extension value. + @see #getIssuingDistributionPoint() +false.
+ + You may also set the issuing distribution point criteria if not a missing + issuing distribution point should be assumed.
+ + @return Returns if the issuing distribution point check is enabled. +null.
+
+ @return Returns the maximum base CRL number.
+ @see #setMaxBaseCRLNumber(BigInteger)
+ + At the moment this will deal with "-----BEGIN CERTIFICATE-----" to "-----END CERTIFICATE-----" + base 64 encoded certs, as well as the BER binaries of certificates and some classes of PKCS#7 + objects.
+isIndirect
+ is false {@link #getCertificateIssuer()} will always
+ return null, previousCertificateIssuer is
+ ignored. If this isIndirect is specified and this CrlEntry
+ has no certificate issuer CRL entry extension
+ previousCertificateIssuer is returned by
+ {@link #getCertificateIssuer()}.
+
+ @param c
+ TbsCertificateList.CrlEntry object.
+ @param isIndirect
+ true if the corresponding CRL is a indirect
+ CRL.
+ @param previousCertificateIssuer
+ Certificate issuer of the previous CrlEntry.
+
+ 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) }
+
+ + 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.
++ 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.
+1.3.6.1.4.1.22554
+1.3.6.1.4.1.22554.1
+1.3.6.1.4.1.22554.1.1
+
+ LinkedCertificate := SEQUENCE {
+ digest DigestInfo, -- digest of PQC certificate
+ certLocation GeneralName, -- location of PQC certificate
+ certIssuer [0] Name OPTIONAL, -- issuer of PQC cert (if different from current certificate)
+ cACerts [1] GeneralNames OPTIONAL, -- CA certificates for PQC cert (one of more locations)
+ }
+
+
+ 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.
+
+ 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. +
+ 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.
+
+ 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)
+
+ + PkiFreeText ::= SEQUENCE SIZE (1..MAX) OF UTF8String ++
+ 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.
+
+ 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. +
+ 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. +
+ Attribute ::= SEQUENCE {
+ attrType OBJECT IDENTIFIER,
+ attrValues SET OF AttributeValue
+ }
+
+ + Attributes ::= + SET SIZE(1..MAX) OF Attribute -- according to RFC 5652 ++ @return +
+ 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
+
+
+ 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
+
+
+ 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 }
+
+
+ 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 }
+
+
+ CompressedData ::= Sequence {
+ version CMSVersion,
+ compressionAlgorithm CompressionAlgorithmIdentifier,
+ encapContentInfo EncapsulatedContentInfo
+ }
+
+
+ CompressedData ::= SEQUENCE {
+ version CMSVersion,
+ compressionAlgorithm CompressionAlgorithmIdentifier,
+ encapContentInfo EncapsulatedContentInfo
+ }
+
+
+ ContentInfo ::= Sequence {
+ contentType ContentType,
+ content
+ [0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
+
+
+ ContentInfo ::= SEQUENCE {
+ contentType ContentType,
+ content
+ [0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
+
+
+ MQVuserKeyingMaterial ::= SEQUENCE {
+ ephemeralPublicKey OriginatorPublicKey,
+ addedukm [0] EXPLICIT UserKeyingMaterial OPTIONAL }
+
+
+ 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.
+
+ EnvelopedData ::= Sequence {
+ version CMSVersion,
+ originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
+ recipientInfos RecipientInfos,
+ encryptedContentInfo EncryptedContentInfo,
+ unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL
+ }
+
+
+ EnvelopedData ::= SEQUENCE {
+ version CMSVersion,
+ originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
+ recipientInfos RecipientInfos,
+ encryptedContentInfo EncryptedContentInfo,
+ unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL
+ }
+
+
+ KekIdentifier ::= Sequence {
+ keyIdentifier OCTET STRING,
+ date GeneralizedTime OPTIONAL,
+ other OtherKeyAttribute OPTIONAL
+ }
+
+
+ KekRecipientInfo ::= Sequence {
+ version CMSVersion, -- always set to 4
+ kekID KekIdentifier,
+ keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
+ encryptedKey EncryptedKey
+ }
+
+
+ KeyAgreeRecipientIdentifier ::= CHOICE {
+ issuerAndSerialNumber IssuerAndSerialNumber,
+ rKeyId [0] IMPLICIT RecipientKeyIdentifier
+ }
+
+
+ * KeyAgreeRecipientInfo ::= Sequence {
+ * version CMSVersion, -- always set to 3
+ * originator [0] EXPLICIT OriginatorIdentifierOrKey,
+ * ukm [1] EXPLICIT UserKeyingMaterial OPTIONAL,
+ * keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
+ * recipientEncryptedKeys RecipientEncryptedKeys
+ * }
+ *
+ * UserKeyingMaterial ::= OCTET STRING
+ *
+
+ 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
+
+ OriginatorIdentifierOrKey ::= CHOICE {
+ issuerAndSerialNumber IssuerAndSerialNumber,
+ subjectKeyIdentifier [0] SubjectKeyIdentifier,
+ originatorKey [1] OriginatorPublicKey
+ }
+
+ SubjectKeyIdentifier ::= OCTET STRING
+
+
+ OriginatorInfo ::= Sequence {
+ certs [0] IMPLICIT CertificateSet OPTIONAL,
+ crls [1] IMPLICIT CertificateRevocationLists OPTIONAL
+ }
+
+
+ OriginatorPublicKey ::= Sequence {
+ algorithm AlgorithmIdentifier,
+ publicKey BIT STRING
+ }
+
+
+ OtherKeyAttribute ::= Sequence {
+ keyAttrId OBJECT IDENTIFIER,
+ keyAttr ANY DEFINED BY keyAttrId OPTIONAL
+ }
+
+
+ OtherRecipientInfo ::= Sequence {
+ oriType OBJECT IDENTIFIER,
+ oriValue ANY DEFINED BY oriType }
+
+
+ OtherRevocationInfoFormat ::= SEQUENCE {
+ otherRevInfoFormat OBJECT IDENTIFIER,
+ otherRevInfo ANY DEFINED BY otherRevInfoFormat }
+
+
+ PasswordRecipientInfo ::= Sequence {
+ version CMSVersion, -- Always set to 0
+ keyDerivationAlgorithm [0] KeyDerivationAlgorithmIdentifier
+ OPTIONAL,
+ keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
+ encryptedKey EncryptedKey }
+
+
+ RecipientEncryptedKey ::= SEQUENCE {
+ rid KeyAgreeRecipientIdentifier,
+ encryptedKey EncryptedKey
+ }
+
+
+ RecipientIdentifier ::= CHOICE {
+ issuerAndSerialNumber IssuerAndSerialNumber,
+ subjectKeyIdentifier [0] SubjectKeyIdentifier
+ }
+
+ SubjectKeyIdentifier ::= OCTET STRING
+
+
+ RecipientInfo ::= CHOICE {
+ ktri KeyTransRecipientInfo,
+ kari [1] KeyAgreeRecipientInfo,
+ kekri [2] KekRecipientInfo,
+ pwri [3] PasswordRecipientInfo,
+ ori [4] OtherRecipientInfo }
+
+
+ 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.
+
+ 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
+ }
+
+
+ SignerIdentifier ::= CHOICE {
+ issuerAndSerialNumber IssuerAndSerialNumber,
+ subjectKeyIdentifier [0] SubjectKeyIdentifier
+ }
+
+ SubjectKeyIdentifier ::= OCTET STRING
+
+
+ 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
+
+
+ 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. +
+ 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.
+
+ 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.
+
+ 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 }
+
+
+ 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.
+
+ 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.
+
+ 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.
+
+ Gost28147-89-Parameters ::=
+ SEQUENCE {
+ iv Gost28147-89-IV,
+ encryptionParamSet OBJECT IDENTIFIER
+ }
+
+ Gost28147-89-IV ::= OCTET STRING (SIZE (8))
+
+ 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.
+ 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
+ 0 single-ASN1-type1 OCTET STRING2 BIT STRING+ 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.
+ + @param time the time string.
++ 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.
+
+ CertificateValues ::= SEQUENCE OF Certificate
+
+
+ CommitmentTypeIndication ::= SEQUENCE {
+ commitmentTypeId CommitmentTypeIdentifier,
+ commitmentTypeQualifier SEQUENCE SIZE (1..MAX) OF
+ CommitmentTypeQualifier OPTIONAL }
+
+
+ CommitmentTypeQualifier ::= SEQUENCE {
+ commitmentTypeIdentifier CommitmentTypeIdentifier,
+ qualifier ANY DEFINED BY commitmentTypeIdentifier OPTIONAL }
+
+ CommitmentTypeQualifier instance.
+
+ @param commitmentTypeIdentifier a CommitmentTypeIdentifier value
+ CommitmentTypeQualifier instance.
+
+ @param commitmentTypeIdentifier a CommitmentTypeIdentifier value
+ @param qualifier the qualifier, defined by the above field.
+ CommitmentTypeQualifier instance.
+
+ @param as CommitmentTypeQualifier structure
+ encoded as an Asn1Sequence.
+ Asn1Object value
+
+ CompleteCertificateRefs ::= SEQUENCE OF OtherCertID
+
+
+ CompleteRevocationRefs ::= SEQUENCE OF CrlOcspRef
+
+
+ CrlIdentifier ::= SEQUENCE
+ {
+ crlissuer Name,
+ crlIssuedTime UTCTime,
+ crlNumber INTEGER OPTIONAL
+ }
+
+
+ CRLListID ::= SEQUENCE
+ {
+ crls SEQUENCE OF CrlValidatedID
+ }
+
+
+ CrlOcspRef ::= SEQUENCE {
+ crlids [0] CRLListID OPTIONAL,
+ ocspids [1] OcspListID OPTIONAL,
+ otherRev [2] OtherRevRefs OPTIONAL
+ }
+
+
+ CrlValidatedID ::= SEQUENCE {
+ crlHash OtherHash,
+ crlIdentifier CrlIdentifier OPTIONAL}
+
+
+ OcspIdentifier ::= SEQUENCE {
+ ocspResponderID ResponderID,
+ -- As in OCSP response data
+ producedAt GeneralizedTime
+ -- As in OCSP response data
+ }
+
+
+ OcspListID ::= SEQUENCE {
+ ocspResponses SEQUENCE OF OcspResponsesID
+ }
+
+
+ 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
+
+
+ OtherHashAlgAndValue ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ hashValue OtherHashValue
+ }
+
+ OtherHashValue ::= OCTET STRING
+
+
+ OtherRevRefs ::= SEQUENCE
+ {
+ otherRevRefType OtherRevRefType,
+ otherRevRefs ANY DEFINED BY otherRevRefType
+ }
+
+ OtherRevRefType ::= OBJECT IDENTIFIER
+
+
+ OtherRevVals ::= SEQUENCE
+ {
+ otherRevValType OtherRevValType,
+ otherRevVals ANY DEFINED BY otherRevValType
+ }
+
+ OtherRevValType ::= OBJECT IDENTIFIER
+
+
+ OtherSigningCertificate ::= SEQUENCE {
+ certs SEQUENCE OF OtherCertID,
+ policies SEQUENCE OF PolicyInformation OPTIONAL
+ }
+
+
+ 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.
+
+
+ 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
+
+
+ ContentHints ::= SEQUENCE {
+ contentDescription UTF8String (SIZE (1..MAX)) OPTIONAL,
+ contentType ContentType }
+
+ + 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 } +
+ 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
+ }
+
+
+ OtherCertID ::= SEQUENCE {
+ otherCertHash OtherHash,
+ issuerSerial IssuerSerial OPTIONAL }
+
+ OtherHash ::= CHOICE {
+ sha1Hash OCTET STRING,
+ otherHash OtherHashAlgAndValue }
+
+ OtherHashAlgAndValue ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ hashValue OCTET STRING }
+
+
+
+ OtherSigningCertificate ::= SEQUENCE {
+ certs SEQUENCE OF OtherCertID,
+ policies SEQUENCE OF PolicyInformation OPTIONAL
+ }
+
+ id-aa-ets-otherSigCert OBJECT IDENTIFIER ::= { iso(1)
+ member-body(2) us(840) rsadsi(113549) pkcs(1) pkcs9(9)
+ smime(16) id-aa(2) 19 }
+
+ 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 }
+
+ 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 }
+ + If you use this interface your class should also implement the getInstance + pattern which takes a tag object and the tagging mode used. +
+
+ CscaMasterList ::= SEQUENCE {
+ version CscaMasterListVersion,
+ certList SET OF Certificate }
+
+ CscaMasterListVersion :: INTEGER {v0(0)}
+
+
+ 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) }
+
+
+
+ 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
+ + DateOfCertGenSyntax ::= GeneralizedTime ++
+ ICCSNSyntax ::= OCTET STRING (SIZE(8..20)) ++
+ PKReferenceSyntax ::= OCTET STRING (SIZE(20)) ++
+ RestrictionSyntax ::= DirectoryString (SIZE(1..1024)) ++ + @see Org.BouncyCastle.Asn1.IsisMtt.X509.Restriction +
+ RetrieveIfAllowed ::= BOOLEAN ++
+ CertInDirSince ::= GeneralizedTime ++
+ NameAtBirth ::= DirectoryString(SIZE(1..64) ++ + Used in + {@link Org.BouncyCastle.Asn1.X509.SubjectDirectoryAttributes SubjectDirectoryAttributes} +
+ AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048)) ++ + @see Org.BouncyCastle.Asn1.IsisMtt.X509.AdditionalInformationSyntax +
+ LiabilityLimitationFlagSyntax ::= BOOLEAN ++
+ CertHash ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ certificateHash OCTET STRING
+ }
+
+
+ CertHash ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ certificateHash OCTET STRING
+ }
+
+
+ @param seq The ASN.1 sequence.
+
+ CertHash ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ certificateHash OCTET STRING
+ }
+
+
+ @return an Asn1Object
+
+ RequestedCertificate ::= CHOICE {
+ Certificate Certificate,
+ publicKeyCertificate [0] EXPLICIT OCTET STRING,
+ attributeCertificate [1] EXPLICIT OCTET STRING
+ }
+
+ null.
+
+ @param certificate Given as Certificate
+
+ RequestedCertificate ::= CHOICE {
+ Certificate Certificate,
+ publicKeyCertificate [0] EXPLICIT OCTET STRING,
+ attributeCertificate [1] EXPLICIT OCTET STRING
+ }
+
+
+ @return an Asn1Object
+ + AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048)) ++
+ AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048)) ++ + @return an Asn1Object +
+ 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
+
+ Admissions ::= SEQUENCE
+ {
+ admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
+ namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
+ professionInfos SEQUENCE OF ProfessionInfo
+ }
+
+
+ @param seq The ASN.1 sequence.
+ professionInfos is mandatory.
+
+ @param admissionAuthority The admission authority.
+ @param namingAuthority The naming authority.
+ @param professionInfos The profession infos.
+
+ Admissions ::= SEQUENCE
+ {
+ admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
+ namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
+ professionInfos SEQUENCE OF ProfessionInfo
+ }
+
+
+
+ @return an Asn1Object
+
+ 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:
+
+ 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.
+
+ 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
+
+ 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.
+
+ 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
+
+ MonetaryLimitSyntax ::= SEQUENCE
+ {
+ currency PrintableString (SIZE(3)),
+ amount INTEGER,
+ exponent INTEGER
+ }
+
+
+ currency must be the ISO code.
+
+ value = amount�10*exponent
+
+ MonetaryLimitSyntax ::= SEQUENCE
+ {
+ currency PrintableString (SIZE(3)),
+ amount INTEGER,
+ exponent INTEGER
+ }
+
+
+ @return an Asn1Object
+
+ NamingAuthority ::= SEQUENCE
+ {
+ namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
+ namingAuthorityUrl IA5String OPTIONAL,
+ namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
+ }
+
+ @see Org.BouncyCastle.Asn1.IsisMtt.X509.AdmissionSyntax
+
+
+ NamingAuthority ::= SEQUENCE
+ {
+ namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
+ namingAuthorityUrl IA5String OPTIONAL,
+ namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
+ }
+
+
+ @param seq The ASN.1 sequence.
+
+ NamingAuthority ::= SEQUENCE
+ {
+ namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
+ namingAuthorityUrl IA5String OPTIONAL,
+ namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
+ }
+
+
+ @return an Asn1Object
+ + 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
+ }
+
+
+
+ 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.
+ 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.
+ 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.
+
+ 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
+
+ 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
+
+ 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.
+ 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.
+
+ 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
+ + RestrictionSyntax ::= DirectoryString (SIZE(1..1024)) ++
+ RestrictionSyntax ::= DirectoryString (SIZE(1..1024)) ++ + @param restriction A IAsn1String. +
+ RestrictionSyntax ::= DirectoryString (SIZE(1..1024)) + ++ + @return an Asn1Object +
+ cast5CBCParameters ::= Sequence {
+ iv OCTET STRING DEFAULT 0,
+ -- Initialization vector
+ keyLength Integer
+ -- Key length, in bits
+ }
+
+
+ IDEA-CBCPar ::= Sequence {
+ iv OCTET STRING OPTIONAL -- exactly 8 octets
+ }
+
+
+ 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) }
+
+
+ PublicKeyAndChallenge ::= SEQUENCE {
+ spki SubjectPublicKeyInfo,
+ challenge IA5STRING
+ }
+
+
+
+ BasicOcspResponse ::= Sequence {
+ tbsResponseData ResponseData,
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING,
+ certs [0] EXPLICIT Sequence OF Certificate OPTIONAL }
+
+
+ CertID ::= Sequence {
+ hashAlgorithm AlgorithmIdentifier,
+ issuerNameHash OCTET STRING, -- Hash of Issuer's DN
+ issuerKeyHash OCTET STRING, -- Hash of Issuers public key
+ serialNumber CertificateSerialNumber }
+
+
+ CertStatus ::= CHOICE {
+ good [0] IMPLICIT Null,
+ revoked [1] IMPLICIT RevokedInfo,
+ unknown [2] IMPLICIT UnknownInfo }
+
+
+ CrlID ::= Sequence {
+ crlUrl [0] EXPLICIT IA5String OPTIONAL,
+ crlNum [1] EXPLICIT Integer OPTIONAL,
+ crlTime [2] EXPLICIT GeneralizedTime OPTIONAL }
+
+
+ OcspRequest ::= Sequence {
+ tbsRequest TBSRequest,
+ optionalSignature [0] EXPLICIT Signature OPTIONAL }
+
+
+ OcspResponse ::= Sequence {
+ responseStatus OcspResponseStatus,
+ responseBytes [0] EXPLICIT ResponseBytes OPTIONAL }
+
+
+ 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
+ }
+
+
+ Request ::= Sequence {
+ reqCert CertID,
+ singleRequestExtensions [0] EXPLICIT Extensions OPTIONAL }
+
+
+ ResponderID ::= CHOICE {
+ byName [1] Name,
+ byKey [2] KeyHash }
+
+
+ ResponseBytes ::= Sequence {
+ responseType OBJECT IDENTIFIER,
+ response OCTET STRING }
+
+
+ ResponseData ::= Sequence {
+ version [0] EXPLICIT Version DEFAULT v1,
+ responderID ResponderID,
+ producedAt GeneralizedTime,
+ responses Sequence OF SingleResponse,
+ responseExtensions [1] EXPLICIT Extensions OPTIONAL }
+
+
+ RevokedInfo ::= Sequence {
+ revocationTime GeneralizedTime,
+ revocationReason [0] EXPLICIT CRLReason OPTIONAL }
+
+
+ ServiceLocator ::= Sequence {
+ issuer Name,
+ locator AuthorityInfoAccessSyntax OPTIONAL }
+
+
+ Signature ::= Sequence {
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING,
+ certs [0] EXPLICIT Sequence OF Certificate OPTIONAL}
+
+
+ SingleResponse ::= Sequence {
+ certID CertID,
+ certStatus CertStatus,
+ thisUpdate GeneralizedTime,
+ nextUpdate [0] EXPLICIT GeneralizedTime OPTIONAL,
+ singleExtensions [1] EXPLICIT Extensions OPTIONAL }
+
+
+ TBSRequest ::= Sequence {
+ version [0] EXPLICIT Version DEFAULT v1,
+ requestorName [1] EXPLICIT GeneralName OPTIONAL,
+ requestList Sequence OF Request,
+ requestExtensions [2] EXPLICIT Extensions OPTIONAL }
+
+
+ Attr ::= Sequence {
+ attrType OBJECT IDENTIFIER,
+ attrValues Set OF AttributeValue
+ }
+
+
+ CertificationRequest ::= Sequence {
+ certificationRequestInfo CertificationRequestInfo,
+ signatureAlgorithm AlgorithmIdentifier{{ SignatureAlgorithms }},
+ signature BIT STRING
+ }
+
+
+ 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})
+ }
+
+
+ ContentInfo ::= Sequence {
+ contentType ContentType,
+ content
+ [0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
+
+
+ EncryptedData ::= Sequence {
+ version Version,
+ encryptedContentInfo EncryptedContentInfo
+ }
+
+
+ EncryptedContentInfo ::= Sequence {
+ contentType ContentType,
+ contentEncryptionAlgorithm ContentEncryptionAlgorithmIdentifier,
+ encryptedContent [0] IMPLICIT EncryptedContent OPTIONAL
+ }
+
+ EncryptedContent ::= OCTET STRING
+
+
+ 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.
+
+ id-alg-AEADChaCha20Poly1305 OBJECT IDENTIFIER ::=
+ { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1)
+ pkcs9(9) smime(16) alg(3) 18 }
+
+ AEADChaCha20Poly1305Nonce ::= OCTET STRING (SIZE(12))
+
+
+ [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 } }
+
+
+ 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.
+
+ 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.
+
+ 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.
+
+ SignedData ::= Sequence {
+ version Version,
+ digestAlgorithms DigestAlgorithmIdentifiers,
+ contentInfo ContentInfo,
+ certificates
+ [0] IMPLICIT ExtendedCertificatesAndCertificates
+ OPTIONAL,
+ crls
+ [1] IMPLICIT CertificateRevocationLists OPTIONAL,
+ signerInfos SignerInfos }
+
+
+ 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
+
+ + SMIMECapabilities ::= Sequence OF SMIMECapability ++
+ SMIMECapability ::= Sequence {
+ capabilityID OBJECT IDENTIFIER,
+ parameters ANY DEFINED BY capabilityID OPTIONAL
+ }
+
+
+ SmimeEncryptionKeyPreference ::= CHOICE {
+ issuerAndSerialNumber [0] IssuerAndSerialNumber,
+ receipentKeyId [1] RecipientKeyIdentifier,
+ subjectAltKeyIdentifier [2] SubjectKeyIdentifier
+ }
+
+
+ Accuracy ::= SEQUENCE {
+ seconds INTEGER OPTIONAL,
+ millis [0] INTEGER (1..999) OPTIONAL,
+ micros [1] INTEGER (1..999) OPTIONAL
+ }
+
+
+ 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 }
+
+
+
+ AttributeTypeAndValue ::= SEQUENCE {
+ type OBJECT IDENTIFIER,
+ value ANY DEFINED BY type }
+
+ @return 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)) }
+
+
+ * RelativeDistinguishedName ::=
+ * SET OF AttributeTypeAndValue
+
+ * AttributeTypeAndValue ::= SEQUENCE {
+ * type AttributeType,
+ * value AttributeValue }
+ *
+ * @return this object as its ASN1Primitive type
+
+ AccessDescription ::= SEQUENCE {
+ accessMethod OBJECT IDENTIFIER,
+ accessLocation GeneralName }
+
+
+ AlgorithmIdentifier ::= Sequence {
+ algorithm OBJECT IDENTIFIER,
+ parameters ANY DEFINED BY algorithm OPTIONAL }
+
+
+ AttCertIssuer ::= CHOICE {
+ v1Form GeneralNames, -- MUST NOT be used in this
+ -- profile
+ v2Form [0] V2Form -- v2 only
+ }
+
+
+ AttCertValidityPeriod ::= Sequence {
+ notBeforeTime GeneralizedTime,
+ notAfterTime GeneralizedTime
+ }
+
+
+ Attr ::= Sequence {
+ attrType OBJECT IDENTIFIER,
+ attrValues Set OF AttributeValue
+ }
+
+
+ AttributeCertificate ::= Sequence {
+ acinfo AttributeCertificateInfo,
+ signatureAlgorithm AlgorithmIdentifier,
+ signatureValue BIT STRING
+ }
+
+
+ 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) }
+
+
+ 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 }
+
+
+ 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
+
+
+ + * SubjectPublicKeyInfo apki = new SubjectPublicKeyInfo((ASN1Sequence)new ASN1InputStream( + * publicKey.getEncoded()).readObject()); + * AuthorityKeyIdentifier aki = new AuthorityKeyIdentifier(apki); + *+ * + * +
+ BasicConstraints := Sequence {
+ cA Boolean DEFAULT FALSE,
+ pathLenConstraint Integer (0..MAX) OPTIONAL
+ }
+
+
+ CertificateList ::= Sequence {
+ tbsCertList TbsCertList,
+ signatureAlgorithm AlgorithmIdentifier,
+ signatureValue BIT STRING }
+
+
+ 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 -- }
+
+
+ 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.
+
+ CertificatePair ::= SEQUENCE {
+ forward [0] Certificate OPTIONAL,
+ reverse [1] Certificate OPTIONAL,
+ -- at least one of the pair shall be present -- }
+
+
+ @return a DERObject
+
+ CertificatePolicies ::= SEQUENCE SIZE {1..MAX} OF PolicyInformation
+
+ + CertPolicyId ::= OBJECT IDENTIFIER ++
+ CrlDistPoint ::= Sequence SIZE {1..MAX} OF DistributionPoint
+
+ + CRLNumber::= Integer(0..MAX) ++
+ CRLReason ::= Enumerated {
+ unspecified (0),
+ keyCompromise (1),
+ cACompromise (2),
+ affiliationChanged (3),
+ superseded (4),
+ cessationOfOperation (5),
+ certificateHold (6),
+ removeFromCRL (8),
+ privilegeWithdrawn (9),
+ aACompromise (10)
+ }
+
+
+ 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
+ DisplayTextMaximumSize here.
+
+ DisplayText instance.
+
+ @param type the desired encoding type for the text.
+ @param text the text to store. Strings longer than 200
+ characters are truncated.
+ DisplayText instance.
+
+ @param text the text to encapsulate. Strings longer than 200
+ characters are truncated.
+ DisplayText instance.
+ Useful when reading back a DisplayText class
+ from it's Asn1Encodable form.
Asn1Encodable instance.
+ string object.
+
+ @return the stored text as a string.
+
+ DistributionPoint ::= Sequence {
+ distributionPoint [0] DistributionPointName OPTIONAL,
+ reasons [1] ReasonFlags OPTIONAL,
+ cRLIssuer [2] GeneralNames OPTIONAL
+ }
+
+
+ DistributionPointName ::= CHOICE {
+ fullName [0] GeneralNames,
+ nameRelativeToCRLIssuer [1] RDN
+ }
+
+ + extendedKeyUsage ::= Sequence SIZE (1..MAX) OF KeyPurposeId ++
+ 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 }
+
+ + This constructor can handle: +
+ 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. +
+ GeneralNames ::= Sequence SIZE {1..MAX} OF GeneralName
+
+
+
+ GeneralSubtree ::= SEQUENCE
+ {
+ baseName GeneralName,
+ minimum [0] BaseDistance DEFAULT 0,
+ maximum [1] BaseDistance OPTIONAL
+ }
+
+
+ @see org.bouncycastle.asn1.x509.NameConstraints
+
+
+ If minimum is null, zero is assumed, if
+ maximum is null, maximum is absent.
+ GeneralSubtree ::= SEQUENCE
+ {
+ baseName GeneralName,
+ minimum [0] BaseDistance DEFAULT 0,
+ maximum [1] BaseDistance OPTIONAL
+ }
+
+
+ @return a DERObject
+ + 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
+
+
+
+ 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
+ }
+
+ IetfAttrSyntax as specified by RFC3281.
+
+
+ IetfAttrSyntax ::= Sequence {
+ policyAuthority [0] GeneralNames OPTIONAL,
+ values Sequence OF CHOICE {
+ octets OCTET STRING,
+ oid OBJECT IDENTIFIER,
+ string UTF8String
+ }
+ }
+
+
+
+ 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 }
+
+ true then the CRL contains revocation
+ information about certificates ssued by other CAs.
+ @param onlyContainsAttributeCerts Covers revocation information for attribute certificates.
+ + KeyPurposeID ::= OBJECT IDENTIFIER ++
+ 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) }
+
+ 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
+ NoticeReference instance.
+
+ @param organization a String value
+ @param numbers a Vector value
+ NoticeReference instance.
+
+ @param organization a String value
+ @param noticeNumbers an ASN1EncodableVector value
+ NoticeReference instance.
+
+ @param organization displayText
+ @param noticeNumbers an ASN1EncodableVector value
+ NoticeReference instance.
+ Useful for reconstructing a NoticeReference
+ instance from its encodable/encoded form.
Asn1Sequence value obtained from either
+ calling @{link ToAsn1Object()} for a NoticeReference
+ instance or from parsing it from a Der-encoded stream.
+ ToAsn1Object method here.
+
+ @return a Asn1Object value
+
+
+ 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
+ }
+
+
+
+
+ If digestedObjectType is not {@link #publicKeyCert} or
+ {@link #publicKey} otherObjectTypeID must be given,
+ otherwise it is ignored.
otherObjectDigest.
+ @param digestAlgorithm The algorithm identifier for the hash.
+ @param objectDigest The hash value.
+
+
+ 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
+ }
+
+
+
+ OtherName ::= SEQUENCE {
+ type-id OBJECT IDENTIFIER,
+ value [0] EXPLICIT ANY DEFINED BY type-id }
+
+
+ OtherName. It must be an instance of OtherName
+ or ASN1Sequence.
+ @return the instance of OtherName built from the
+ supplied object.
+ @throws java.lang.IllegalArgumentException if the object passed
+ to the factory is not an instance of OtherName or something that
+ can be converted into an appropriate ASN1Sequence.
+
+ PolicyMappings ::= Sequence SIZE (1..MAX) OF Sequence {
+ issuerDomainPolicy CertPolicyId,
+ subjectDomainPolicy CertPolicyId }
+
+
+ @see RFC 3280, section 4.2.1.6
+ PolicyMappings instance.
+
+ @param seq an Asn1Sequence constructed as specified
+ in RFC 3280
+ PolicyMappings instance.
+
+ @param mappings a HashMap value that maps
+ string oids
+ to other string oids.
+
+ 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 )
+
+
+ PolicyQualifierInfo ::= Sequence {
+ policyQualifierId PolicyQualifierId,
+ qualifier ANY DEFINED BY policyQualifierId }
+
+ PolicyQualifierInfo instance.
+
+ @param policyQualifierId a PolicyQualifierId value
+ @param qualifier the qualifier, defined by the above field.
+ PolicyQualifierInfo containing a
+ cPSuri qualifier.
+
+ @param cps the CPS (certification practice statement) uri as a
+ string.
+ PolicyQualifierInfo instance.
+
+ @param as PolicyQualifierInfo X509 structure
+ encoded as an Asn1Sequence.
+ Asn1Object value
+
+ PrivateKeyUsagePeriod ::= SEQUENCE
+ {
+ notBefore [0] GeneralizedTime OPTIONAL,
+ notAfter [1] GeneralizedTime OPTIONAL }
+
+
+ BiometricData ::= SEQUENCE {
+ typeOfBiometricData TypeOfBiometricData,
+ hashAlgorithm AlgorithmIdentifier,
+ biometricDataHash OCTET STRING,
+ sourceDataUri IA5String OPTIONAL }
+
+
+ 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
+
+
+ MonetaryValue ::= SEQUENCE {
+ currency Iso4217CurrencyCode,
+ amount INTEGER,
+ exponent INTEGER }
+ -- value = amount * 10^exponent
+
+
+ QCStatement ::= SEQUENCE {
+ statementId OBJECT IDENTIFIER,
+ statementInfo ANY DEFINED BY statementId OPTIONAL}
+
+
+ SemanticsInformation ::= SEQUENCE {
+ semanticsIdentifier OBJECT IDENTIFIER OPTIONAL,
+ nameRegistrationAuthorities NameRegistrationAuthorities
+ OPTIONAL }
+ (WITH COMPONENTS {..., semanticsIdentifier PRESENT}|
+ WITH COMPONENTS {..., nameRegistrationAuthorities PRESENT})
+
+ NameRegistrationAuthorities ::= SEQUENCE SIZE (1..MAX) OF
+ GeneralName
+
+
+ TypeOfBiometricData ::= CHOICE {
+ predefinedBiometricType PredefinedBiometricType,
+ biometricDataOid OBJECT IDENTIFIER }
+
+ PredefinedBiometricType ::= INTEGER {
+ picture(0),handwritten-signature(1)}
+ (picture|handwritten-signature)
+
+
+ ReasonFlags ::= BIT STRING {
+ unused(0),
+ keyCompromise(1),
+ cACompromise(2),
+ affiliationChanged(3),
+ superseded(4),
+ cessationOfOperation(5),
+ certficateHold(6)
+ }
+
+
+ RoleSyntax ::= SEQUENCE {
+ roleAuthority [0] GeneralNames OPTIONAL,
+ roleName [1] GeneralName
+ }
+
+
+ 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.
+ new RoleSyntax(null, roleName).
+ @param roleName the role name of this RoleSyntax.
+ string argument representing
+ the role name, builds a GeneralName to hold the role name
+ and calls the constructor that takes a GeneralName.
+ @param roleName
+ 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.
+ GeneralNames holding the
+ role authority of this RoleSyntax.
+ GeneralName holding the
+ role name of this RoleSyntax.
+ java.lang.string object.
+ @return the role name of this RoleSyntax represented as a
+ string object.
+ string[] object.
+ @return the role authority of this RoleSyntax represented as a
+ string[] array.
+ ToAsn1Object as
+ required by the superclass ASN1Encodable.
+
+
+ RoleSyntax ::= SEQUENCE {
+ roleAuthority [0] GeneralNames OPTIONAL,
+ roleName [1] GeneralName
+ }
+
+
+ RSAPublicKey ::= Sequence {
+ modulus Integer, -- n
+ publicExponent Integer, -- e
+ }
+
+
+ NameOrPseudonym ::= CHOICE {
+ surAndGivenName SEQUENCE {
+ surName DirectoryString,
+ givenName SEQUENCE OF DirectoryString
+ },
+ pseudonym DirectoryString
+ }
+
+
+ @see org.bouncycastle.asn1.x509.sigi.PersonalData
+
+
+ NameOrPseudonym ::= CHOICE {
+ surAndGivenName SEQUENCE {
+ surName DirectoryString,
+ givenName SEQUENCE OF DirectoryString
+ },
+ pseudonym DirectoryString
+ }
+
+ @param pseudonym pseudonym value to use.
+
+ NameOrPseudonym ::= CHOICE {
+ surAndGivenName SEQUENCE {
+ surName DirectoryString,
+ givenName SEQUENCE OF DirectoryString
+ },
+ pseudonym DirectoryString
+ }
+
+
+ @param seq The ASN.1 sequence.
+
+ NameOrPseudonym ::= CHOICE {
+ surAndGivenName SEQUENCE {
+ surName DirectoryString,
+ givenName SEQUENCE OF DirectoryString
+ },
+ pseudonym DirectoryString
+ }
+
+
+ @return an Asn1Object
+
+ 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
+
+ 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.
+
+ 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
+
+ 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.X509Name for AttributeType ObjectIdentifiers.
+
+ 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.
+
+ 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
+ + SubjectKeyIdentifier::= OCTET STRING ++
+ (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. +
+ (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 GetEncoded() method in the public keys in the JCE produces a DER + encoded one of these.
+
+ SubjectPublicKeyInfo ::= Sequence {
+ algorithm AlgorithmIdentifier,
+ publicKey BIT STRING }
+
+
+ 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.
+
+ obj can be a Target or a {@link Asn1TaggedObject}
+ Exactly one of the parameters must be not null.
+ Target ::= CHOICE {
+ targetName [0] GeneralName,
+ targetGroup [1] GeneralName,
+ targetCert [2] TargetCert
+ }
+
+
+ @return an Asn1Object
+ + SEQUENCE OF Targets ++ +
+ obj can be a TargetInformation or a {@link Asn1Sequence}
+ The ArrayList is cloned before it is returned.
+ + @return Returns the targets. ++ 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 ::= 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
+
+ obj can be a Targets or a {@link Asn1Sequence}
+ The ArrayList is copied.
+ + @param targets AnArrayList of {@link Target}s.
+ @see Target
+ @throws ArgumentException if the ArrayList contains not only Targets.
+ ArrayList.
+ + The ArrayList is cloned before it is returned.
+ + @return Returns the targets. ++ Targets ::= SEQUENCE OF Target ++ + @return an Asn1Object +
+ 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.
+
+ 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
+ }
+
+
+ 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
+ UserNotice instance.
+
+ @param noticeRef a NoticeReference value
+ @param explicitText a DisplayText value
+ UserNotice instance.
+
+ @param noticeRef a NoticeReference value
+ @param str the explicitText field as a string.
+ 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.
+ TbsCertificate ::= Sequence {
+ version [ 0 ] Version DEFAULT v1(0),
+ serialNumber CertificateSerialNumber,
+ signature AlgorithmIdentifier,
+ issuer Name,
+ validity Validity,
+ subject Name,
+ subjectPublicKeyInfo SubjectPublicKeyInfo,
+ }
+
+
+
+ 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
+ }
+
+
+
+ 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
+ }
+
+
+ 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
+
+ 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
+ }
+
+
+
+ Certificate ::= Sequence {
+ tbsCertificate TbsCertificate,
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING
+ }
+
+ + it's is assumed the table contains Oid/string pairs.
++ It's is assumed the table contains Oid/string pairs.
++ it's is assumed the table contains Oid/string pairs.
++ It's is assumed the table contains Oid/string pairs.
+
+ Extensions ::= SEQUENCE SIZE (1..MAX) OF Extension
+
+ Extension ::= SEQUENCE {
+ extnId EXTENSION.&id ({ExtensionSet}),
+ critical BOOLEAN DEFAULT FALSE,
+ extnValue OCTET STRING }
+
+
+ RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
+
+ RelativeDistinguishedName ::= SET SIZE (1..MAX) OF AttributeTypeAndValue
+
+ AttributeTypeAndValue ::= SEQUENCE {
+ type OBJECT IDENTIFIER,
+ value ANY }
+
+ Note: if you're trying to be ultra orthodox, don't use this! It shouldn't be in here.
++ it's is assumed the table contains OID/string pairs, and the contents + of the table are copied into an internal table as part of the + construction process. The ordering ArrayList should contain the OIDs + in the order they are meant to be encoded or printed in ToString.
++ it's is assumed the table contains OID/string pairs, and the contents + of the table are copied into an internal table as part of the + construction process. The ordering ArrayList should contain the OIDs + in the order they are meant to be encoded or printed in ToString.
++ The passed in converter will be used to convert the strings into their + ASN.1 counterparts.
++ The passed in converter will be used to convert the strings into their + ASN.1 counterparts.
++ * An example of an encoder look like below: + *
+ * public class X509DirEntryConverter
+ * : X509NameEntryConverter
+ * {
+ * public Asn1Object GetConvertedValue(
+ * DerObjectIdentifier oid,
+ * string value)
+ * {
+ * if (str.Length() != 0 && str.charAt(0) == '#')
+ * {
+ * return ConvertHexEncoded(str, 1);
+ * }
+ * if (oid.Equals(EmailAddress))
+ * {
+ * return new DerIA5String(str);
+ * }
+ * else if (CanBePrintable(str))
+ * {
+ * return new DerPrintableString(str);
+ * }
+ * else if (CanBeUTF8(str))
+ * {
+ * return new DerUtf8String(str);
+ * }
+ * else
+ * {
+ * return new DerBmpString(str);
+ * }
+ * }
+ * }
+ *
+ *
+
+ KeySpecificInfo ::= Sequence {
+ algorithm OBJECT IDENTIFIER,
+ counter OCTET STRING SIZE (4..4)
+ }
+
+
+ OtherInfo ::= Sequence {
+ keyInfo KeySpecificInfo,
+ partyAInfo [0] OCTET STRING OPTIONAL,
+ suppPubInfo [2] OCTET STRING
+ }
+
+
+ Parameters ::= CHOICE {
+ ecParameters ECParameters,
+ namedCurve CURVES.&id({CurveNames}),
+ implicitlyCA Null
+ }
+
+
+ Curve ::= Sequence {
+ a FieldElement,
+ b FieldElement,
+ seed BIT STRING OPTIONAL
+ }
+
+
+ ECParameters ::= Sequence {
+ version Integer { ecpVer1(1) } (ecpVer1),
+ fieldID FieldID {{FieldTypes}},
+ curve X9Curve,
+ base X9ECPoint,
+ order Integer,
+ cofactor Integer OPTIONAL
+ }
+
+ + ECPoint ::= OCTET STRING ++
+ Octet string produced using ECPoint.GetEncoded().
++ FieldElement ::= OCTET STRING ++
+
F2.
+ @param primeP The prime p defining the prime field.
+ F2m.
+ @param m The exponent m of
+ F2m.
+ @param k1 The integer k1 where xm +
+ xk1 + 1
+ represents the reduction polynomial f(z).
+ 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)..
+
+ FieldID ::= Sequence {
+ fieldType FIELD-ID.&id({IOSet}),
+ parameters FIELD-ID.&Type({IOSet}{@fieldType})
+ }
+
+ + Return an output stream which will save the data being written to + the compressed object. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Return an output stream which will compress the data as it is written to it. + The stream will be written out in chunks according to the size of the passed in buffer. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Note: if the buffer is not a power of 2 in length only the largest power of 2 + bytes worth of the buffer will be used. +
++ Note: using this may break compatibility with RFC 1991 compliant tools. + Only recent OpenPGP implementations are capable of accepting these streams. +
++ If buffer is non null stream assumed to be partial, otherwise the length will be used + to output a fixed length packet. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Return an output stream which will encrypt the data as it is written to it. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Return an output stream which will encrypt the data as it is written to it. + The stream will be written out in chunks according to the size of the passed in buffer. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Note: if the buffer is not a power of 2 in length only the largest power of 2 + bytes worth of the buffer will be used. +
++ Close off the encrypted object - this is equivalent to calling Close() on the stream + returned by the Open() method. +
++ Note: This does not close the underlying output stream, only the stream on top of + it created by the Open() method. +
++ A word for the unwary, the KeyId for an OpenPGP public key is calculated from + a hash that includes the time of creation, if you pass a different date to the + constructor below with the same public private key pair the KeyIs will not be the + same as for previous generations of the key, so ideally you only want to do + this once. +
++ Open a literal data packet, returning a stream to store the data inside the packet. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Open a literal data packet, returning a stream to store the data inside the packet, + as an indefinite length stream. The stream is written out as a series of partial + packets with a chunk size determined by the size of the passed in buffer. +
+
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Note: if the buffer is not a power of 2 in length only the largest power of 2 + bytes worth of the buffer will be used.
+
+ Open a literal data packet for the passed in
+ The stream created can be closed off by either calling Close()
+ on the stream or Close() on the generator. Closing the returned
+ stream does not close off the Stream parameter
+ Note: if this class finds a PgpPublicKey or a PgpSecretKey it + will create a PgpPublicKeyRing, or a PgpSecretKeyRing for each + key found. If all you are trying to do is read a key ring file use + either PgpPublicKeyRingBundle or PgpSecretKeyRingBundle.
+
+ Often PGP keyring files consist of multiple master keys, if you are trying to process
+ or construct one of these you should use the
+ Often PGP keyring files consist of multiple master keys, if you are trying to process
+ or construct one of these you should use the
+ Note: this overrides the generation of a creation time when the signature + is generated.
++ Format documented here: + http://git.gnupg.org/cgi-bin/gitweb.cgi?p=gnupg.git;a=blob;f=agent/keyformat.txt;h=42c4b1f06faf1bbe71ffadc2fee0fad6bec91a97;hb=refs/heads/master +
++ CMSAuthenticatedDataGenerator fact = new CMSAuthenticatedDataGenerator(); + + fact.addKeyTransRecipient(cert); + + CMSAuthenticatedData data = fact.generate(content, algorithm, "BC"); ++
+ Note: that because we are in a streaming mode only one recipient can be tried and it is important + that the methods on the parser are called in the appropriate order. +
++ Example of use - assuming the first recipient matches the private key we have. +
+ CMSAuthenticatedDataParser ad = new CMSAuthenticatedDataParser(inputStream);
+
+ RecipientInformationStore recipients = ad.getRecipientInfos();
+
+ Collection c = recipients.getRecipients();
+ Iterator it = c.iterator();
+
+ if (it.hasNext())
+ {
+ RecipientInformation recipient = (RecipientInformation)it.next();
+
+ CMSTypedStream recData = recipient.getContentStream(privateKey, "BC");
+
+ processDataStream(recData.getContentStream());
+
+ if (!Arrays.equals(ad.getMac(), recipient.getMac())
+ {
+ System.err.println("Data corrupted!!!!");
+ }
+ }
+
+ Note: this class does not introduce buffering - if you are processing large files you should create
+ the parser with:
+ + CMSAuthenticatedDataParser ep = new CMSAuthenticatedDataParser(new BufferedInputStream(inputStream, bufSize)); ++ where bufSize is a suitably large buffer size. + +
+ A simple example of usage. +
+ CMSAuthenticatedDataStreamGenerator edGen = new CMSAuthenticatedDataStreamGenerator(); + + edGen.addKeyTransRecipient(cert); + + ByteArrayOutputStream bOut = new ByteArrayOutputStream(); + + OutputStream out = edGen.open( + bOut, CMSAuthenticatedDataGenerator.AES128_CBC, "BC");* + out.write(data); + + out.close(); ++ +
+ * A simple example of usage.
+ *+ *
+ * CMSCompressedDataGenerator fact = new CMSCompressedDataGenerator(); + * CMSCompressedData data = fact.Generate(content, algorithm); + *+ * +
+ CMSCompressedDataParser cp = new CMSCompressedDataParser(inputStream); + + process(cp.GetContent().GetContentStream()); ++ Note: this class does not introduce buffering - if you are processing large files you should create + the parser with: +
+ CMSCompressedDataParser ep = new CMSCompressedDataParser(new BufferedInputStream(inputStream, bufSize)); ++ where bufSize is a suitably large buffer size. +
+ A simple example of usage. +
++ CMSCompressedDataStreamGenerator gen = new CMSCompressedDataStreamGenerator(); + + Stream cOut = gen.Open(outputStream, CMSCompressedDataStreamGenerator.ZLIB); + + cOut.Write(data); + + cOut.Close(); ++
+ CmsEnvelopedDataGenerator fact = new CmsEnvelopedDataGenerator(); + + fact.AddKeyTransRecipient(cert); + + CmsEnvelopedData data = fact.Generate(content, algorithm); ++
+ Note: that because we are in a streaming mode only one recipient can be tried and it is important + that the methods on the parser are called in the appropriate order. +
++ Example of use - assuming the first recipient matches the private key we have. +
+ CmsEnvelopedDataParser ep = new CmsEnvelopedDataParser(inputStream);
+
+ RecipientInformationStore recipients = ep.GetRecipientInfos();
+
+ Collection c = recipients.getRecipients();
+ Iterator it = c.iterator();
+
+ if (it.hasNext())
+ {
+ RecipientInformation recipient = (RecipientInformation)it.next();
+
+ CMSTypedStream recData = recipient.getContentStream(privateKey);
+
+ processDataStream(recData.getContentStream());
+ }
+
+ Note: this class does not introduce buffering - if you are processing large files you should create
+ the parser with:
+ + CmsEnvelopedDataParser ep = new CmsEnvelopedDataParser(new BufferedInputStream(inputStream, bufSize)); ++ where bufSize is a suitably large buffer size. + +
+ A simple example of usage. +
+ CmsEnvelopedDataStreamGenerator edGen = new CmsEnvelopedDataStreamGenerator(); + + edGen.AddKeyTransRecipient(cert); + + MemoryStream bOut = new MemoryStream(); + + Stream out = edGen.Open( + bOut, CMSEnvelopedDataGenerator.AES128_CBC);* + out.Write(data); + + out.Close(); ++ +
+ CMSEnvelopedDataGenerator fact = new CMSEnvelopedDataGenerator(); + + fact.addKeyTransRecipient(cert); + + CMSEnvelopedData data = fact.generate(content, algorithm, "BC"); ++
+ IX509Store certs = s.GetCertificates();
+ SignerInformationStore signers = s.GetSignerInfos();
+
+ foreach (SignerInformation signer in signers.GetSigners())
+ {
+ ArrayList certList = new ArrayList(certs.GetMatches(signer.SignerID));
+ X509Certificate cert = (X509Certificate) certList[0];
+
+ if (signer.Verify(cert.GetPublicKey()))
+ {
+ verified++;
+ }
+ }
+
+ + * A simple example of usage. + * + *
+ * IX509Store certs... + * IX509Store crls... + * CmsSignedDataGenerator gen = new CmsSignedDataGenerator(); + * + * gen.AddSigner(privKey, cert, CmsSignedGenerator.DigestSha1); + * gen.AddCertificates(certs); + * gen.AddCrls(crls); + * + * CmsSignedData data = gen.Generate(content); + *+ * +
+ Note: that because we are in a streaming mode only one signer can be tried and it is important + that the methods on the parser are called in the appropriate order. +
++ A simple example of usage for an encapsulated signature. +
++ Two notes: first, in the example below the validity of + the certificate isn't verified, just the fact that one of the certs + matches the given signer, and, second, because we are in a streaming + mode the order of the operations is important. +
+
+ CmsSignedDataParser sp = new CmsSignedDataParser(encapSigData);
+
+ sp.GetSignedContent().Drain();
+
+ IX509Store certs = sp.GetCertificates();
+ SignerInformationStore signers = sp.GetSignerInfos();
+
+ foreach (SignerInformation signer in signers.GetSigners())
+ {
+ ArrayList certList = new ArrayList(certs.GetMatches(signer.SignerID));
+ X509Certificate cert = (X509Certificate) certList[0];
+
+ Console.WriteLine("verify returns: " + signer.Verify(cert));
+ }
+
+ Note also: this class does not introduce buffering - if you are processing large files you should create
+ the parser with:
+ + CmsSignedDataParser ep = new CmsSignedDataParser(new BufferedInputStream(encapSigData, bufSize)); ++ where bufSize is a suitably large buffer size. +
+ The output stream is returned unclosed. +
+ @param original the signed data stream to be used as a base. + @param signerInformationStore the new signer information store to use. + @param out the stream to Write the new signed data object to. + @return out. ++ The output stream is returned unclosed. +
+ @param original the signed data stream to be used as a base. + @param certsAndCrls the new certificates and CRLs to be used. + @param out the stream to Write the new signed data object to. + @return out. + @exception CmsException if there is an error processing the CertStore ++ A simple example of usage. +
+
+ IX509Store certs...
+ CmsSignedDataStreamGenerator gen = new CmsSignedDataStreamGenerator();
+
+ gen.AddSigner(privateKey, cert, CmsSignedDataStreamGenerator.DIGEST_SHA1);
+
+ gen.AddCertificates(certs);
+
+ Stream sigOut = gen.Open(bOut);
+
+ sigOut.Write(Encoding.UTF8.GetBytes("Hello World!"));
+
+ sigOut.Close();
+
+ + note: This uses MTI/A0 key agreement in order to make the key agreement + secure against passive attacks. If you're doing Diffie-Hellman and both + parties have long term public keys you should look at using this. For + further information have a look at RFC 2631.
++ It's possible to extend this to more than two parties as well, for the moment + that is left as an exercise for the reader.
++ 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.
++ 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!).
++ 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. +
++ NOTE: This algorithm is only included for backwards compatibility + with legacy applications, it's not secure, don't use it for anything new!
+Implementation of RipeMD256.
+Note: this algorithm offers the same level of security as RipeMD128.
+Implementation of RipeMD 320.
+Note: this algorithm offers the same level of security as RipeMD160.
++ 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 ++
+ block word digest + SHA-1 512 32 160 + SHA-256 512 32 256 + SHA-384 1024 64 384 + SHA-512 1024 64 512 ++
+ block word digest + SHA-1 512 32 160 + SHA-256 512 32 256 + SHA-384 1024 64 384 + SHA-512 1024 64 512 ++
+ block word digest + SHA-1 512 32 160 + SHA-256 512 32 256 + SHA-384 1024 64 384 + SHA-512 1024 64 512 ++
null to use no parameters.
+ null to use no parameters.
+ + The static property is checked during construction of the encoding object, it is set to + true by default. +
++ 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. +
++ 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 fast version with 8Kbytes of static tables for round precomputation +
++ 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 slowest performance version with no static tables + for round precomputation, but it has the smallest foot print. +
++ * Note: + *
+ http://www.ecrypt.eu.org/stream/p3ciphers/hc/hc128_p3.pdf +
+ It is a third phase candidate in the eStream contest, and is patent-free. + No attacks are known as of today (April 2007). See + + http://www.ecrypt.eu.org/stream/hcp3.html +
++ http://www.ecrypt.eu.org/stream/p3ciphers/hc/hc256_p3.pdf +
+ Its brother, HC-128, is a third phase candidate in the eStream contest. + The algorithm is patent-free. No attacks are known as of today (April 2007). + See + + http://www.ecrypt.eu.org/stream/hcp3.html +
++ This implementation is based on the "HOWTO: INTERNATIONAL DATA ENCRYPTION ALGORITHM" + implementation summary by Fauzan Mirza (F.U.Mirza@sheffield.ac.uk). (barring 1 typo at the + end of the MulInv function!). +
++ It can be found at ftp://ftp.funet.fi/pub/crypt/cryptography/symmetric/idea/ +
++ Note: This algorithm was patented in the USA, Japan and Europe. These patents expired in 2011/2012. +
++ i.e. x * MulInv(x) == 1 (modulo BASE) +
++ i.e. x + AddInv(x) == 0 +
+RC5 Encryption Algorithm
+ publication in RSA CryptoBytes, Spring of 1995.
+ http://www.rsasecurity.com/rsalabs/cryptobytes.
+ + This implementation has a word size of 32 bits.
+RC5 Encryption Algorithm
+ publication in RSA CryptoBytes, Spring of 1995.
+ http://www.rsasecurity.com/rsalabs/cryptobytes.
+ + This implementation is set to work with a 64 bit word size.
++ Note: this implementation is based on information prior to readonly NIST publication. +
++ * 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 + *
+null to use the current key.
+ the 2 word (128 bit) tweak, or null to use the current tweak.
+ + Tnepres is based on Serpent which was designed by Ross Anderson, Eli Biham and Lars Knudsen as a + candidate algorithm for the NIST AES Quest. Unfortunately there was an endianness issue + with test vectors in the AES submission and the resulting confusion lead to the Tnepres cipher + as well, which is a byte swapped version of Serpent. +
++ For full details see The Serpent home page +
++ *
+ * G(x) = x^4 + (a+1/a)x^3 + ax^2 + (a+1/a)x + 1 + *+ * where a = primitive root of field generator 0x14D + * +
+ This implementation does not correspondent to the 1999 published paper + "A Future-Adaptable Password Scheme" of Niels Provos and David Mazières, + see: https://www.usenix.org/legacy/events/usenix99/provos/provos_html/node1.html. + In contrast to the paper, the order of key setup and salt setup is reversed: + state <- ExpandKey(state, 0, key) + state %lt;- ExpandKey(state, 0, salt) + This corresponds to the OpenBSD reference implementation of Bcrypt. +
+ Note: + There is no successful cryptanalysis (status 2015), but + the amount of memory and the band width of Bcrypt + may be insufficient to effectively prevent attacks + with custom hardware like FPGAs, ASICs +
+ This implementation uses some parts of Bouncy Castle's BlowfishEngine. +
++ This implements the raw bcrypt function as defined in the bcrypt specification, not + the crypt encoded version implemented in OpenBSD. +
+ @param password the password bytes (up to 72 bytes) to use for this invocation. + @param salt the 128 bit salt to use for this invocation. + @param cost the bcrypt cost parameter. The cost of the bcrypt function grows as +2^cost. Legal values are 4..31 inclusive.
+ @return the output of the raw bcrypt operation: a 192 bit (24 byte) hash.
+ + Note: can take a while...
++ This Generates keys consistent for use with ElGamal as described in + page 164 of "Handbook of Applied Cryptography".
++ * Note: can take a while... + *
++ The scheme is a simple extension of PKCS 5 V2.0 Scheme 1 using MD5 with an + iteration count of 1. +
++ The document this implementation is based on can be found at + + RSA's Pkcs12 Page +
++ The document this implementation is based on can be found at + + RSA's Pkcs5 Page +
++ The document this implementation is based on can be found at + + RSA's Pkcs5 Page
+k[0] ... k[15], r[0] ... r[15] with the required bits in r cleared
+ as per r (second 16 bytes) portion of the key.k[0] ... k[15], r[0] ... r[15]
+ k[0] ... k[15], r[0] ... r[15] with the required bits in r cleared
+ as per r portion of the key.2^(128 * r / 8).
+ the block size, must be >= 1.
+ Parallelization parameter. Must be a positive integer less than or equal to
+ Int32.MaxValue / (128 * r * 8).
+ the length of the key to generate.
+ + 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. ++ 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. ++ 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. ++ 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 cfbBitSize the size of an output block produced by the CFB mode. + @param macSizeInBits the size of the MAC in bits, must be a multiple of 8. ++ 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 cfbBitSize the size of an output block produced by the CFB mode. + @param macSizeInBits the size of the MAC in bits, must be a multiple of 8. + @param padding a padding to be used. ++ 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. +
++ 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. ++ 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. +null to use no parameters.
+ + Note: this mode is a packet mode - it needs all the data up front. +
++License for + Open-Source Software Implementations of OCB (Jan 9, 2013) - 'License 1'
+ Under this license, you are authorized to make, use, and distribute open-source software + implementations of OCB. This license terminates for you if you sue someone over their open-source + software implementation of OCB claiming that you have a patent covering their implementation. ++ This is a non-binding summary of a legal document (the link above). The parameters of the license + are specified in the license document and that document is controlling.
+ * For further info see RFC 2440. + *
++ This padding pads the block out compliment of the last bit + of the plain text. +
++ Note: this assumes that the last block of plain text is always + passed to it inside in. i.e. if inOff is zero, indicating the + entire block is to be overwritten with padding the value of in + should be the same as the last block of plain text. +
++ See "Applied + Cryptography" by Bruce Schneier for more information. +
+ @return true if the given DES key material is weak or semi-weak, + false otherwise. +null if not
+ set.
+ null if not set.
+ null if not set.
+ null if not set.
+ null if
+ not set.
+ YYYYMMDD email@address distinguisher, encoded to a byte
+ sequence using UTF-8 encoding.
+ null to use the current key.null to use the current tweak.+ Internal access to the digest is synchronized so a single one of these can be shared. +
++ 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). ++ 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). ++ 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). ++ Access to internals is synchronized so a single one of these can be shared. +
++ 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. +
++ Any SecureRandom created from a builder constructed like this will make use of input passed to SecureRandom.setSeed() if + the passed in SecureRandom does for its generateSeed() call. +
+ @param entropySource + @param predictionResistant ++ Note: If this constructor is used any calls to setSeed() in the resulting SecureRandom will be ignored. +
+ @param entropySourceProvider a provider of EntropySource objects. ++ Based on an idea from Marcus Lippert. +
++ If fast is set to true, the code should be round about 8 times faster when + generating a long sequence of random bytes. 20 bytes of random values using + the fast mode take less than half a second on a Nokia e70. If fast is set to false, + it takes round about 2500 ms. +
+ @param numBytes the number of bytes to generate + @param fast true if fast mode should be used +
+ // First 1850 fractional digit of Pi number.
+ byte[] key = new BigInteger("14159265358979323846...5068006422512520511").ToByteArray();
+ s = 0;
+ P = new byte[256];
+ for (int i = 0; i < 256; i++)
+ {
+ P[i] = (byte) i;
+ }
+ for (int m = 0; m < 768; m++)
+ {
+ s = P[(s + P[m & 0xff] + key[m % key.length]) & 0xff];
+ byte temp = P[m & 0xff];
+ P[m & 0xff] = P[s & 0xff];
+ P[s & 0xff] = temp;
+ }
+ + 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. +
++ Any SecureRandom created from a builder constructed like this will make use of input passed to SecureRandom.setSeed() if + the passed in SecureRandom does for its generateSeed() call. +
+ @param entropySource + @param predictionResistant ++ Note: If this constructor is used any calls to setSeed() in the resulting SecureRandom will be ignored. +
+ @param entropySourceProvider a provider of EntropySource objects. ++ Note: the usual length for the salt is the length of the hash + function used in bytes.
++ Note: the usual value for the salt length is the number of + bytes in the hash function.
++ 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. +
+ This file could be more optimized. +
+
+ opaque ASN.1Cert<2^24-1>;
+
+ struct {
+ ASN.1Cert certificate_list<0..2^24-1>;
+ } Certificate;
+
+
+ @see Org.BouncyCastle.Asn1.X509.X509CertificateStructure
+ true if this certificate chain contains no certificates, or
+ false otherwise.
+
+ struct {
+ ClientCertificateType certificate_types<1..2^8-1>;
+ DistinguishedName certificate_authorities<3..2^16-1>
+ } CertificateRequest;
+
+
+ @see ClientCertificateType
+ @see X509Name
+ close_notify warning alert.
+ true if the handshake should be aborted when the peer does not negotiate the
+ extended_master_secret extension, or false to support legacy interoperability.
+ true if the current time should be used in the gmt_unix_time field of
+ Random, or false if gmt_unix_time should contain a cryptographically
+ random value.
+ OfferInput(input, 0, input.length)
+ @see TlsProtocol#OfferInput(byte[], int, int)
+ @param input The input buffer to offer
+ @throws IOException If an error occurs while decrypting or processing a record
+ From Knuth Vol 2, pg 395.
+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.
+ 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.
+ SimpleBigDecimal. The value of the
+ constructed SimpleBigDecimal Equals bigInt /
+ 2scale.
+ @param bigInt The bigInt value parameter.
+ @param scale The scale of the constructed SimpleBigDecimal.
+ α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
+ αu's for a=0 as an array
+ of ZTauElements.
+ αu's for a=0 as an array
+ of TNAFs.
+ αu's for a=1 as an array
+ of ZTauElements.
+ αu's for a=1 as an array
+ of TNAFs.
+ λ of
+ Z[τ].
+ @param mu The parameter μ of the elliptic curve.
+ @param lambda The element λ of
+ Z[τ].
+ @return The norm of λ.
+ λ 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 λ.
+ λ 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.
+ 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.
+ τ-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 λ.
+ τ() to an
+ AbstractF2mPoint.
+ @param p The AbstractF2mPoint to which τ() is applied.
+ @return τ(p)
+ μ 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.
+ 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.
+ 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
+ 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).
+ (τ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)
+ 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
+ λ of Z[τ]
+ using the τ-adic NAF (TNAF) method.
+ @param p The AbstractF2mPoint to Multiply.
+ @param lambda The element λ of
+ Z[τ].
+ @return λ * p
+ λ 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
+ [τ]-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
+ λ.
+ ECPoint for which to do the precomputation.
+ @param a The parameter a of the elliptic curve.
+ @return The precomputation array for p.
+ 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.
+ λ.
+ τ-adic" part of λ.
+ λ of
+ Z[τ].
+ @param u The "real" part of λ.
+ @param v The "τ-adic" part of
+ λ.
+ kP.
+ 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.
+ ECCurve instance, and MUST already be normalized.
+ ECMultiplier, unless already set.
+
+ We avoid locking for performance reasons, so there is no uniqueness guarantee.
+ Fp (X9.62 s 4.2.1 pg 17).
+ @return The decoded point.
+ s0 and
+ s1 used for partial modular reduction for
+ Koblitz curves.
+ 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.
+ s0 and
+ s1 used for partial modular reduction for
+ Koblitz curves.
+ y2 + xy = x3 + ax2 + b.
+ m of F2m.
+ k where xm +
+ xk + 1 represents the reduction polynomial
+ f(z).k1 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).0k2 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).0k3 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).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.
+ 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.
+ 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.
+ 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.
+ 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.
+ m of F2m.
+ LongArray holding the bits.
+ 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.
+ 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.
+ 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).
+ F2m, either of
+ {@link F2mFieldElement.Tpb} (trinomial
+ basis representation) or
+ {@link F2mFieldElement.Ppb} (pentanomial
+ basis representation).
+ m of the reduction polynomial
+ f(z).
+ k where xm +
+ xk + 1 represents the reduction polynomial
+ f(z).k1 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).0k2 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).0k3 where xm +
+ xk3 + xk2 + xk1 + 1
+ represents the reduction polynomial f(z).ECPoint by the given number.
+ @param k The multiplicator.
+ @return k * this.
+ ECPoints.
+ 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.
+ ECPoints used for a fixed point multiplication.
+ WNafMultiplier.
+ 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.
+ ECPoints used for a Window
+ NAF multiplication.
+ ECPoints used
+ for a Window NAF multiplication.
+ ECPoint representing Twice(this). Used for the
+ Window NAF multiplication to create or extend the precomputed values.
+ 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[].
+ τ-adic Non-Adjacent Form) algorithm.
+ 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.
+ λ 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 λ.
+ λ 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
+ τ-adic Non-Adjacent Form) algorithm.
+ AbstractF2mPoints used for the
+ WTNAF multiplication in
+ {@link org.bouncycastle.math.ec.multiplier.WTauNafMultiplier.multiply()
+ WTauNafMultiplier.multiply()}.
+ true if the candidate is found to have any small factors,
+ false otherwise.
+ 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).
+ false if the specified base is a witness to compositeness (so
+ candidate is definitely NOT prime), or else true.
+
+ BasicOcspResponse ::= SEQUENCE {
+ tbsResponseData ResponseData,
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING,
+ certs [0] EXPLICIT SEQUENCE OF Certificate OPTIONAL
+ }
+
+
+ OcspRequest ::= SEQUENCE {
+ tbsRequest TBSRequest,
+ optionalSignature [0] EXPLICIT Signature OPTIONAL }
+
+ TBSRequest ::= SEQUENCE {
+ version [0] EXPLICIT Version DEFAULT v1,
+ requestorName [1] EXPLICIT GeneralName OPTIONAL,
+ requestList SEQUENCE OF Request,
+ requestExtensions [2] EXPLICIT Extensions OPTIONAL }
+
+ Signature ::= SEQUENCE {
+ signatureAlgorithm AlgorithmIdentifier,
+ signature BIT STRING,
+ certs [0] EXPLICIT SEQUENCE OF Certificate OPTIONAL}
+
+ Version ::= INTEGER { v1(0) }
+
+ Request ::= SEQUENCE {
+ reqCert CertID,
+ singleRequestExtensions [0] EXPLICIT Extensions OPTIONAL }
+
+ CertID ::= SEQUENCE {
+ hashAlgorithm AlgorithmIdentifier,
+ issuerNameHash OCTET STRING, -- Hash of Issuer's DN
+ issuerKeyHash OCTET STRING, -- Hash of Issuers public key
+ serialNumber CertificateSerialNumber }
+
+ + In the case of PKCS7 objects the reader will return a CMS ContentInfo object. Keys and + Certificates will be returned using the appropriate java.security type.
+
+ CertificationRequest ::= Sequence {
+ certificationRequestInfo CertificationRequestInfo,
+ signatureAlgorithm AlgorithmIdentifier{{ SignatureAlgorithms }},
+ signature BIT STRING
+ }
+
+ 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})
+ }
+
+ see
+
+ CertificationRequest ::= Sequence {
+ certificationRequestInfo CertificationRequestInfo,
+ signatureAlgorithm AlgorithmIdentifier{{ SignatureAlgorithms }},
+ signature BIT STRING
+ }
+
+ 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})
+ }
+
+ see
+ Set of X.509 attribute certificate
+ extensions that this PkixAttrCertChecker supports or
+ null if no extensions are supported.
+
+ Each element of the set is a String representing the
+ Object Identifier (OID) of the X.509 extension that is supported.
+
+ All X.509 attribute certificate extensions that a
+ PkixAttrCertChecker might possibly be able to process
+ should be included in the set.
+
Set of X.509 extension OIDs (in
+ String format) supported by this
+ PkixAttrCertChecker, or null if no
+ extensions are supported
+ unresolvedCritExts
+ collection.
+
+ @param attrCert The attribute certificate to be checked.
+ @param certPath The certificate path which belongs to the attribute
+ certificate issuer public key certificate.
+ @param holderCertPath The certificate path which belongs to the holder
+ certificate.
+ @param unresolvedCritExts a Collection of OID strings
+ representing the current set of unresolved critical extensions
+ @throws CertPathValidatorException if the specified attribute certificate
+ does not pass the check.
+ PkixAttrCertChecker
+
+ params must be an instance of
+ ExtendedPkixParameters.
+
+ The target constraints in the params must be an
+ X509AttrCertStoreSelector with at least the attribute
+ certificate criterion set. Obey that also target informations may be
+ necessary to correctly validate this attribute certificate.
+
+ The attribute certificate issuer must be added to the trusted attribute + issuers with {@link ExtendedPkixParameters#setTrustedACIssuers(Set)}. +
+ @param certPath The certificate path which belongs to the attribute + certificate issuer public key certificate. + @param params The PKIX parameters. + @return APKIXCertPathValidatorResult of the result of
+ validating the certPath.
+ @throws InvalidAlgorithmParameterException if params is
+ inappropriate for this validator.
+ @throws CertPathValidatorException if the verification fails.
+ PkixBuilderParameters.
+
+ This method can be used to get a copy from other
+ PKIXBuilderParameters, PKIXParameters,
+ and ExtendedPKIXParameters instances.
+
PkixBuilderParameters instance.
+ ISet is null an
+ empty set is assumed.
+ ExtendedPKIXBuilderParameters and
+ PKIXBuilderParameters.
+
+ @param params Parameters to set.
+ @see org.bouncycastle.x509.ExtendedPKIXParameters#setParams(java.security.cert.PKIXParameters)
+ PKIXParameters object. Changes to the
+ copy will not affect the original and vice versa.
+
+ @return a copy of this PKIXParameters object
+ PKIXCertPathChecker.
+ *
+ * The forward flag specifies the order that certificates
+ * will be passed to the {@link #check check} method (forward or reverse). A
+ * PKIXCertPathChecker must support reverse checking
+ * and may support forward checking.
+ *
check method. If true,
+ * certificates are presented from target to most-trusted CA
+ * (forward); if false, from most-trusted CA to
+ * target (reverse).
+ * @exception CertPathValidatorException
+ * if this PKIXCertPathChecker is unable to
+ * check certificates in the specified order; it should never
+ * be thrown if the forward flag is false since reverse
+ * checking must be supported
+ PKIXCertPathChecker to perform its
+ checks when certificates are presented to the check method
+ in the forward direction (from target to most-trusted CA).
+
+ @return true if forward checking is supported,
+ false otherwise
+ Set of X.509 certificate extensions
+ * that this PKIXCertPathChecker supports (i.e. recognizes,
+ * is able to process), or null if no extensions are
+ * supported.
+ *
+ * Each element of the set is a String representing the
+ * Object Identifier (OID) of the X.509 extension that is supported. The OID
+ * is represented by a set of nonnegative integers separated by periods.
+ *
+ * All X.509 certificate extensions that a PKIXCertPathChecker
+ * might possibly be able to process should be included in the set.
+ *
Set of X.509 extension OIDs (in
+ * String format) supported by this
+ * PKIXCertPathChecker, or null if no
+ * extensions are supported
+ init method.
+
+ @param cert
+ the Certificate to be checked
+ @param unresolvedCritExts
+ a Collection of OID strings representing the
+ current set of unresolved critical extensions
+ @exception CertPathValidatorException
+ if the specified certificate does not pass the check
+ Object.clone()
+ method. All subclasses which maintain state must support and override
+ this method, if necessary.
+
+ @return a copy of this PKIXCertPathChecker
+ CertPathValidator implementations must include a class (the
+ SPI class) that extends this class (CertPathValidatorSpi)
+ and implements all of its methods. In general, instances of this class
+ should only be accessed through the CertPathValidator class.
+ For details, see the Java Cryptography Architecture.CertPathValidatorSpi instance concurrently should synchronize
+ amongst themselves and provide the necessary locking before calling the
+ wrapping CertPathValidator object.CertPathValidatorSpi may still
+ encounter concurrency issues, since multiple threads each
+ manipulating a different CertPathValidatorSpi instance need not
+ synchronize.
+ CertPathValidatorException provides support for wrapping
+ exceptions. The {@link #getCause getCause} method returns the throwable,
+ if any, that caused this exception to be thrown. CertPathValidatorException may also include the
+ certification path that was being validated when the exception was thrown
+ and the index of the certificate in the certification path that caused the
+ exception to be thrown. Use the {@link #getCertPath getCertPath} and
+ {@link #getIndex getIndex} methods to retrieve this information.PkixCertPathValidatorException with the given detail
+ message. A detail message is a String that describes this
+ particular exception.
+ PkixCertPathValidatorException with the specified
+ detail message and cause.
+ null
+ value is permitted, and indicates that the cause is
+ nonexistent or unknown.)
+ PkixCertPathValidatorException with the specified
+ detail message, cause, certification path, and index.
+ null if none)
+ the cause (or null if none)
+ the certification path that was in the process of being
+ validated when the error was encountered
+ the index of the certificate in the certification path that *
+ CertPathValidatorException.
+ null if neither the message nor cause were specifiedCertPath that was being validated when the
+ exception was thrown (or null if not specified)
+ CertPath is zero based. If no index has been set, -1 is
+ returned.
+
+ @return the index that has been set, or -1 if none has been set
+ TrustAnchor object if found or
+ null if not.
+ X500Principal.
+ This methods inherits DSA parameters from the indexed certificate or
+ previous certificates in the certificate chain to the returned
+ PublicKey. The list is searched upwards, meaning the end
+ certificate is at position 0 and previous certificates are following.
+
+ If the indexed certificate does not contain a DSA key this method simply + returns the public key. If the DSA key already contains DSA parameters + the key is also only returned. +
+ + @param certs The certification path. + @param index The index of the certificate which contains the public key + which should be extended with DSA parameters. + @return The public key of the certificate in list position +index extended with DSA parameters if applicable.
+ @throws Exception if DSA parameters cannot be inherited.
+ null.selector.
+
+ The issuerPrincipals are a collection with a single
+ X500Principal for X509Certificates. For
+ {@link X509AttributeCertificate}s the issuer may contain more than one
+ X500Principal.
+
issuerPrincipals does not
+ contain only X500Principals.
+ X509Certificate or
+ {@link org.bouncycastle.x509.X509AttributeCertificate} for
+ which the CRL should be searched.
+ @param currentDate The date for which the delta CRLs must be valid.
+ @param paramsPKIX The extended PKIX parameters.
+ @return A Set of X509CRLs with complete
+ CRLs.
+ @throws Exception if an exception occurs while picking the CRLs
+ or no CRLs are found.
+ Set of X509CRLs with delta CRLs.
+ @throws Exception if an exception occurs while picking the delta
+ CRLs.
+ Collection object containing the issuer
+ X509Certificates. Never null.
+
+ @exception Exception
+ if an error occurs.
+ null.
+ permitted with ip.
+
+ @param permitted A Set of permitted IP addresses with
+ their subnet mask as byte arrays.
+ @param ips The IP address with its subnet mask.
+ @return The Set of permitted IP ranges intersected with
+ ip.
+ excluded
+ with ip.
+
+ @param excluded A Set of excluded IP addresses with their
+ subnet mask as byte arrays.
+ @param ip The IP address with its subnet mask.
+ @return The Set of excluded IP ranges unified with
+ ip as byte arrays.
+ Set with the union of both addresses.
+ Set with the single IP address with its subnet
+ mask as a byte array or an empty Set.
+ ip is constrained by
+ constraint.
+
+ @param constraint The constraint. This is an IP address concatenated with
+ its subnetmask.
+ @param ip The IP address.
+ @return true if constrained, false
+ otherwise.
+ ip is included in the permitted ISet
+ permitted.
+
+ @param permitted A Set of permitted IP addresses with
+ their subnet mask as byte arrays.
+ @param ip The IP address.
+ @throws PkixNameConstraintValidatorException
+ if the IP is not permitted.
+ ip is included in the excluded ISet
+ excluded.
+
+ @param excluded A Set of excluded IP addresses with their
+ subnet mask as byte arrays.
+ @param ip The IP address.
+ @throws PkixNameConstraintValidatorException
+ if the IP is excluded.
+ email1 and email2 is
+ added to the union union. If email1 and
+ email2 have nothing in common they are added both.
+
+ @param email1 Email address constraint 1.
+ @param email2 Email address constraint 2.
+ @param union The union.
+ email1 and
+ email2 is added to the intersection intersect.
+
+ @param email1 Email address constraint 1.
+ @param email2 Email address constraint 2.
+ @param intersect The intersection.
+ name
+ name is
+ excluded.
+ ip1 with ip2. If ip1
+ is equal to ip2 0 is returned. If ip1 is bigger 1 is returned, -1
+ otherwise.
+
+ @param ip1 The first IP address.
+ @param ip2 The second IP address.
+ @return 0 if ip1 is equal to ip2, 1 if ip1 is bigger, -1 otherwise.
+ ip1 and
+ ip2.
+
+ @param ip1 The first IP address.
+ @param ip2 The second IP address.
+ @return The OR of ip1 and ip2.
+ (trustAnchors.isEmpty() == true)
+ @exception NullPointerException
+ if the specified Set is null
+ @exception ClassCastException
+ if any of the elements in the Set are not of type
+ java.security.cert.TrustAnchor
+ null, no constraints are defined.null)
+
+ @see #setTargetCertConstraints(CertSelector)
+ null)
+
+ @see #getTargetCertConstraints()
+ Set, which is
+ interpreted as meaning that any policy would be acceptable.
+
+ @return an immutable Set of initial policy OIDs in String
+ format, or an empty Set (implying any policy is
+ acceptable). Never returns null.
+
+ @see #setInitialPolicies(java.util.Set)
+ Set of initial policy identifiers (OID strings),
+ indicating that any one of these policies would be acceptable to the
+ certificate user for the purposes of certification path processing. By
+ default, any policy is acceptable (i.e. all policies), so a user that
+ wants to allow any policy as acceptable does not need to call this
+ method, or can call it with an empty Set (or
+ null).null)
+
+ @exception ClassCastException
+ if any of the elements in the set are not of type String
+
+ @see #getInitialPolicies()
+ List of additional certification path checkers. If
+ the specified List contains an object that is not a PKIXCertPathChecker,
+ it is ignored.PKIXCertPathChecker specified implements additional
+ checks on a certificate. Typically, these are checks to process and
+ verify private extensions contained in certificates. Each
+ PKIXCertPathChecker should be instantiated with any
+ initialization parameters needed to execute the check.CertPathValidator or CertPathBuilder. Each
+ of the specified PKIXCertPathCheckers will be called, in turn, by a PKIX
+ CertPathValidator or CertPathBuilder for
+ each certificate processed or validated.CertPathValidator or CertPathBuilder
+ must perform all of the required PKIX checks on each certificate. The one
+ exception to this rule is if the RevocationEnabled flag is set to false
+ (see the {@link #setRevocationEnabled(boolean) setRevocationEnabled}
+ method).java.security.cert.PKIXCertPathChecker
+ @see #getCertPathCheckers()
+ null)
+
+ @see #setCertPathCheckers(java.util.List)
+ PKIXCertPathChecker to the list of certification
+ path checkers. See the {@link #setCertPathCheckers setCertPathCheckers}
+ method for more details.
+
+ Note that the PKIXCertPathChecker is cloned to protect
+ against subsequent modifications.
PKIXCertPathChecker to add to the list of
+ checks. If null, the checker is ignored (not added to list).
+ Clone() under J2ME.
+ super.Clone() does not exist and fields are not copied.
+
+ @param params Parameters to set. If this are
+ ExtendedPkixParameters they are copied to.
+ false.
+
+ The IList is cloned.
+
stores is not
+ a {@link Store}.
+ + This method should be used to add local stores, like collection based + X.509 stores, if available. Local stores should be considered first, + before trying to use additional (remote) locations, because they do not + need possible additional network traffic. +
+ If store is null it is ignored.
+
+ You should not use this method. This method is used for adding additional + X.509 stores, which are used to add (remote) locations, e.g. LDAP, found + during X.509 object processing, e.g. in certificates or CRLs. This method + is used in PKIX certification path processing. +
+ If store is null it is ignored.
+
IList of additional Bouncy Castle
+ Stores used for finding CRLs, certificates, attribute
+ certificates or cross certificates.
+
+ @return an immutable IList of additional Bouncy Castle
+ Stores. Never null.
+
+ @see #addAddionalStore(Store)
+ IList of Bouncy Castle
+ Stores used for finding CRLs, certificates, attribute
+ certificates or cross certificates.
+
+ @return an immutable IList of Bouncy Castle
+ Stores. Never null.
+
+ @see #setStores(IList)
+ true if additional stores are used.
+ true if additional stores are used.
+ IX509Selector. If null, no constraints are
+ defined.
+
+ + The target certificate in a PKIX path may be a certificate or an + attribute certificate. +
+ Note that the IX509Selector returned is cloned to protect
+ against subsequent modifications.
+
IX509Selector specifying the constraints on the
+ target certificate or attribute certificate (or null)
+ @see #setTargetConstraints
+ @see X509CertStoreSelector
+ @see X509AttributeCertStoreSelector
+ IX509Selector. If null, no constraints are
+ defined.
+ + The target certificate in a PKIX path may be a certificate or an + attribute certificate. +
+ Note that the IX509Selector specified is cloned to protect
+ against subsequent modifications.
+
IX509Selector specifying the constraints on
+ the target certificate or attribute certificate (or
+ null)
+ @see #getTargetConstraints
+ @see X509CertStoreSelector
+ @see X509AttributeCertStoreSelector
+
+ The returned ISet consists of TrustAnchors.
+
+ The returned ISet is immutable. Never null
+
+ The trustedACIssuers must be a ISet of
+ TrustAnchor
+
+ The given set is cloned. +
+ + @param trustedACIssuers The trusted AC issuers to set. Is never +null.
+ @throws ClassCastException if an element of stores is not
+ a TrustAnchor.
+
+ The returned ISet is immutable and contains
+ Strings with the OIDs.
+
+ The ISet must contain Strings with the
+ OIDs.
+
+ The set is cloned. +
+ + @param necessaryACAttributes The necessary AC attributes to set. + @throws ClassCastException if an element of +necessaryACAttributes is not a
+ String.
+
+ The returned ISet is immutable and contains
+ Strings with the OIDs.
+
null.
+
+ The ISet must contain Strings with the
+ OIDs.
+
+ The set is cloned. +
+ + @param prohibitedACAttributes The prohibited AC attributes to set. + @throws ClassCastException if an element of +prohibitedACAttributes is not a
+ String.
+ null.
+
+ All elements in the ISet must a {@link PKIXAttrCertChecker}.
+
+ The given set is cloned. +
+ + @param attrCertCheckers The attribute certificate checkers to set. Is + nevernull.
+ @throws ClassCastException if an element of attrCertCheckers
+ is not a PKIXAttrCertChecker.
+ true if this reasons mask contains all possible
+ reasons.
+ + (i) If the distribution point name is present in the IDP CRL extension + and the distribution field is present in the DP, then verify that one of + the names in the IDP matches one of the names in the DP. If the + distribution point name is present in the IDP CRL extension and the + distribution field is omitted from the DP, then verify that one of the + names in the IDP matches one of the names in the cRLIssuer field of the + DP. +
++ (ii) If the onlyContainsUserCerts boolean is asserted in the IDP CRL + extension, verify that the certificate does not include the basic + constraints extension with the cA boolean asserted. +
++ (iii) If the onlyContainsCACerts boolean is asserted in the IDP CRL + extension, verify that the certificate includes the basic constraints + extension with the cA boolean asserted. +
++ (iv) Verify that the onlyContainsAttributeCerts boolean is not asserted. +
+ + @param dp The distribution point. + @param cert The certificate. + @param crl The CRL. + @throws AnnotatedException if one of the conditions is not met or an error occurs. +cert.
+ @throws AnnotatedException if one of the above conditions does not apply or an error
+ occurs.
+ cert.
+ @param cert The attribute certificate or certificate to check if it is
+ revoked.
+ @param defaultCRLSignCert The issuer certificate of the certificate cert.
+ @param defaultCRLSignKey The public key of the issuer certificate
+ defaultCRLSignCert.
+ @param paramsPKIX paramsPKIX PKIX parameters.
+ @param certPathCerts The certificates on the certification path.
+ @return A Set with all keys of possible CRL issuer
+ certificates.
+ @throws AnnotatedException if the CRL is not valid or the status cannot be checked or
+ some error occurs.
+ cert.
+
+ @param dp The distribution point to consider.
+ @param paramsPKIX PKIX parameters.
+ @param cert Certificate to check if it is revoked.
+ @param validDate The date when the certificate revocation status should be
+ checked.
+ @param defaultCRLSignCert The issuer certificate of the certificate cert.
+ @param defaultCRLSignKey The public key of the issuer certificate
+ defaultCRLSignCert.
+ @param certStatus The current certificate revocation status.
+ @param reasonMask The reasons mask which is already checked.
+ @param certPathCerts The certificates of the certification path.
+ @throws AnnotatedException if the certificate is revoked or the status cannot be checked
+ or some error occurs.
+ cert.
+ @param workingPublicKey The public key of the issuer certificate sign.
+ @param certPathCerts The certificates of the certification path.
+ @throws AnnotatedException if the certificate is revoked or the status cannot be checked
+ or some error occurs.
+ attrCert.
+ @param validDate The date when the certificate revocation status should
+ be checked.
+ @param certPathCerts The certificates of the certification path to be
+ checked.
+
+ @throws CertPathValidatorException if the certificate is revoked or the
+ status cannot be checked or some error occurs.
+ attrCert.
+
+ @param dp The distribution point to consider.
+ @param attrCert The attribute certificate which should be checked.
+ @param paramsPKIX PKIX parameters.
+ @param validDate The date when the certificate revocation status should
+ be checked.
+ @param issuerCert Certificate to check if it is revoked.
+ @param reasonMask The reasons mask which is already checked.
+ @param certPathCerts The certificates of the certification path to be
+ checked.
+ @throws Exception if the certificate is revoked or the status
+ cannot be checked or some error occurs.
+
+ NameConstraints ::= SEQUENCE {
+ permittedSubtrees [0] GeneralSubtrees OPTIONAL,
+ excludedSubtrees [1] GeneralSubtrees OPTIONAL }
+
+ GeneralSubtrees ::= SEQUENCE SIZE (1..MAX) OF GeneralSubtree
+
+ GeneralSubtree ::= SEQUENCE {
+ base GeneralName,
+ minimum [0] BaseDistance DEFAULT 0,
+ maximum [1] BaseDistance OPTIONAL }
+
+ BaseDistance ::= INTEGER (0..MAX)
+
+ 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}
+
+
+ Note that the name constraints byte array supplied is cloned to protect
+ against subsequent modifications.
+ + Name constraints are an optional parameter, and are intended to be used + as additional constraints when validating an X.509 certification path. +
+ The name constraints are specified as a byte array. This byte array + contains the DER encoded form of the name constraints, as they + would appear in the NameConstraints structure defined in RFC 2459 + and X.509. The ASN.1 notation for this structure is supplied in the + documentation for the other constructors. +
+ Note that the name constraints byte array supplied here is cloned to + protect against subsequent modifications. +
+TrustAnchor where the most-trusted
+ CA is specified as a distinguished name and public key. Name constraints
+ are an optional parameter, and are intended to be used as additional
+ constraints when validating an X.509 certification path.
+ TrustAnchor.
+ TrustAnchor+ If genTime is null a timeNotAvailable error response will be returned. + + @param request the request this response is for. + @param serialNumber serial number for the response token. + @param genTime generation time for the response token. + @param provider provider to use for signature calculation. + @return + @throws NoSuchAlgorithmException + @throws NoSuchProviderException + @throws TSPException +
++ To be valid the token must be signed by the passed in certificate and + the certificate must be the one referred to by the SigningCertificate + attribute included in the hashed attributes of the token. The + certificate must also have the ExtendedKeyUsageExtension with only + KeyPurposeID.IdKPTimeStamping and have been valid at the time the + timestamp was created. +
++ A successful call to validate means all the above are true. +
++ If a failure code is associated with the exception it can be retrieved using + the getFailureCode() method.
+buf at which the data is written.
+ @param len
+ the fixed length of data written (possibly padded with leading zeros).
+ + 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. +
++ 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. +
++ The exception extends InvalidCastException to enable users to have a single handling case, + only introducing specific handling of this one if required. +
+
+ 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
+ }
+
+
+ digestedObjectType can be one of the following:
+
otherObjectTypeID must not be empty.This cannot be used if a v1 attribute certificate is used.
+ + @param digestedObjectType The digest object type. + @param digestAlgorithm The algorithm identifier for the hash. + @param otherObjectTypeID The object type ID if +digestedObjectType is
+ otherObjectDigest.
+ @param objectDigest The hash value.
+ +
otherObjectTypeID must not be empty.null if no object
+ digest info is set.
+ null if no object digest info is set.
+ null if no object
+ digest info is set.
+ + Use this in preference to trying to recreate a principal from a string, not all + DNs are what they should be, so it's best to leave them encoded where they + can be.
+Selector like implementation to select
+ attribute certificates from a given set of criteria.
+
+ @see org.bouncycastle.x509.X509AttributeCertificate
+ @see org.bouncycastle.x509.X509Store
+ true if the object matches this selector.X509AttributeCertificate
+ must contain at least one of the specified target names.
+ + Each attribute certificate may contain a target information extension + limiting the servers where this attribute certificate can be used. If + this extension is not present, the attribute certificate is not targeted + and may be accepted by any server. +
+ + @param name The name as a GeneralName (notnull)
+ X509AttributeCertificate
+ must contain at least one of the specified target names.
+ + Each attribute certificate may contain a target information extension + limiting the servers where this attribute certificate can be used. If + this extension is not present, the attribute certificate is not targeted + and may be accepted by any server. +
+ + @param name a byte array containing the name in ASN.1 DER encoded form of a GeneralName + @throws IOException if a parsing error occurs. +null is
+ given any will do.
+ + The collection consists of either GeneralName objects or byte[] arrays representing + DER encoded GeneralName structures. +
+ + @param names A collection of target names. + @throws IOException if a parsing error occurs. + @see #AddTargetName(byte[]) + @see #AddTargetName(GeneralName) +Lists
+ made up of an Integer in the first entry and a DER encoded
+ byte array or a String in the second entry.
+ The returned collection is immutable.
+ + @return The collection of target names + @see #setTargetNames(Collection) +X509AttributeCertificate
+ must contain at least one of the specified target groups.
+ + Each attribute certificate may contain a target information extension + limiting the servers where this attribute certificate can be used. If + this extension is not present, the attribute certificate is not targeted + and may be accepted by any server. +
+ + @param group The group as GeneralName form (notnull)
+ X509AttributeCertificate
+ must contain at least one of the specified target groups.
+ + Each attribute certificate may contain a target information extension + limiting the servers where this attribute certificate can be used. If + this extension is not present, the attribute certificate is not targeted + and may be accepted by any server. +
+ + @param name a byte array containing the group in ASN.1 DER encoded form of a GeneralName + @throws IOException if a parsing error occurs. +null is
+ given any will do.
+
+ The collection consists of GeneralName objects or byte[]
+ representing DER encoded GeneralNames.
+
Lists
+ made up of an Integer in the first entry and a DER encoded
+ byte array or a String in the second entry.
+ The returned collection is immutable.
+ + @return The collection of target groups. + @see #setTargetGroups(Collection) +IX509Selector implementation to select
+ certificate pairs, which are e.g. used for cross certificates. The set of
+ criteria is given from two X509CertStoreSelector objects,
+ each of which, if present, must match the respective component of a pair.
+ X509CertificatePair, this method
+ returns false.
+ X509CertificatePair to be tested.
+ true if the object matches this selector.ISet of DerObjectIdentifier objects.
+ X509Stores.+ The collection is copied. +
+ICollection.ICollection of X509Name objects
+ null is specified, then no such
+ optional information is provided.
+
+ @param attrCert the IX509AttributeCertificate being checked (or
+ null)
+ @see #getAttrCertificateChecking()
+ true only complete CRLs are returned. Defaults to
+ false.
+
+ @return true if only complete CRLs are returned.
+ false.
+
+ @return Returns true if only CRLs with the delta CRL
+ indicator extension are selected.
+ + The issuing distribution point extension is a CRL extension which + identifies the scope and the distribution point of a CRL. The scope + contains among others information about revocation reasons contained in + the CRL. Delta CRLs and complete CRLs must have matching issuing + distribution points.
++ The byte array is cloned to protect against subsequent modifications.
++ You must also enable or disable this criteria with + {@link #setIssuingDistributionPointEnabled(bool)}.
+ + @param issuingDistributionPoint The issuing distribution point to set. + This is the DER encoded OCTET STRING extension value. + @see #getIssuingDistributionPoint() +false.
+ + You may also set the issuing distribution point criteria if not a missing + issuing distribution point should be assumed.
+ + @return Returns if the issuing distribution point check is enabled. +null.
+
+ @return Returns the maximum base CRL number.
+ @see #setMaxBaseCRLNumber(BigInteger)
+ + At the moment this will deal with "-----BEGIN CERTIFICATE-----" to "-----END CERTIFICATE-----" + base 64 encoded certs, as well as the BER binaries of certificates and some classes of PKCS#7 + objects.
+isIndirect
+ is false {@link #getCertificateIssuer()} will always
+ return null, previousCertificateIssuer is
+ ignored. If this isIndirect is specified and this CrlEntry
+ has no certificate issuer CRL entry extension
+ previousCertificateIssuer is returned by
+ {@link #getCertificateIssuer()}.
+
+ @param c
+ TbsCertificateList.CrlEntry object.
+ @param isIndirect
+ true if the corresponding CRL is a indirect
+ CRL.
+ @param previousCertificateIssuer
+ Certificate issuer of the previous CrlEntry.
+
+ 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) }
+
+ getValue. The complete checksum object can also be reset
+ so it can be used again with new data.
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Core;
+ using ICSharpCode.SharpZipLib.GZip;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using (Stream inStream = new GZipInputStream(File.OpenRead(args[0])))
+ using (FileStream outStream = File.Create(Path.GetFileNameWithoutExtension(args[0]))) {
+ byte[] buffer = new byte[4096];
+ StreamUtils.Copy(inStream, outStream, buffer);
+ }
+ }
+ }
+
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.GZip;
+ using ICSharpCode.SharpZipLib.Core;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using (Stream s = new GZipOutputStream(File.Create(args[0] + ".gz")))
+ using (FileStream fs = File.OpenRead(args[0])) {
+ byte[] writeData = new byte[4096];
+ Streamutils.Copy(s, fs, writeData);
+ }
+ }
+ }
+ }
+
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Core;
+ using ICSharpCode.SharpZipLib.LZW;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using (Stream inStream = new LzwInputStream(File.OpenRead(args[0])))
+ using (FileStream outStream = File.Create(Path.GetFileNameWithoutExtension(args[0]))) {
+ byte[] buffer = new byte[4096];
+ StreamUtils.Copy(inStream, outStream, buffer);
+ // OR
+ inStream.Read(buffer, 0, buffer.Length);
+ // now do something with the buffer
+ }
+ }
+ }
+
+ + You should never have a need to access this class directly. + TarBuffers are created by Tar IO Streams. +
++ TarEntries that are created from the header bytes read from + an archive are instantiated with the TarEntry( byte[] ) + constructor. These entries will be used when extracting from + or listing the contents of an archive. These entries have their + header filled in using the header bytes. They also set the File + to null, since they reference an archive entry not a file.
++ TarEntries that are created from files that are to be written + into an archive are instantiated with the CreateEntryFromFile(string) + pseudo constructor. These entries have their header filled in using + the File's information. They also keep a reference to the File + for convenience when writing entries.
++ Finally, TarEntries can be constructed from nothing but a name. + This allows the programmer to construct the entry by hand, for + instance when only an InputStream is available for writing to + the archive, and the header information is constructed from + other information. In this case the header fields are set to + defaults and the File is set to null.
+Read()
+ setInput(input, 0, input.length).
+ setDictionary(dict, 0, dict.Length).
+ NeedsInput()
+ returns true
+
+ strstart + DeflaterConstants.MAX_MATCH <= window.length.
+ prev[index & WMASK] points to the previous index that has the
+ same hash code as the string starting at index. This way
+ entries with the same hash code are in a linked list.
+ Note that the array should really be unsigned short, so you need
+ to and the values with 0xffff.
+ public Inflater(bool noHeader) passing true
+ if there is no Zlib header information
+
+ The usage is as following. First you have to set some input with
+ SetInput(), then Inflate() it. If inflate doesn't
+ inflate any bytes there may be three reasons:
+ SetInput().
+ NOTE: IsNeedingInput() also returns true when, the stream is finished.
+ SetDictionary().def.deflate() until all bytes from the input buffers
+ are processed.
+
+ using System;
+ using System.Text;
+ using System.Collections;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Zip;
+
+ class MainClass
+ {
+ static public void Main(string[] args)
+ {
+ using (ZipFile zFile = new ZipFile(args[0])) {
+ Console.WriteLine("Listing of : " + zFile.Name);
+ Console.WriteLine("");
+ Console.WriteLine("Raw Size Size Date Time Name");
+ Console.WriteLine("-------- -------- -------- ------ ---------");
+ foreach (ZipEntry e in zFile) {
+ if ( e.IsFile ) {
+ DateTime d = e.DateTime;
+ Console.WriteLine("{0, -10}{1, -10}{2} {3} {4}", e.Size, e.CompressedSize,
+ d.ToString("dd-MM-yy"), d.ToString("HH:mm"),
+ e.Name);
+ }
+ }
+ }
+ }
+ }
+
+
+ using System;
+ using System.Text;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Zip;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using ( ZipInputStream s = new ZipInputStream(File.OpenRead(args[0]))) {
+
+ ZipEntry theEntry;
+ const int size = 2048;
+ byte[] data = new byte[2048];
+
+ while ((theEntry = s.GetNextEntry()) != null) {
+ if ( entry.IsFile ) {
+ Console.Write("Show contents (y/n) ?");
+ if (Console.ReadLine() == "y") {
+ while (true) {
+ size = s.Read(data, 0, data.Length);
+ if (size > 0) {
+ Console.Write(new ASCIIEncoding().GetString(data, 0, size));
+ } else {
+ break;
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Core;
+ using ICSharpCode.SharpZipLib.Zip;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ string[] filenames = Directory.GetFiles(args[0]);
+ byte[] buffer = new byte[4096];
+
+ using ( ZipOutputStream s = new ZipOutputStream(File.Create(args[1])) ) {
+
+ s.SetLevel(9); // 0 - store only to 9 - means best compression
+
+ foreach (string file in filenames) {
+ ZipEntry entry = new ZipEntry(file);
+ s.PutNextEntry(entry);
+
+ using (FileStream fs = File.OpenRead(file)) {
+ StreamUtils.Copy(fs, s, buffer);
+ }
+ }
+ }
+ }
+ }
+
+ getValue. The complete checksum object can also be reset
+ so it can be used again with new data.
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Core;
+ using ICSharpCode.SharpZipLib.GZip;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using (Stream inStream = new GZipInputStream(File.OpenRead(args[0])))
+ using (FileStream outStream = File.Create(Path.GetFileNameWithoutExtension(args[0]))) {
+ byte[] buffer = new byte[4096];
+ StreamUtils.Copy(inStream, outStream, buffer);
+ }
+ }
+ }
+
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.GZip;
+ using ICSharpCode.SharpZipLib.Core;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using (Stream s = new GZipOutputStream(File.Create(args[0] + ".gz")))
+ using (FileStream fs = File.OpenRead(args[0])) {
+ byte[] writeData = new byte[4096];
+ Streamutils.Copy(s, fs, writeData);
+ }
+ }
+ }
+ }
+
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Core;
+ using ICSharpCode.SharpZipLib.LZW;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using (Stream inStream = new LzwInputStream(File.OpenRead(args[0])))
+ using (FileStream outStream = File.Create(Path.GetFileNameWithoutExtension(args[0]))) {
+ byte[] buffer = new byte[4096];
+ StreamUtils.Copy(inStream, outStream, buffer);
+ // OR
+ inStream.Read(buffer, 0, buffer.Length);
+ // now do something with the buffer
+ }
+ }
+ }
+
+ + You should never have a need to access this class directly. + TarBuffers are created by Tar IO Streams. +
++ TarEntries that are created from the header bytes read from + an archive are instantiated with the TarEntry( byte[] ) + constructor. These entries will be used when extracting from + or listing the contents of an archive. These entries have their + header filled in using the header bytes. They also set the File + to null, since they reference an archive entry not a file.
++ TarEntries that are created from files that are to be written + into an archive are instantiated with the CreateEntryFromFile(string) + pseudo constructor. These entries have their header filled in using + the File's information. They also keep a reference to the File + for convenience when writing entries.
++ Finally, TarEntries can be constructed from nothing but a name. + This allows the programmer to construct the entry by hand, for + instance when only an InputStream is available for writing to + the archive, and the header information is constructed from + other information. In this case the header fields are set to + defaults and the File is set to null.
+Read()
+ setInput(input, 0, input.length).
+ setDictionary(dict, 0, dict.Length).
+ NeedsInput()
+ returns true
+
+ strstart + DeflaterConstants.MAX_MATCH <= window.length.
+ prev[index & WMASK] points to the previous index that has the
+ same hash code as the string starting at index. This way
+ entries with the same hash code are in a linked list.
+ Note that the array should really be unsigned short, so you need
+ to and the values with 0xffff.
+ public Inflater(bool noHeader) passing true
+ if there is no Zlib header information
+
+ The usage is as following. First you have to set some input with
+ SetInput(), then Inflate() it. If inflate doesn't
+ inflate any bytes there may be three reasons:
+ SetInput().
+ NOTE: IsNeedingInput() also returns true when, the stream is finished.
+ SetDictionary().def.deflate() until all bytes from the input buffers
+ are processed.
+
+ using System;
+ using System.Text;
+ using System.Collections;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Zip;
+
+ class MainClass
+ {
+ static public void Main(string[] args)
+ {
+ using (ZipFile zFile = new ZipFile(args[0])) {
+ Console.WriteLine("Listing of : " + zFile.Name);
+ Console.WriteLine("");
+ Console.WriteLine("Raw Size Size Date Time Name");
+ Console.WriteLine("-------- -------- -------- ------ ---------");
+ foreach (ZipEntry e in zFile) {
+ if ( e.IsFile ) {
+ DateTime d = e.DateTime;
+ Console.WriteLine("{0, -10}{1, -10}{2} {3} {4}", e.Size, e.CompressedSize,
+ d.ToString("dd-MM-yy"), d.ToString("HH:mm"),
+ e.Name);
+ }
+ }
+ }
+ }
+ }
+
+
+ using System;
+ using System.Text;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Zip;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using ( ZipInputStream s = new ZipInputStream(File.OpenRead(args[0]))) {
+
+ ZipEntry theEntry;
+ const int size = 2048;
+ byte[] data = new byte[2048];
+
+ while ((theEntry = s.GetNextEntry()) != null) {
+ if ( entry.IsFile ) {
+ Console.Write("Show contents (y/n) ?");
+ if (Console.ReadLine() == "y") {
+ while (true) {
+ size = s.Read(data, 0, data.Length);
+ if (size > 0) {
+ Console.Write(new ASCIIEncoding().GetString(data, 0, size));
+ } else {
+ break;
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Core;
+ using ICSharpCode.SharpZipLib.Zip;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ string[] filenames = Directory.GetFiles(args[0]);
+ byte[] buffer = new byte[4096];
+
+ using ( ZipOutputStream s = new ZipOutputStream(File.Create(args[1])) ) {
+
+ s.SetLevel(9); // 0 - store only to 9 - means best compression
+
+ foreach (string file in filenames) {
+ ZipEntry entry = new ZipEntry(file);
+ s.PutNextEntry(entry);
+
+ using (FileStream fs = File.OpenRead(file)) {
+ StreamUtils.Copy(fs, s, buffer);
+ }
+ }
+ }
+ }
+ }
+
+ getValue. The complete checksum object can also be reset
+ so it can be used again with new data.
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Core;
+ using ICSharpCode.SharpZipLib.GZip;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using (Stream inStream = new GZipInputStream(File.OpenRead(args[0])))
+ using (FileStream outStream = File.Create(Path.GetFileNameWithoutExtension(args[0]))) {
+ byte[] buffer = new byte[4096];
+ StreamUtils.Copy(inStream, outStream, buffer);
+ }
+ }
+ }
+
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.GZip;
+ using ICSharpCode.SharpZipLib.Core;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using (Stream s = new GZipOutputStream(File.Create(args[0] + ".gz")))
+ using (FileStream fs = File.OpenRead(args[0])) {
+ byte[] writeData = new byte[4096];
+ Streamutils.Copy(s, fs, writeData);
+ }
+ }
+ }
+ }
+
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Core;
+ using ICSharpCode.SharpZipLib.LZW;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using (Stream inStream = new LzwInputStream(File.OpenRead(args[0])))
+ using (FileStream outStream = File.Create(Path.GetFileNameWithoutExtension(args[0]))) {
+ byte[] buffer = new byte[4096];
+ StreamUtils.Copy(inStream, outStream, buffer);
+ // OR
+ inStream.Read(buffer, 0, buffer.Length);
+ // now do something with the buffer
+ }
+ }
+ }
+
+ + You should never have a need to access this class directly. + TarBuffers are created by Tar IO Streams. +
++ TarEntries that are created from the header bytes read from + an archive are instantiated with the TarEntry( byte[] ) + constructor. These entries will be used when extracting from + or listing the contents of an archive. These entries have their + header filled in using the header bytes. They also set the File + to null, since they reference an archive entry not a file.
++ TarEntries that are created from files that are to be written + into an archive are instantiated with the CreateEntryFromFile(string) + pseudo constructor. These entries have their header filled in using + the File's information. They also keep a reference to the File + for convenience when writing entries.
++ Finally, TarEntries can be constructed from nothing but a name. + This allows the programmer to construct the entry by hand, for + instance when only an InputStream is available for writing to + the archive, and the header information is constructed from + other information. In this case the header fields are set to + defaults and the File is set to null.
+Read()
+ setInput(input, 0, input.length).
+ setDictionary(dict, 0, dict.Length).
+ NeedsInput()
+ returns true
+
+ strstart + DeflaterConstants.MAX_MATCH <= window.length.
+ prev[index & WMASK] points to the previous index that has the
+ same hash code as the string starting at index. This way
+ entries with the same hash code are in a linked list.
+ Note that the array should really be unsigned short, so you need
+ to and the values with 0xffff.
+ public Inflater(bool noHeader) passing true
+ if there is no Zlib header information
+
+ The usage is as following. First you have to set some input with
+ SetInput(), then Inflate() it. If inflate doesn't
+ inflate any bytes there may be three reasons:
+ SetInput().
+ NOTE: IsNeedingInput() also returns true when, the stream is finished.
+ SetDictionary().def.deflate() until all bytes from the input buffers
+ are processed.
+
+ using System;
+ using System.Text;
+ using System.Collections;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Zip;
+
+ class MainClass
+ {
+ static public void Main(string[] args)
+ {
+ using (ZipFile zFile = new ZipFile(args[0])) {
+ Console.WriteLine("Listing of : " + zFile.Name);
+ Console.WriteLine("");
+ Console.WriteLine("Raw Size Size Date Time Name");
+ Console.WriteLine("-------- -------- -------- ------ ---------");
+ foreach (ZipEntry e in zFile) {
+ if ( e.IsFile ) {
+ DateTime d = e.DateTime;
+ Console.WriteLine("{0, -10}{1, -10}{2} {3} {4}", e.Size, e.CompressedSize,
+ d.ToString("dd-MM-yy"), d.ToString("HH:mm"),
+ e.Name);
+ }
+ }
+ }
+ }
+ }
+
+
+ using System;
+ using System.Text;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Zip;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ using ( ZipInputStream s = new ZipInputStream(File.OpenRead(args[0]))) {
+
+ ZipEntry theEntry;
+ const int size = 2048;
+ byte[] data = new byte[2048];
+
+ while ((theEntry = s.GetNextEntry()) != null) {
+ if ( entry.IsFile ) {
+ Console.Write("Show contents (y/n) ?");
+ if (Console.ReadLine() == "y") {
+ while (true) {
+ size = s.Read(data, 0, data.Length);
+ if (size > 0) {
+ Console.Write(new ASCIIEncoding().GetString(data, 0, size));
+ } else {
+ break;
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+
+
+ using System;
+ using System.IO;
+
+ using ICSharpCode.SharpZipLib.Core;
+ using ICSharpCode.SharpZipLib.Zip;
+
+ class MainClass
+ {
+ public static void Main(string[] args)
+ {
+ string[] filenames = Directory.GetFiles(args[0]);
+ byte[] buffer = new byte[4096];
+
+ using ( ZipOutputStream s = new ZipOutputStream(File.Create(args[1])) ) {
+
+ s.SetLevel(9); // 0 - store only to 9 - means best compression
+
+ foreach (string file in filenames) {
+ ZipEntry entry = new ZipEntry(file);
+ s.PutNextEntry(entry);
+
+ using (FileStream fs = File.OpenRead(file)) {
+ StreamUtils.Copy(fs, s, buffer);
+ }
+ }
+ }
+ }
+ }
+
+