- 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) }
-
-
- [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })]
-
-
- [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })]
-
-
- [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })]
-
-
- [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })]
-
- text parameter as drawn with the font parameter.text parameter as drawn with the font parameter and the stringFormat parameter.text parameter as drawn with the font parameter.text parameter as drawn with the font parameter and the stringFormat parameter.text parameter as drawn with the font parameter and the stringFormat parameter.text parameter as drawn with the font parameter.text parameter as drawn with the font parameter and the stringFormat parameter.text parameter as drawn with the font parameter and the stringFormat parameter.text parameter as drawn with the font parameter.text parameter as drawn with the font parameter and the stringFormat parameter.text parameter as drawn with the font parameter and the stringFormat parameter.text parameter as drawn with the font parameter.text parameter as drawn with the font parameter and the stringFormat parameter.filePath.true to get the false to get the false.
+ null if an icon can't be found with the specified id.makePdf, assertPdf and comparePdf methods.
- @return
- comparePdf method.
- @return
- null if the field does not exist
- null.
- @param fieldName the field name
- @return the list of export option values from fields of type list or combo
- null.
- @param fieldName the field name
- @return the list of export option values from fields of type list or combo
- true if the renaming was successful, false
- otherwise
- true if the field was found and changed,
- false otherwise
- true if the field was found and changed,
- false otherwise
- true if the field was found and changed,
- false otherwise
- null
- the value parameter will be used
- @return true if the field was found and changed,
- false otherwise
- @throws IOException on error
- @throws DocumentException on error
- null
- the value parameter will be used
- @param saveAppearance save the current appearance of the field or not
- @return true if the field was found and changed,
- false otherwise
- @throws IOException on error
- @throws DocumentException on error
- AcroFields.Item.
- @return all the fields
- null if the field
- does not exist
- float
- multiple of 5. For each of this groups the values are: [page, llx, lly, urx,
- ury]. The coordinates have the page rotation in consideration.
- @param name the field name
- @return the positions or null if field does not exist
- page.
- @param page the page to remove the fields from
- @return true if any field was removed, false otherwise
- name are removed from the document otherwise only the fields in
- that particular page are removed.
- @param name the field name
- @param page the page to remove the field from or -1 to remove it from all the pages
- @return true if the field exists, false otherwise
- true if the field exists, false otherwise
- true.
- @param generateAppearances the option to generate appearances
- writeToAll constant.
-
- @since 2.1.5
- writeToAll and markUsed constant.
-
- @since 2.1.5
- writeToAll and markUsed constant.
-
- @since 2.1.5
- writeFlags setting
-
- @since 2.1.5
-
- @param key you'll never guess what this is for.
- @param value if value is null, the key will be removed
- @param writeFlags ORed together WRITE_* flags
- PdfDictionary where the value tag /V
- is present.
-
- PdfDictionary with the widgets.
-
- PdfDictionary with the widget references.
-
- PdfDictionary with all the field
- and widget tags merged.
-
- Integer with the page numbers where
- the widgets are displayed.
-
- Integer with the tab order of the field in the page.
-
- null if the field is not
- a signature
- null if the field is not found
- true if the signature covers the entire document,
- false otherwise
- field revision.
- @param field the signature field name
- @return the revision or zero if it's not a signature field
- Stream covering the revision. Returns null if
- it's not a signature field
- @throws IOException on error
- BaseFont and can also be null. The fonts in this list will be used if the original
- font doesn't contain the needed glyphs.
- @param substitutionFonts the list
- null if the field is not a pushbutton
- null if the field is not a pushbutton
- PdfFormField representing the pushbutton
- @return true if the field was replaced, false if the field
- was not a pushbutton
- PdfFormField representing the pushbutton
- @param order the field order in fields with same name
- @return true if the field was replaced, false if the field
- was not a pushbutton
- int from an Stream.
-
- @param is an Stream
- @return the value of an int
- word from an Stream.
-
- @param is an Stream
- @return the value of an int
- String from an Stream.
-
- @param is an Stream
- @return the value of an int
- SeekableStream.
- TIFFDirectory.
- TIFFDirectory.
- - 1 = MSB-to-LSB - 2 = LSB-to-MSB (flipped) --
Image
- Image
- Image
- newString to the end of oldString.
- expandCode added by Robin Luiten
- The strLen_ table to give quick access to the lenght of an expanded
- code for use by the expandCode method added by Robin.
-
- A dictionary + Lang, Alt, ActualText, E).
- @param key
- @return
- A dictionary + Lang, Alt, ActualText, E).
- @param key
- @param value
- PdfAnnotation or a PdfFormField
- to the document. Only the top parent of a PdfFormField
- needs to be added.
- @param annot the PdfAnnotation or the PdfFormField to add
- PdfAnnotation
- to the calculation order array.
- @param annot the PdfAnnotation to be added
- action will be
- invoked.
- @param action the action to be invoked
- DOCUMENT_CLOSE,
- WILL_SAVE, DID_SAVE, WILL_PRINT
- and DID_PRINT.
-
- @param actionType the action type
- @param action the action to execute in response to the trigger
- @throws DocumentException on invalid action type
- PdfWriter.PAGE_OPEN
- or PdfWriter.PAGE_CLOSE
- @param action the action to perform
- @throws DocumentException if the action type is invalid
- true if the PDF has to be in conformance with any of the PDF ISO specifications
- PdfObject.
-
- @see PdfException
- @see PdfBoolean
- @see PdfNumber
- @see PdfString
- @see PdfName
- @see PdfDictionary
- @see PdfFont
- null if no text.
- Element.ALIGN_LEFT,
- Element.ALIGN_CENTER or Element.ALIGN_RIGHT.
- null if no text.
- @return the text font. null if no text
- Element.ALIGN_LEFT,
- Element.ALIGN_CENTER or Element.ALIGN_RIGHT.
- @return the text alignment
- PdfContentByte to create the template. It
- serves no other use
- @param barColor the color of the bars. It can be null
- @param textColor the color of the text. It can be null
- @return the template
- @see #placeBarcode(PdfContentByte cb, BaseColor barColor, BaseColor textColor)
- Image with the barcode.
- @param cb the PdfContentByte to create the Image. It
- serves no other use
- @param barColor the color of the bars. It can be null
- @param textColor the color of the text. It can be null
- @return the Image
- @see #placeBarcode(PdfContentByte cb, BaseColor barColor, BaseColor textColor)
- true if the next numDigits
- starting from index textIndex are numeric skipping any FNC1.
- @param text the text to check
- @param textIndex where to check from
- @param numDigits the number of digits to check
- @return the check result
- true if it is an UCC/EAN-128. In this case
- the character FNC1 is added
- @param codeSet forced code set, or AUTO for optimized barcode.
- @return the code ready to be fed to getBarsCode128Raw()
- true if it is an UCC/EAN-128. In this case
- the character FNC1 is added
- @return the code ready to be fed to getBarsCode128Raw()
-
- x = 0.8f;
- n = 2;
- font = BaseFont.CreateFont("Helvetica", "winansi", false);
- size = 8;
- baseline = size;
- barHeight = size * 3;
- textint= Element.ALIGN_CENTER;
- generateChecksum = false;
- checksumText = false;
- startStopText = true;
- extended = false;
-
-
- @author Paulo Soares
- BARS.
-
- x = 0.8f;
- n = 2;
- font = BaseFont.CreateFont("Helvetica", "winansi", false);
- size = 8;
- baseline = size;
- barHeight = size * 3;
- textAlignment = Element.ALIGN_CENTER;
- generateChecksum = false;
- checksumText = false;
- startStopText = false;
-
-
- @author Paulo Soares
- BARS.
- Image with the barcode. A successful call to the method generate()
- before calling this method is required.
- @return the barcode Image
- @throws BadElementException on error
- java.awt.Image. A successful call to the method generate()
- before calling this method is required.
- @param foreground the color of the bars
- @param background the color of the background
- @return the image
-
- x = 0.8f;
- font = BaseFont.CreateFont("Helvetica", "winansi", false);
- size = 8;
- baseline = size;
- barHeight = size * 3;
- guardBars = true;
- codeType = EAN13;
- code = "";
-
-
- @author Paulo Soares
- null is returned.
- @param text the code to convert. It must have 12 numeric characters
- @return the 8 converted digits or null if the
- code could not be converted
-
- x = 0.8f;
- n = 2;
- font = BaseFont.CreateFont("Helvetica", "winansi", false);
- size = 8;
- baseline = size;
- barHeight = size * 3;
- textint= Element.ALIGN_CENTER;
- generateChecksum = false;
- checksumText = false;
-
-
- @author Paulo Soares
- text.
- @param text the text
- @return a string with only numeric characters
- Image or a raw bitmap.
- @author Paulo Soares
- aspectRatio and yHeight.
- codeColumns*codeRows.
- codeColumns
- with a variable number of codeRows.
- codeRows
- with a variable number of codeColumns.
- text interpretation is done and the content of codewords
- is used directly.
- BarcodePDF417 with the default settings.
- PDF417_USE_ASPECT_RATIO
- and PDF417_AUTO_ERROR_LEVEL.
- Image with the barcode. The image will have to be
- scaled in the Y direction by yHeightfor the barcode
- to have the right printing aspect.
- @return the barcode Image
- @throws BadElementException on error
- yHeight.
- @return The raw barcode image
- outBits.
- @return the number of X pixels of outBits
- outBits.
- It is also the number of rows in the barcode.
- @return the number of Y pixels of outBits
- Sets the number of barcode rows. This number may be changed
- to keep the barcode valid.
- @param codeRows the number of barcode rows
- PDF417_USE_RAW_CODEWORDS
- is set.
- @return the codeword array
- PDF417_* constants.
- @param options the options to generate the barcode
- - n = 72f / 22f; // distance between bars - x = 0.02f * 72f; // bar width - barHeight = 0.125f * 72f; // height of the tall bars - size = 0.05f * 72f; // height of the short bars - codeType = POSTNET; // type of code -- - @author Paulo Soares -
Image with the barcode.
- @return the barcode Image
- @throws BadElementException on error
- EDIT flag set.
- TextField.
- @param writer the document PdfWriter
- @param box the field location and dimensions
- @param fieldName the field name. If null only the widget keys
- will be included in the field allowing it to be used as a kid field.
- null.
- @param borderWidth the border width in points
- PdfBorderDictionary
- and can be STYLE_SOLID, STYLE_DASHED,
- STYLE_BEVELED, STYLE_INSET and
- STYLE_UNDERLINE.
- @param borderStyle the border style
- null to remove
- the border.
- @param borderColor the border color
- null for
- transparent background.
- @param backgroundColor the background color
- null the color used
- will be black.
- @param textColor the text color
- null then Helvetica
- will be used.
- @param font the text font
- Element.ALIGN_LEFT,
- Element.ALIGN_CENTER and Element.ALIGN_RIGHT.
- @param alignment the text horizontal alignment
- VISIBLE, HIDDEN, VISIBLE_BUT_DOES_NOT_PRINT
- and HIDDEN_BUT_PRINTABLE.
- @param visibility field visibility flag
- null only the widget keys
- will be included in the field allowing it to be used as a kid field.
- READ_ONLY, REQUIRED,
- MULTILINE, DO_NOT_SCROLL,
- PASSWORD, FILE_SELECTION,
- DO_NOT_SPELL_CHECK and EDIT.
- @param options the option flags
- from to to. The moved keys
- are removed from from.
- @param from the source
- @param to the destination. It may be null
- encoding is only used to map a char to the position inside
- the font, not to the expected char name.
- char directly to byte
- by casting.
- true if the writing mode is vertical for the given font, false otherwise.
- widths and the differences arrays
- @throws UnsupportedEncodingException the encoding is not supported
- c
- or the name. If the name is null it's a symbolic font.
- @param c the unicode char
- @param name the glyph name
- @return the width of the char
- true if the kerning was applied, false otherwise
- char in normalized 1000 units.
- @param char1 the unicode char to get the width of
- @return the width in normalized 1000 units
- string in normalized 1000 units.
- @param text the string to get the witdth of
- @return the width in normalized 1000 units
- String in normalized 1000 units. The descent will always be
- less than or equal to zero even if all the characters have an higher descent.
- @param text the String to get the descent of
- @return the dexcent in normalized 1000 units
- String in normalized 1000 units. The ascent will always be
- greater than or equal to zero even if all the characters have a lower ascent.
- @param text the String to get the ascent of
- @return the ascent in normalized 1000 units
- String in points. The descent will always be
- less than or equal to zero even if all the characters have an higher descent.
- @param text the String to get the descent of
- @param fontSize the size of the font
- @return the dexcent in points
- String in points. The ascent will always be
- greater than or equal to zero even if all the characters have a lower ascent.
- @param text the String to get the ascent of
- @param fontSize the size of the font
- @return the ascent in points
- String in points taking kerning
- into account.
- @param text the String to get the witdth of
- @param fontSize the font size
- @return the width in points
- string in points.
- @param text the string to get the witdth of
- @param fontSize the font size
- @return the width in points
- char in points.
- @param char1 the char to get the witdth of
- @param fontSize the font size
- @return the width in points
- string into byte[].
- @return the encoding name
- key. Valid values
- for key are ASCENT, CAPHEIGHT, DESCENT,
- ITALICANGLE, BBOXLLX, BBOXLLY, BBOXURX
- and BBOXURY.
- @param key the parameter to be extracted
- @param fontSize the font size in points
- @return the parameter in points
- key. Valid values
- for key are ASCENT, CAPHEIGHT, DESCENT,
- ITALICANGLE, BBOXLLX, BBOXLLY, BBOXURX
- and BBOXURY.
- @param key the parameter to be updated
- @param value the parameter value
- true if the font is embedded.
- true if the font is symbolic
- byte array
- @throws DocumentException on error
- @throws IOException on error
- @return the postscript font names
- true to force the generation of the
- widths array.
- @param forceWidthsOutput true to force the generation of the
- widths array
- char directly to byte
- by casting. This is a low level feature to put the bytes directly in
- the content stream without passing through string.GetBytes().
- @param directTextToByte New value of property directTextToByte.
- true
- only the glyphs used will be included in the font. When set to false
- and {@link #addSubsetRange(int[])} was not called the full font will be included
- otherwise just the characters ranges will be included.
- @param subset new value of property subset
- true if the font has any kerning pairs
- true if the character has a glyph,
- false otherwise
- true if the advance was set,
- false otherwise
- ArrayList
- contains a Object[]{String,PRIndirectReference} with the font name
- and the indirect reference to it.
- @param reader the document where the fonts are to be listed from
- @return the list of fonts and references
- ArrayList
- contains a Object[]{String,PRIndirectReference} with the font name
- and the indirect reference to it.
- @param reader the document where the fonts are to be listed from
- @param page the page to list the fonts from
- @return the list of fonts and references
- null if the font has not the information or the character has no
- contours, as in the case of the space, for example. Characters with no contours may
- also return [0,0,0,0].
- @param c the character to get the contour bounding box from
- @return an array of four floats with the bounding box in the format [llx,lly,urx,ury] or
- null
- null
- int array
- where the first element is the start range inclusive and the second element is the
- end range inclusive. Several ranges are allowed in the same array.
- @param range the character range
- StringBuilder but works with byte arrays.
- floating point is converted to a format suitable to the PDF.
- @author Paulo Soares
- true always output floating point numbers with 6 decimal digits.
- If false uses the faster, although less precise, representation.
- int. The size of the array will grow by one.
- @param b the int to be appended
- @return a reference to this ByteBuffer object
- byte array. The buffer will grow by
- len bytes.
- @param b the array to be appended
- @param off the offset to the start of the array
- @param len the length of bytes to Append
- @return a reference to this ByteBuffer object
- ByteBuffer object
- string to the buffer. The string is
- converted according to the encoding ISO-8859-1.
- @param str the string to be appended
- @return a reference to this ByteBuffer object
- char to the buffer. The char is
- converted according to the encoding ISO-8859-1.
- @param c the char to be appended
- @return a reference to this ByteBuffer object
- ByteBuffer to this buffer.
- @param buf the ByteBuffer to be appended
- @return a reference to this ByteBuffer object
- int.
- @param i the int to be appended
- @return a reference to this ByteBuffer object
- long.
- @param i the long to be appended
- @return a reference to this ByteBuffer object
- float according
- to the Pdf conventions.
- @param i the float to be appended
- @return a reference to this ByteBuffer object
- double according
- to the Pdf conventions.
- @param d the double to be appended
- @return a reference to this ByteBuffer object
- double into a format suitable for the PDF.
- @param d a double
- @return the string representation of the double
- double into a format suitable for the PDF.
- @param d a double
- @param buf a ByteBuffer
- @return the String representation of the double if
- buf is null. If buf is not null,
- then the double is appended directly to the buffer and this methods returns null.
- count field, which is the number of valid bytes in this byte buffer.
- out.Write(buf, 0, count).
-
- @param out the output stream to which to write the data.
- @exception IOException if an I/O error occurs.
- false. CJK font and not embedded
- @throws DocumentException on error
- @throws IOException on error
- true if it is CJK font
- char in normalized 1000 units.
- @param char1 the unicode char to get the width of
- @return the width in normalized 1000 units
- key. Valid values
- for key are ASCENT, CAPHEIGHT, DESCENT
- and ITALICANGLE.
- @param key the parameter to be extracted
- @param fontSize the font size in points
- @return the parameter in points
- decode instead.
- PDfSpotColor
- SpotColor object.
- @return the PdfSpotColor
- PdfContent where the text will be written to.
- ColumnText.
- @param text the place where the text will be written to. Can
- be a template.
- org.
- @param org the original ColumnText
- @return the duplicated
- org.
- @param org the original ColumnText
- @return itself
- Phrase to the current text array.
- @param phrase the text
- Phrase.
- Anything added previously with AddElement() is lost.
- @param phrase the text
- Chunk to the current text array.
- Will not have any effect if AddElement() was called before.
- @param chunk the text
- yLine and the column. It will
- set the lineStatus apropriatly.
- @param wall the column to intersect
- @return the x coordinate of the intersection
- yLine and the two
- column bounds. It will set the lineStatus apropriatly.
- @return a float[2]with the x coordinates of the intersection
- yLine,
- the yLine-leadingand the two
- column bounds. It will set the lineStatus apropriatly.
- @return a float[4]with the x coordinates of the intersection
- float[] with the line points [x1,y1,x2,y2,...].
- The array must have at least 4 elements.
- @param leftLine the left column bound
- @param rightLine the right column bound
- Phrase
- @param llx the lower left x corner
- @param lly the lower left y corner
- @param urx the upper right x corner
- @param ury the upper right y corner
- @param leading the leading
- @param alignment the column alignment
- go(false).
- @return returns the result of the operation. It can be NO_MORE_TEXT
- and/or NO_MORE_COLUMN
- @throws DocumentException on error
- true to simulate the writting to the document
- @return returns the result of the operation. It can be NO_MORE_TEXT
- and/or NO_MORE_COLUMN
- @throws DocumentException on error
- go() will always return
- NO_MORE_TEXT.
- Phrase containing the line
- @param runDirection the run direction
- @param arabicOptions the options for the arabic shaping
- @return the width of the line
- Phrase containing the line
- @return the width of the line
- Phrase with the text
- @param x the x reference position
- @param y the y reference position
- @param rotation the rotation to be applied in degrees counterclockwise
- @param runDirection the run direction
- @param arabicOptions the options for the arabic shaping
- Phrase with the text
- @param x the x reference position
- @param y the y reference position
- @param rotation the rotation to be applied in degrees counterclockwise
- filledWidth if greater than the existing one.
- @param w the new filledWidth if greater than the existing one
- true by default but can be changed if several objects are to be placed one
- after the other in the same column calling go() several times.
- @param adjustFirstLine true to adjust the first line, false otherwise
- key. Valid values
- for key are ASCENT, CAPHEIGHT, DESCENT,
- ITALICANGLE, BBOXLLX, BBOXLLY, BBOXURX
- and BBOXURY.
- @param key the parameter to be extracted
- @param fontSize the font size in points
- @return the parameter in points
-
- c
- or the name. If the name is null it's a symbolic font.
- @param c the unicode char
- @param name the glyph name
- @return the width of the char
-
- true if the font has any kerning pairs
-
- char in normalized 1000 units.
- @param char1 the unicode char to get the width of
- @return the width in normalized 1000 units
- - In the first step, only in1, in2,in3 and tag are used. - After the collections of the index entries, pagenumbers are used. -
-PdfWriter for this document
- @param document
- the document
- PdfWriter for this document
- @param document
- the document
- InputStream containing the document. The stream is read to the
- end but is not closed
- @throws IOException on error
- PdfDictionary
- with the field content.
- @return all the fields
- null if the field does not
- exist or has no value defined.
- @param name the fully qualified field name
- @return the field value or null
- true if the field was found and removed,
- false otherwise
- PdfObject.
- @return a map with all the fields
- null if not found
- true if the value was inserted,
- false if the name is incompatible with
- an existing field
- true if the value was inserted,
- false if the name is incompatible with
- an existing field
- PDFAction.
- For example, this method allows setting a form submit button action using {@link PdfAction#createSubmitForm(String, Object[], int)}.
- This method creates an A entry for the specified field in the underlying FDF file.
- Method contributed by Philippe Laflamme (plaflamme)
- @param field the fully qualified field name
- @param action the field's action
- @return true if the value was inserted,
- false if the name is incompatible with
- an existing field
- @since 2.1.5
- FdfReader
- @param fdf the FdfReader
- PdfReader
- @param pdf the PdfReader
- AcroFields
- @param acro the AcroFields
- TrueTypeFontUnicode
- true if the font is symbolic
- BaseFont
- BaseFont of this font.
- @return the BaseFont of this font
- PdfWriter of this document
- false
- to include all.
- @param subset new value of property subset
- Font to be searched for valid characters.
- @param font the Font
- Phrase with one or more chunks
- Chunk.
- @param lang the language ("en" for english, for example)
- @param country the country ("GB" for Great-Britain or "none" for no country, for example)
- @param leftMin the minimun number of letters before the hyphen
- @param rightMin the minimun number of letters after the hyphen
- getHyphenatedWordPost().
- @param word the word to hyphenate
- @param font the font used by this word
- @param fontSize the font size used by this word
- @param remainingWidth the width available to fit this word in
- @return the first part of the hyphenated word including
- the hyphen symbol, if any
- getHyphenatedWordPre().
- @return the second part of the hyphenated word
- A ternary search tree is a hibrid between a binary tree and - a digital search tree (trie). Keys are limited to strings. - A data value of type char is stored in each leaf node. - It can be used as an index (or pointer) to the data. - Branches that only contain one key are compressed to one node - by storing a pointer to the trailer substring of the key. - This class is intended to serve as base class or helper class - to implement Dictionary collections or the like. Ternary trees - have some nice properties as the following: the tree can be - traversed in sorted order, partial matches (wildcard) can be - implemented, retrieval of all keys within a given distance - from the target, etc. The storage requirements are higher than - a binary tree but a lot less than a trie. Performance is - comparable with a hash table, sometimes it outperforms a hash - function (most of the time can determine a miss faster than a hash).
- -The main purpose of this java port is to serve as a base for - implementing TeX's hyphenation algorithm (see The TeXBook, - appendix H). Each language requires from 5000 to 15000 hyphenation - patterns which will be keys in this tree. The strings patterns - are usually small (from 2 to 5 characters), but each char in the - tree is stored in a node. Thus memory usage is the main concern. - We will sacrify 'elegance' to keep memory requirenments to the - minimum. Using java's char type as pointer (yes, I know pointer - it is a forbidden word in java) we can keep the size of the node - to be just 8 bytes (3 pointers and the data char). This gives - room for about 65000 nodes. In my tests the english patterns - took 7694 nodes and the german patterns 10055 nodes, - so I think we are safe.
- -All said, this is a map with strings as keys and char as value. - Pretty limited!. It can be extended to a general map by - using the string representation of an object and using the - char value as an index to an array that contains the object - values.
- - @author cav@uniscope.co.jp -The character stored in this node: splitchar - Two special values are reserved:
-This shouldn't be a problem if we give the usual semantics to - strings since 0xFFFF is garanteed not to be an Unicode character.
-PdfEncoding.
- @author Paulo Soares
- null if no conversion is supported
- null if no conversion is supported
- null if no conversion is supported
- Chunk to hyphenate a word.
-
- @author Paulo Soares
- getHyphenatedWordPost().
- @param word the word to hyphenate
- @param font the font used by this word
- @param fontSize the font size used by this word
- @param remainingWidth the width available to fit this word in
- @return the first part of the hyphenated word including
- the hyphen symbol, if any
- getHyphenatedWordPre().
- @return the second part of the hyphenated word
- PdfIndirectReference that represents this layer.
- @return the PdfIndirectReference that represents this layer
- PdfWriter for this document
- @param document the document
-
- Note that if even if a page is not written this method is still
- called. It is preferable to use onEndPage to avoid
- infinite loops.
-
- Note that this method isn't called for the first page. You should apply modifications for the first - page either before opening the document or by using the onOpenDocument() method. -
- - @param writer thePdfWriter for this document
- @param document the document
- PdfWriter for this document
- @param document the document
- PdfPTable.
-
- @author Paulo Soares
- newstring to the end of oldstring.
- (x, y).
- (x, y).
- (x3, y3).
- (x3, y3) with the note that the current
- point represents two control points.
- (x3, y3) with the note that the (x3, y3)
- point represents two control points.
- null otherwise.
- int value which is either {@link #NO_OP} or one of possible
- combinations of {@link #STROKE} and {@link #FILL}
- int value.
- @param close Indicates whether the path should be closed or not.
- @since 5.5.6
- true if this subpath contains only one point and it is not closed,
- false otherwise
- bool value indicating whether the subpath must be closed or not.
- Ignore this value if the subpath is a rectangle because in this case it is already closed
- (of course if you paint the path using re operator)
-
- @return bool value indicating whether the path must be closed or not.
- @since 5.5.6
- bool indicating whether the subpath is degenerate or not.
- A degenerate subpath is the subpath consisting of a single-point closed path or of
- two or more points at the same coordinates.
-
- @return bool value indicating whether the path is degenerate or not.
- @since 5.5.6
- PdfAction defines an action that can be triggered from a PDF file.
-
- @see PdfDictionary
- PdfAction of Subtype URI.
-
- @param url the Url to go to
- PdfAction of Subtype URI.
-
- @param url the url to go to
- PdfAction of Subtype GoTo.
- @param destination the destination to go to
- PdfAction of Subtype GoToR.
- @param filename the file name to go to
- @param name the named destination to go to
- PdfAction of Subtype GoToR.
- @param filename the file name to go to
- @param page the page destination to go to
- null.
- @param operation (Windows-specific) the operation to perform: "open" - Open a document,
- "print" - Print a document.
- It can be null.
- @param defaultDir (Windows-specific) the default directory in standard DOS syntax.
- It can be null.
- null.
- @param operation (Windows-specific) the operation to perform: "open" - Open a document,
- "print" - Print a document.
- It can be null.
- @param defaultDir (Windows-specific) the default directory in standard DOS syntax.
- It can be null.
- @return a Launch action
- true, if false the current document is replaced by the new document.
- @return a GoToR action
- PdfAnnotation is a note that is associated with a page.
-
- @see PdfDictionary
- PdfAnnotation of subtype text.
- PdfAnnotation of subtype link (Action).
- PdfWriter
- @param rect the dimensions in the page of the annotation
- @param contents the file description
- @param fileStore an array with the file. If it's null
- the file will be read from the disk
- @param file the path to the file. It will only be used if
- fileStore is not null
- @param fileDisplay the actual file name stored in the pdf
- @throws IOException on error
- @return the annotation
- HIGHLIGHT_NONE, HIGHLIGHT_INVERT,
- HIGHLIGHT_OUTLINE and HIGHLIGHT_PUSH;
- @param highlight the annotation's highlighting mode
-
- String[] files = new String[] {"input1.pdf", "input2.pdf"};
- String outputFile = "output.pdf";
- int firstPage=1;
- Document document = new Document();
- PdfWriter writer = PdfWriter.GetInstance(document, new FileOutputStream(outputFile));
- document.SetPageSize(PageSize.A4);
- float W = PageSize.A4.GetWidth() / 2;
- float H = PageSize.A4.GetHeight() / 2;
- document.Open();
- PdfContentByte cb = writer.GetDirectContent();
- for (int i = 0; i < files.length; i++) {
- PdfReader currentReader = new PdfReader(files[i]);
- currentReader.ConsolidateNamedDestinations();
- for (int page = 1; page <= currentReader.GetNumberOfPages(); page++) {
- PdfImportedPage importedPage = writer.GetImportedPage(currentReader, page);
- float a = 0.5f;
- float e = (page % 2 == 0) ? W : 0;
- float f = (page % 4 == 1 || page % 4 == 2) ? H : 0;
- ArrayList links = currentReader.GetLinks(page);
- cb.AddTemplate(importedPage, a, 0, 0, a, e, f);
- for (int j = 0; j < links.Size(); j++) {
- PdfAnnotation.PdfImportedLink link = (PdfAnnotation.PdfImportedLink)links.Get(j);
- if (link.IsInternal()) {
- int dPage = link.GetDestinationPage();
- int newDestPage = (dPage-1)/4 + firstPage;
- float ee = (dPage % 2 == 0) ? W : 0;
- float ff = (dPage % 4 == 1 || dPage % 4 == 2) ? H : 0;
- link.SetDestinationPage(newDestPage);
- link.TransformDestination(a, 0, 0, a, ee, ff);
- }
- link.TransformRect(a, 0, 0, a, e, f);
- writer.AddAnnotation(link.CreateAnnotation(writer));
- }
- if (page % 4 == 0)
- document.NewPage();
- }
- if (i < files.length - 1)
- document.NewPage();
- firstPage += (currentReader.GetNumberOfPages()+3)/4;
- }
- document.Close();
-
- PdfAppearance.
- PdfWriter
- PdfArray-object.
- PdfArray-object, containing 1 PdfObject.
-
- @param object a PdfObject that has to be added to the array
- PdfArray-object, containing all the PdfObjects in a given PdfArray.
-
- @param array a PdfArray that has to be added to the array
- PdfArray.
-
- @return an array of bytes
- PdfObject with the specified index.
-
- A possible indirect references is not resolved, so the returned
- PdfObject may be either a direct object or an indirect
- reference, depending on how the object is stored in the
- PdfArray.
-
- @param idx The index of the PdfObject to be returned
- @return A PdfObject
- PdfObjects.
-
- @return an ArrayList
- true if the array is empty.
-
- @return true if the array is empty
- @since 2.1.5
- PdfObject to the PdfArray.
-
- @param object PdfObject to add
- @return true
- PdfObject at the beginning of the
- PdfArray.
-
- The PdfObject will be the first element, any other elements
- will be shifted to the right (adds one to their indices).
-
- @param object The PdfObject to add
- PdfArray already contains a certain PdfObject.
-
- @param object PdfObject to check
- @return true
- PdfBoolean
- PdfBoolean
- PdfBoolean-object.
-
- @param value the value of the new PdfObject
- PdfBoolean-object.
-
- @param value the value of the new PdfObject, represented as a string
-
- @throws BadPdfFormatException thrown if the value isn't 'true' or 'false'
- PdfBoolean-object.
-
- @return the actual value of the object.
- PdfBorderArray defines the border of a PdfAnnotation.
-
- @see PdfArray
- PdfBorderArray.
- PdfBorderArray.
- PdfBorderDictionary define the appearance of a Border (Annotations).
-
- @see PdfDictionary
- PdfBorderDictionary.
- attributes.
- noStroke.
- PdfChunk.
- true if the chunk split was cause by a newline.
- PdfChunk, if it has one
- PdfChunk-object.
-
- @param string the content of the PdfChunk-object
- @param font the PdfFont
- @param attributes the metrics attributes
- @param noStroke the non metric attributes
- PdfChunk-object.
-
- @param chunk the original Chunk-object
- @param action the PdfAction if the Chunk comes from an Anchor
- PdfChunk-object.
-
- @param chunk the original Chunk-object
- @param action the PdfAction if the Chunk comes from an Anchor
- @param tabSettings the Phrase tab settings
- Chunk.
-
- @return a PdfFont
- Chunk.
-
- @return a BaseColor
- PdfChunk.
-
- @return a width
- PdfChunk split was caused by a newline.
- @return true if the PdfChunk split was caused by a newline.
- PdfChunk taking into account the
- extra character and word spacing.
- @param charSpacing the extra character spacing
- @param wordSpacing the extra word spacing
- @return the calculated width
- attributes
- and noStroke.
- @param name the attribute key
- @return the attribute value or null if not found
- true if the attribute exists
- PdfChunk needs some special metrics handling.
- @return true if this PdfChunk needs some special metrics handling.
- PdfChunk is a Separator Chunk.
- @return true if this chunk is a separator.
- @since 2.1.2
- PdfChunk is a horizontal Separator Chunk.
- @return true if this chunk is a horizontal separator.
- @since 2.1.2
- PdfChunk is a tab Chunk.
- @return true if this chunk is a separator.
- @since 2.1.2
- PdfChunk.
- @return true if an image is present
- PdfChunk.
- @return the image or null
- string
- PdfColor defines a Color (it's a PdfArray containing 3 values).
-
- @see PdfDictionary
- PdfColor.
-
- @param red a value between 0 and 255
- @param green a value between 0 and 255
- @param blue a value between 0 and 255
- PdfContentByte is an object containing the user positioned
- text and graphic contents of a page. It knows how to apply the proper
- font encoding.
- PdfContentByte-object.
-
- @param wr the writer associated to this content
- string representation of this PdfContentByte-object.
-
- @return a string
- PdfContentByte-object.
-
- @param writer the PdfWriter
- @return a byte array with the representation
- PdfContent-object to this object.
-
- @param other another PdfByteContent-object
- - Sets the color space to DeviceGray (or the DefaultGray color space), - and sets the gray tint to use for filling paths.
- - @param gray a value between 0 (black) and 1 (white) -- Sets the color space to DeviceGray (or the DefaultGray color space), - and sets the gray tint to use for stroking paths.
- - @param gray a value between 0 (black) and 1 (white) -- Sets the color space to DeviceRGB (or the DefaultRGB color space), - and sets the color to use for filling paths.
-- Following the PDF manual, each operand must be a number between 0 (minimum intensity) and - 1 (maximum intensity).
- - @param red the intensity of red. A value between 0 and 1 - @param green the intensity of green. A value between 0 and 1 - @param blue the intensity of blue. A value between 0 and 1 -- Sets the color space to DeviceCMYK (or the DefaultCMYK color space), - and sets the color to use for filling paths.
-- Following the PDF manual, each operand must be a number between 0 (no ink) and - 1 (maximum ink).
- - @param cyan the intensity of cyan. A value between 0 and 1 - @param magenta the intensity of magenta. A value between 0 and 1 - @param yellow the intensity of yellow. A value between 0 and 1 - @param black the intensity of black. A value between 0 and 1 -Rectangle
- Rectangle
- Image to the page. The Image must have
- absolute positioning.
- @param image the Image object
- @throws DocumentException if the Image does not have absolute positioning
- Image to the page. The Image must have
- absolute positioning. The image can be placed inline.
- @param image the Image object
- @param inlineImage true to place this image inline, false otherwise
- @throws DocumentException if the Image does not have absolute positioning
- Image to the page. The positioning of the Image
- is done with the transformation matrix. To position an image at (x,y)
- use AddImage(image, image_width, 0, 0, image_height, x, y).
- @param image the Image object
- @param a an element of the transformation matrix
- @param b an element of the transformation matrix
- @param c an element of the transformation matrix
- @param d an element of the transformation matrix
- @param e an element of the transformation matrix
- @param f an element of the transformation matrix
- @throws DocumentException on error
- Image to the page. The positioning of the Image
- is done with the transformation matrix. To position an image at (x,y)
- use AddImage(image, image_width, 0, 0, image_height, x, y).
- @param image the Image object
- @param a an element of the transformation matrix
- @param b an element of the transformation matrix
- @param c an element of the transformation matrix
- @param d an element of the transformation matrix
- @param e an element of the transformation matrix
- @param f an element of the transformation matrix
- @throws DocumentException on error
- Image to the page. The positioning of the Image
- is done with the transformation matrix. To position an image at (x,y)
- use AddImage(image, image_width, 0, 0, image_height, x, y). The image can be placed inline.
- @param image the Image object
- @param a an element of the transformation matrix
- @param b an element of the transformation matrix
- @param c an element of the transformation matrix
- @param d an element of the transformation matrix
- @param e an element of the transformation matrix
- @param f an element of the transformation matrix
- @param inlineImage true to place this image inline, false otherwise
- @throws DocumentException on error
- Image to the page. The positioning of the Image
- is done with the transformation matrix. To position an image at (x,y)
- use AddImage(image, image_width, 0, 0, image_height, x, y). The image can be placed inline.
- @param image the Image object
- @param a an element of the transformation matrix
- @param b an element of the transformation matrix
- @param c an element of the transformation matrix
- @param d an element of the transformation matrix
- @param e an element of the transformation matrix
- @param f an element of the transformation matrix
- @param inlineImage true to place this image inline, false otherwise
- @throws DocumentException on error
- Image to the page. The positioning of the Image
- is done with the transformation matrix. To position an image at (x,y)
- The image can be placed inline.
- @param image the Image object
- @param a an element of the transformation matrix
- @param b an element of the transformation matrix
- @param c an element of the transformation matrix
- @param d an element of the transformation matrix
- @param e an element of the transformation matrix
- @param f an element of the transformation matrix
- @param inlineImage true to place this image inline, false otherwise
- @param isMCBlockOpened true not to open MCBlock, false otherwise
- @throws DocumentException on error
- PdfContentByte empty.
- Calls reset( true )
- PdfContentByte empty.
- @param validateContent will call sanityCheck() if true.
- @since 2.1.6
- saveState and
- restoreState must be balanced.
- saveState and
- restoreState must be balanced.
- - This allows to write text in subscript or basescript mode.
- - @param rise a parameter -- This allows to write text in subscript or basescript mode.
- - @param rise a parameter -text
- converted to bytes according to the font's encoding.
-
- @param text the text to write
- text.
-
- @param text the text to write
- text kerned.
-
- @param text the text to write
- text.
-
- @param text the text to write
- - Remark: this operation also initializes the current point position.
- - @param a operand 1,1 in the matrix - @param b operand 1,2 in the matrix - @param c operand 2,1 in the matrix - @param d operand 2,2 in the matrix - @param x operand 3,1 in the matrix - @param y operand 3,2 in the matrix -- Remark: this operation also initializes the current point position.
- - @param x operand 3,1 in the matrix - @param y operand 3,2 in the matrix -- As a side effect, this sets the leading parameter in the text state.
- - @param x offset of the new current point - @param y y-coordinate of the new current point -PdfPatternPainter where the pattern will be created
- PdfPatternPainter where the pattern will be created
- null
- @return the PdfPatternPainter where the pattern will be created
- null
- @return the PdfPatternPainter where the pattern will be created
- true - template content will be tagged(all that will be added after), false - only a Do operator will be tagged.
- taken into account only if isTagged() - true.
- true - template content will be tagged(all that will be added after), false - only a Do operator will be tagged.
- taken into account only if isTagged() - true.
- true - template content will be tagged(all that will be added after), false - only a Do operator will be tagged.
- taken into account only if isTagged() - true.
- name parameter
- name parameter
- true - template content will be tagged(all that will be added after), false - only a Do operator will be tagged.
- taken into account only if isTagged() - true.
- true - template content will be tagged(all that will be added after), false - only a Do operator will be tagged.
- taken into account only if isTagged() - true.
- - Sets the color space to DeviceCMYK (or the DefaultCMYK color space), - and sets the color to use for filling paths.
-- This method is described in the 'Portable Document Format Reference Manual version 1.3' - section 8.5.2.1 (page 331).
-- Following the PDF manual, each operand must be a number between 0 (no ink) and - 1 (maximum ink). This method however accepts only ints between 0x00 and 0xFF.
- - @param cyan the intensity of cyan - @param magenta the intensity of magenta - @param yellow the intensity of yellow - @param black the intensity of black -- Sets the color space to DeviceCMYK (or the DefaultCMYK color space), - and sets the color to use for stroking paths.
-- This method is described in the 'Portable Document Format Reference Manual version 1.3' - section 8.5.2.1 (page 331).
- Following the PDF manual, each operand must be a number between 0 (miniumum intensity) and - 1 (maximum intensity). This method however accepts only ints between 0x00 and 0xFF. - - @param cyan the intensity of red - @param magenta the intensity of green - @param yellow the intensity of blue - @param black the intensity of black -- Sets the color space to DeviceRGB (or the DefaultRGB color space), - and sets the color to use for filling paths.
-- This method is described in the 'Portable Document Format Reference Manual version 1.3' - section 8.5.2.1 (page 331).
-- Following the PDF manual, each operand must be a number between 0 (miniumum intensity) and - 1 (maximum intensity). This method however accepts only ints between 0x00 and 0xFF.
- - @param red the intensity of red - @param green the intensity of green - @param blue the intensity of blue -- Sets the color space to DeviceRGB (or the DefaultRGB color space), - and sets the color to use for stroking paths.
-- This method is described in the 'Portable Document Format Reference Manual version 1.3' - section 8.5.2.1 (page 331).
- Following the PDF manual, each operand must be a number between 0 (miniumum intensity) and - 1 (maximum intensity). This method however accepts only ints between 0x00 and 0xFF. - - @param red the intensity of red - @param green the intensity of green - @param blue the intensity of blue -color can be an
- ExtendedColor.
- @param color the color
- color can be an
- ExtendedColor.
- @param color the color
- PdfWriter in use by this object.
- @return the PdfWriter in use by this object
- PdfDocument in use by this object.
- @return the PdfDocument in use by this object
- PdfDestination with the jump coordinates
- @return true if the local destination was added,
- false if a local destination with the same name
- already exists
- PdfContentByte. All
- the members are copied by reference but the buffer stays different.
-
- @return a copy of this PdfContentByte
- PdfAction
- @param llx the lower left x corner of the activation area
- @param lly the lower left y corner of the activation area
- @param urx the upper right x corner of the activation area
- @param ury the upper right y corner of the activation area
- string directly to the content.
- @param s the string
- char directly to the content.
- @param c the char
- float directly to the content.
- @param n the float
- PdfName.DEFAULTGRAY, PdfName.DEFAULTRGB
- or PdfName.DEFAULTCMYK
- @param obj the colorspace. A null or PdfNull removes any colorspace with the same name
- struc.
- The same structure can be used several times to connect text that belongs to the same logical segment
- but is in a different location, like the same paragraph crossing to another page, for example.
- @param struc the tagging structure
- struc.
- The same structure can be used several times to connect text that belongs to the same logical segment
- but is in a different location, like the same paragraph crossing to another page, for example.
- @param struc the tagging structure
- null the mark will be of the type
- BMC otherwise it will be BDC.
- @param tag the tag
- @param property the property
- @param inline true to include the property in the content or false
- to include the property in the resource dictionary with the possibility of reusing
- beginMarkedContentSequence(tag, null, false).
- @param tag the tag
- ArrayList to use. It will be cleared before using. If it's
- null will create a new ArrayList
- @return the same ArrayList given as argument or a new one
- @throws IOException on error
- true if a token was read, false if the end of content was reached
- @throws IOException on error
- PdfContents is a PdfStream containing the contents (text + graphics) of a PdfPage.
- PdfContents-object, containing text and general graphics.
-
- @param under the direct content that is under all others
- @param content the graphics in a page
- @param text the text in a page
- @param secondContent the direct content that is over all others
- @throws BadPdfFormatException on error
- true.
- @param rotateContents true to set auto-rotation, false
- otherwise
- PdfContentByte. All
- the members are copied by reference but the buffer stays different.
-
- @return a copy of this PdfContentByte
- List of Integer. The page ordering can be changed but
- no page repetitions are allowed.
- @param reader the PDF document
- @param pagesToKeep the pages to keep
- @throws DocumentException on error
- true for 128 bit key length, false for 40 bit key length
- @throws DocumentException if the document is already open
- null to remove any
- true if the 1.5 compression is on
- List of Integer. The page ordering can be changed but
- no page repetitions are allowed.
- @param reader the PDF document
- @param pagesToKeep the pages to keep
- @throws DocumentException on error
- true for 128 bit key length, false for 40 bit key length
- @throws DocumentException if the document is already open
- SimpleBookmark#.
- @param outlines the bookmarks or null to remove any
- true if the 1.5 compression is on
- PdfDashPattern defines a dash pattern as described in
- the PDF Reference Manual version 1.3 p 325 (section 8.4.3).
-
- @see PdfArray
- PdfDashPattern.
- PdfDashPattern.
- PdfDashPattern.
- PdfDashPattern.
- PdfArray.
-
- @return an array of bytes
- PdfDate-object.
-
- @param d the date that has to be turned into a PdfDate-object
- PdfDate-object, representing the current day and time.
- string in order to get a string
- of a certain length.
-
- @param i a given number
- @param length the length of the resulting string
- @return the resulting string
- PdfColor defines a Color (it's a PdfArray containing 3 values).
-
- @see PdfDictionary
- true or false
- PdfDictionary-object.
- PdfDictionary-object of a certain type.
-
- @param type a PdfName
- PdfDictionary.
-
- @return an array of byte
- PdfObject and its key to the PdfDictionary.
- If the value is null or PdfNull the key is deleted.
-
- @param key key of the entry (a PdfName)
- @param value value of the entry (a PdfObject)
- PdfObject and its key to the PdfDictionary.
- If the value is null it does nothing.
-
- @param key key of the entry (a PdfName)
- @param value value of the entry (a PdfObject)
- PdfDictionary
- to this PdfDictionary.
-
- These mappings will replace any mappings previously contained in this
- PdfDictionary.
-
- @param dic The PdfDictionary with the mappings to be
- copied over
- PdfObject and its key from the PdfDictionary.
-
- @param key key of the entry (a PdfName)
- PdfObjects and its keys from the
- PdfDictionary.
- @since 5.0.2
- Dictionary is of the type FONT.
-
- @return true if it is, false if it isn't.
- Dictionary is of the type PAGE.
-
- @return true if it is, false if it isn't.
- Dictionary is of the type PAGES.
-
- @return true if it is, false if it isn't.
- Dictionary is of the type CATALOG.
-
- @return true if it is, false if it isn't.
- Dictionary is of the type OUTLINES.
-
- @return true if it is, false if it isn't.
- PdfInfo-object.
- PdfInfo-object.
-
- @param author name of the author of the document
- @param title title of the document
- @param subject subject of the document
- PdfCatalog.
-
- @param pages an indirect reference to the root of the document's Pages tree.
- @param writer the writer the catalog applies to
- PdfWriter.
- PdfWriter to the PdfDocument.
-
- @param writer the PdfWriter that writes everything
- what is added to this document to an outputstream.
- @throws DocumentException on error
- PdfAction when processing an Anchor.
- Element was added to the Document.
-
- @param element the element to add
- @return true if the element was added, false if not.
- @throws DocumentException when a document isn't open yet, or has been closed
- PdfWriter.
-
- @return true if new page was added
- @throws DocumentException on error
- true if the page size was set
- bool
- PdfCatalog-object.
-
- @param pages an indirect reference to this document pages
- @return PdfCatalog
- PdfOutline in the hierarchy of outlines.
- PdfAction
- @param llx the lower left x corner of the activation area
- @param lly the lower left y corner of the activation area
- @param urx the upper right x corner of the activation area
- @param ury the upper right y corner of the activation area
- Object[]{PdfAction,PdfIndirectReference,PdfDestintion}.
- PdfDestination with the jump coordinates
- @return true if the local destination was added,
- false if a local destination with the same name
- already existed
- Image to add
- @throws PdfException on error
- @throws DocumentException on error
- PdfPTable to the document.
- @param ptable the PdfPTable to be added to the document.
- @throws DocumentException on error
- text only has PdfDocEncoding characters.
- @param text the String to test
- @return true if only PdfDocEncoding characters are present
- PdfWriter. The userPassword and the
- ownerPassword can be null or have zero length. In this case the ownerPassword
- is replaced by a random string. The open permissions for the document can be
- AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations,
- AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting.
- The permissions can be combined by ORing them.
- @param reader the read PDF
- @param os the output destination
- @param userPassword the user password. Can be null or empty
- @param ownerPassword the owner password. Can be null or empty
- @param permissions the user permissions
- @param strength128Bits true for 128 bit key length, false for 40 bit key length
- @throws DocumentException on error
- @throws IOException on error
- PdfWriter. The userPassword and the
- ownerPassword can be null or have zero length. In this case the ownerPassword
- is replaced by a random string. The open permissions for the document can be
- AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations,
- AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting.
- The permissions can be combined by ORing them.
- @param reader the read PDF
- @param os the output destination
- @param userPassword the user password. Can be null or empty
- @param ownerPassword the owner password. Can be null or empty
- @param permissions the user permissions
- @param strength128Bits true for 128 bit key length, false for 40 bit key length
- @param newInfo an optional String map to add or change
- the info dictionary. Entries with null
- values delete the key in the original info dictionary
- @throws DocumentException on error
- @throws IOException on error
- PdfWriter. The userPassword and the
- ownerPassword can be null or have zero length. In this case the ownerPassword
- is replaced by a random string. The open permissions for the document can be
- AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations,
- AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting.
- The permissions can be combined by ORing them.
- @param reader the read PDF
- @param os the output destination
- @param strength true for 128 bit key length, false for 40 bit key length
- @param userPassword the user password. Can be null or empty
- @param ownerPassword the owner password. Can be null or empty
- @param permissions the user permissions
- @throws DocumentException on error
- @throws IOException on error
- PdfWriter. The userPassword and the
- ownerPassword can be null or have zero length. In this case the ownerPassword
- is replaced by a random string. The open permissions for the document can be
- AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations,
- AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting.
- The permissions can be combined by ORing them.
- @param reader the read PDF
- @param os the output destination
- @param strength true for 128 bit key length, false for 40 bit key length
- @param userPassword the user password. Can be null or empty
- @param ownerPassword the owner password. Can be null or empty
- @param permissions the user permissions
- @param newInfo an optional String map to add or change
- the info dictionary. Entries with null
- values delete the key in the original info dictionary
- @throws DocumentException on error
- @throws IOException on error
- PdfWriter. The userPassword and the
- ownerPassword can be null or have zero length. In this case the ownerPassword
- is replaced by a random string. The open permissions for the document can be
- AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations,
- AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting.
- The permissions can be combined by ORing them.
- @param reader the read PDF
- @param os the output destination
- @param type the type of encryption. It can be one of STANDARD_ENCRYPTION_40, STANDARD_ENCRYPTION_128 or ENCRYPTION_AES128.
- Optionally DO_NOT_ENCRYPT_METADATA can be ored to output the metadata in cleartext
- @param userPassword the user password. Can be null or empty
- @param ownerPassword the owner password. Can be null or empty
- @param permissions the user permissions
- @param newInfo an optional String map to add or change
- the info dictionary. Entries with null
- values delete the key in the original info dictionary
- @throws DocumentException on error
- @throws IOException on error
- PdfWriter. The userPassword and the
- ownerPassword can be null or have zero length. In this case the ownerPassword
- is replaced by a random string. The open permissions for the document can be
- AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations,
- AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting.
- The permissions can be combined by ORing them.
- @param reader the read PDF
- @param os the output destination
- @param type the type of encryption. It can be one of STANDARD_ENCRYPTION_40, STANDARD_ENCRYPTION_128 or ENCRYPTION_AES128.
- Optionally DO_NOT_ENCRYPT_METADATA can be ored to output the metadata in cleartext
- @param userPassword the user password. Can be null or empty
- @param ownerPassword the owner password. Can be null or empty
- @param permissions the user permissions
- values delete the key in the original info dictionary
- @throws DocumentException on error
- @throws IOException on error
- PdfWriter
- @param url the URL
- @return the file specification
- PdfWriter
- @param filePath the file path
- @param fileDisplay the file information that is presented to the user
- @param fileStore the byte array with the file. If it is not null
- it takes precedence over filePath
- @throws IOException on error
- @return the file specification
- PdfWriter
- @param filePath the file path
- @param fileDisplay the file information that is presented to the user
- @param fileStore the byte array with the file. If it is not null
- it takes precedence over filePath
- @param compressionLevel the compression level to be used for compressing the file
- it takes precedence over filePath
- @throws IOException on error
- @return the file specification
- @since 2.1.3
- PdfWriter
- @param filePath the file path
- @param fileDisplay the file information that is presented to the user
- @param fileStore the byte array with the file. If it is not null
- it takes precedence over filePath
- @param compress sets the compression on the data. Multimedia content will benefit little
- from compression
- @throws IOException on error
- @return the file specification
- PdfWriter
- @param filePath the file path
- @param fileDisplay the file information that is presented to the user
- @param fileStore the byte array with the file. If it is not null
- it takes precedence over filePath
- @param compress sets the compression on the data. Multimedia content will benefit little
- from compression
- @param mimeType the optional mimeType
- @param fileParameter the optional extra file parameters such as the creation or modification date
- @throws IOException on error
- @return the file specification
- PdfWriter
- @param filePath the file path
- @param fileDisplay the file information that is presented to the user
- @param fileStore the byte array with the file. If it is not null
- it takes precedence over filePath
- @param mimeType the optional mimeType
- @param fileParameter the optional extra file parameters such as the creation or modification date
- @param compressionLevel the level of compression
- @throws IOException on error
- @return the file specification
- @since 2.1.3
- PdfWriter
- @param filePath the file path
- @return the file specification
- PdfFont with another
-
- @param object the other PdfFont
- @return a value
- PdfAnnotation of subtype link (Action).
- PdfFormObject is a type of XObject containing a template-object.
- PdfFormXObject-object.
-
- @param template the template
- @param compressionLevel the compression level for the stream
- @since 2.1.3 (Replacing the existing constructor with param compressionLevel)
- PdfICCBased defines a ColorSpace
-
- @see PdfStream
- PdfImage is a PdfStream containing an image-Dictionary and -stream.
- PdfName of the image.
- PdfImage-object.
-
- @param image the Image-object
- @param name the PdfName for this image
- @throws BadPdfFormatException on error
- PdfName of the image.
-
- @return the name
- PdfImportedPage-object from a reader.
-
- @return self
-
- PdfIndirectObject.
-
- @param number the objecti number
- @param objecti the direct objecti
- PdfIndirectObject.
-
- @param number the objecti number
- @param generation the generation number
- @param objecti the direct objecti
- PdfIndirectReference to this PdfIndirectObject.
-
- @return a PdfIndirectReference
- PdfIndirectReference.
-
- @param type the type of the PdfObject that is referenced to
- @param number the object number.
- @param generation the generation number.
- PdfIndirectReference.
-
- @param type the type of the PdfObject that is referenced to
- @param number the object number.
- PdfWriter
- @return the title layer
- null if the layer has no parent
- null if the layer has no children
- PdfIndirectReference that represents this layer.
- @return the PdfIndirectReference that represents this layer
- this.
- @return the dictionary representing the layer
- false
- the layer cannot be directly manipulated by the user. Note that any children layers will
- also be absent from the panel.
- @param onPanel the visibility of the layer in Acrobat's layer panel
- PdfIndirectReference that represents this membership layer.
- @return the PdfIndirectReference that represents this layer
- this.
- @return the dictionary representing the layer
- PdfLine defines an array with PdfChunk-objects
- that fit into 1 line.
- true if the chunk splitting was caused by a newline.
- PdfLine-object.
-
- @param left the limit of the line at the left
- @param right the limit of the line at the right
- @param alignment the alignment of the line
- @param height the height of the line
- PdfChunk to the PdfLine.
-
- @param chunk the PdfChunk to add
- @param currentLeading new value for the height of the line
- @return null if the chunk could be added completely; if not
- a PdfChunk containing the part of the chunk that could
- not be added is returned
- PdfChunk to the PdfLine.
-
- @param chunk the PdfChunk to add
- @return null if the chunk could be added completely; if not
- a PdfChunk containing the part of the chunk that could
- not be added is returned
- PdfChunks.
-
- @return an Iterator
- true if the alignment equals ALIGN_JUSTIFIED and there is some width left.
- PdfChunk if the line has a listsymbol; null otherwise
- string
- true if a newline caused the line split
- PdfChunk with metric attributes
- @return the last PdfChunk with metric attributes
- PdfChunk by index.
- @param idx the index
- @return the PdfChunk or null if beyond the array
- PdfName additions don't have to be "added twice".
- A bit less efficient (around 50ms spent here on a 2.2ghz machine),
- but Much Less error prone.
- @since 2.1.6
- PdfName. The name length will be checked.
- @param name the new name
- PdfName.
- @param name the new name
- @param lengthCheck if true check the lenght validity, if false the name can
- have any length
- true if this object is the same as the obj
- argument; false otherwise.
- java.util.Hashtable.
-
- @return a hash code value for this object.
- String
- and the value is a PdfObject. Note that although the
- keys are strings only the lower byte is used and no check is made for chars
- with the same lower byte and different upper byte. This will generate a wrong
- tree name.
- @param writer the writer
- @throws IOException on error
- @return the dictionary with the name tree. This dictionary is the one
- generally pointed to by the key /Dests, for example
- PdfNull-object.
- PdfNumber, represented as a double
- PdfNumber-object.
-
- @param content value of the new PdfNumber-object
- PdfNumber-object.
-
- @param value value of the new PdfNumber-object
- PdfNumber-object.
-
- @param value value of the new PdfNumber-object
- PdfNumber-object.
-
- @param value value of the new PdfNumber-object
- PdfNumber-object.
-
- @param value value of the new PdfNumber-object
- int value of this object.
-
- @return a value
- long value of this object.
-
- @return a value
- double value of this object.
-
- @return a value
- PdfNumber-object with 1.
- Integer
- and the value is a PdfObject.
- @param writer the writer
- @throws IOException on error
- @return the dictionary with the number tree.
- PdfObject
- PdfObject
- PdfObject
- PdfObject
- PdfObject
- PdfObject
- PdfObject
- PdfObject
- PdfObject
- PdfNull-object and for an empty PdfString-object.
- PdfObject
- PdfObject
- PdfObject of a certain type without any content.
-
- @param type type of the new PdfObject
- PdfObject of a certain type with a certain content.
-
- @param type type of the new PdfObject
- @param content content of the new PdfObject as a String.
- PdfObject of a certain type with a certain content.
-
- @param type type of the new PdfObject
- @param bytes content of the new PdfObject as an array of byte.
- PdfObject as an array of bytes to the writer.
- @param writer for backwards compatibility
- @param os the outputstream to write the bytes to.
- @throws IOException
- String-representation of this PdfObject.
-
- @return a String
- PdfObject.
-
- In some cases, namely for PdfString and PdfStream,
- this method differs from the method pdfLength because pdfLength
- returns the length of the PDF representation of the object, not of the actual content
- as does the method length.
- Remark: the actual content of an object is in some cases identical to its representation. - The following statement is always true: Length() >= PdfLength().
- - @return a length -PdfObject.
-
- @param content the new content of this PdfObject
- PdfObject.
-
- @return a type
- PdfObject is of the type PdfNull.
-
- @return true or false
- PdfObject is of the type PdfBoolean.
-
- @return true or false
- PdfObject is of the type PdfNumber.
-
- @return true or false
- PdfObject is of the type PdfString.
-
- @return true or false
- PdfObject is of the type PdfName.
-
- @return true or false
- PdfObject is of the type PdfArray.
-
- @return true or false
- PdfObject is of the type PdfDictionary.
-
- @return true or false
- PdfObject is of the type PdfStream.
-
- @return true or false
- PdfIndirectReference of this object
- PdfAction for this outline.
- true if the children are visible
- PdfOutline.
-
- @return the PdfIndirectReference to this outline.
- PdfOutline.
-
- @return the PdfOutline that is the parent of this outline.
- PdfDestination-object.
-
- @param pageReference indirect reference to the page
- @return true if this page was set as the PdfDestination-page.
- PdfOutline.
-
- @param writer the encryption information
- @param os
- @throws IOException
- PdfPage.
-
- @param mediaBox a value for the MediaBox key
- @param resources an indirect reference to a PdfResources-object
- @param rotate a value for the Rotate key
- @throws DocumentException
- PdfPage.
-
- @param mediaBox a value for the MediaBox key
- @param resources an indirect reference to a PdfResources-object
- @throws DocumentException
- PdfContents-object.
-
- @param contents an indirect reference to a PdfContents-object
- PdfRectangle
- PdfRectangle
- PdfPageEvent by implementing all the interface methods.
- A class can extend PdfPageEventHelper and only implement the
- needed methods.
-
- @author Paulo Soares
- PdfWriter for this document
- @param document the document
- PdfWriter for this document
- @param document the document
- null or empty
- @param firstPage the first logical page number
- null or empty
- @param firstPage the first logical page number
- @param includeFirstPage If true, the page label will be added to the first page if it is page 1.
- If the first page is not page 1 or this value is false, the value will not be added to the dictionary.
- null or empty
- null if no page labels are present
- null if no page labels are present
- null or empty
- @param logicalPage the first logical page number
- PdfPages-object.
- PdfPattern defines a ColorSpace
-
- @see PdfStream
- PdfPattern.
- PdfWriter
- PdfPatternPainter. All
- the members are copied by reference but the buffer stays different.
- @return a copy of this PdfPatternPainter
- PdfPCell.
- The default padding is 2.
- PdfPCell with a Phrase.
- The default padding is 2.
- @param phrase the text
- PdfPCell with an Image.
- The default padding is 0.
- @param image the Image
- PdfPCell with an Image.
- The default padding is 0.25 for a border width of 0.5.
- @param image the Image
- @param fit true to fit the image to the cell
- PdfPCell with a PdfPtable.
- This constructor allows nested tables.
- The default padding is 0.
- @param table The PdfPTable
- PdfPCell with a PdfPtable.
- This constructor allows nested tables.
-
- @param table The PdfPTable
- @param style The style to apply to the cell (you could use getDefaultCell())
- @since 2.1.0
- PdfPCell.
- @param cell the PdfPCell to duplicate
- Phrase from this cell.
- @return the Phrase
- PdfPSXObject. All
- the members are copied by reference but the buffer stays different.
- @return a copy of this PdfPSXObject
- Table.
- In the last case when crossing pages the table always break at full rows; if a
- row is bigger than the page it is dropped silently to avoid infinite loops.
-
- A PdfPTableEvent can be associated to the table to do custom drawing
- when the table is rendered.
- @author Paulo Soares
- PdfcontentByte.
- PdfContentByte where the background will be drawn.
- PdfContentByte where the border lines will be drawn.
- PdfContentByte where the text will be drawn.
- PdfPTable with the relative column widths.
- @param relativeWidths the relative column widths
- PdfPTable with numColumns columns.
- @param numColumns the number of columns
- PdfPTable.
- @param table the PdfPTable to be copied
- PdfPCell that will be used as
- reference for all the addCell methods except
- addCell(PdfPCell).
- @return default PdfPCell
- Image to add to the table.
- This image will fit in the cell
- Phrase to be added to the cell
- canvases is obtained from beginWritingRows().
- The table event is only fired for complete rows.
-
- @param colStart the first column to be written, zero index
- @param colEnd the last column to be written + 1. If it is -1 all the
- columns to the end are written
- @param rowStart the first row to be written, zero index
- @param rowEnd the last row to be written + 1. If it is -1 all the
- rows to the end are written
- @param xPos the x write coordinate
- @param yPos the y write coordinate
- @param canvases an array of 4 PdfContentByte obtained from
- beginWritingRows()
- @param reusable if set to false, the content in the cells is "consumed";
- if true, you can reuse the cells, the row, the parent table as many times you want.
- @return the y coordinate position of the bottom of the last row
- @see #beginWritingRows(com.itextpdf.text.pdf.PdfContentByte)
- @since 5.1.0 added the reusable parameter
- PdfContentByte where the rows will
- be written to
- @return the y coordinate position of the bottom of the last row
- PdfContentByte where the rows will
- be written to
- @return the y coordinate position of the bottom of the last row
- @param reusable if set to false, the content in the cells is "consumed";
- if true, you can reuse the cells, the row, the parent table as many times you want.
- @since 5.1.0 added the reusable parameter
- beginWritingRows()
- setHeaderRows().
- @return the height of the rows that constitute the header and footer
- setFooterRows().
- @return the height of the rows that constitute the footer
- @since 2.1.1
- true if the row was deleted
- true if the last row was deleted
- List
- ElementListener.
-
- @param listener an ElementListener
- @return true if the element was processed successfully
- InputStream containing the document. The stream is read to the
- end but is not closed
- @param ownerPassword the password to read the document
- @throws IOException on error
- InputStream containing the document. The stream is read to the
- end but is not closed
- @throws IOException on error
- InputStream containing the document. The stream is read to the
- end but is not closed
- @throws IOException on error
- null for no password
- @throws IOException on error
- null for no password
- @param partial indicates if the reader needs to read the document only partially. See {@link PdfReader#PdfReader(RandomAccessFileOrArray, byte[])}
- @throws IOException on error
- PdfReader to duplicate
- Rectangle with the value of the /MediaBox and the /Rotate key.
- @param index the page number. The first page is 1
- @return a Rectangle
- Hashtable
- of String.
- @return content of the document information dictionary
- Rectangle so that llx and lly are smaller than urx and ury.
- @param box the original rectangle
- @return a normalized Rectangle
- PdfObject resolving an indirect reference
- if needed.
- @param obj the PdfObject to read
- @return the resolved PdfObject
- PdfObject resolving an indirect reference
- if needed. If the reader was opened in partial mode the object will be released
- to save memory.
- @param obj the PdfObject to read
- @param parent
- @return a PdfObject
- true to read a correct stream. false
- to try to read a corrupted stream
- @return the decoded data
- true to read a correct stream. false
- to try to read a corrupted stream
- @return the decoded data
- true if the PDF is encrypted.
- @return true if the PDF is encrypted
- PdfWriter.SetEncryption().
- @return the encryption permissions
- true if the PDF has a 128 bit key encryption.
- @return true if the PDF has a 128 bit key encryption
- Hashtable. The key is the name
- and the value is the destinations array.
- @return gets all the named destinations
- HashMap. The key is the name
- and the value is the destinations array.
- @param keepNames true if you want the keys to be real PdfNames instead of Strings
- @return gets all the named destinations
- @since 2.1.6
- Hashtable. The key is the name
- and the value is the destinations array.
- @return gets the named destinations
- HashMap. The key is the name
- and the value is the destinations array.
- @param keepNames true if you want the keys to be real PdfNames instead of Strings
- @return gets the named destinations
- @since 2.1.6
- Hashtable. The key is the name
- and the value is the destinations array.
- @return gets the named destinations
- AcroFields.
- @return a read-only version of AcroFields
- List of Integer. The page ordering can be changed but
- no page repetitions are allowed. Note that it may be very slow in partial mode.
- @param pagesToKeep the pages to keep in the document
- List of Integer. The page ordering can be changed but
- no page repetitions are allowed. Note that it may be very slow in partial mode.
- @param pagesToKeep the pages to keep in the document
- @param removeUnused indicate if to remove unsed objects. @see removeUnusedObjects
- true if usage rights are present; false otherwise
- PdfSignatureAppearance.NOT_CERTIFIED,
- PdfSignatureAppearance.CERTIFIED_NO_CHANGES_ALLOWED,
- PdfSignatureAppearance.CERTIFIED_FORM_FILLING and
- PdfSignatureAppearance.CERTIFIED_FORM_FILLING_AND_ANNOTATIONS.
-
- No signature validation is made, use the methods availabe for that in AcroFields.
-
true.
- @return true if the document was opened with the owner password or if it's not encrypted,
- false if the document was opened with the user password
- PdfRectangle-object.
-
- @param llx lower left x
- @param lly lower left y
- @param urx upper right x
- @param ury upper right y
-
- @since rugPdf0.10
- PdfRectangle-object starting from the origin (0, 0).
-
- @param urx upper right x
- @param ury upper right y
- PdfRectangle-object with a Rectangle-object.
-
- @param rectangle a Rectangle
- add-method in PdfArray in order to prevent the adding of extra object to the array.
-
- @param object PdfObject to add (will not be added here)
- @return false
- PdfRectangle
- NOT_CERTIFIED, CERTIFIED_NO_CHANGES_ALLOWED,
- CERTIFIED_FORM_FILLING and CERTIFIED_FORM_FILLING_AND_ANNOTATIONS
- null
- or have zero width or height for invisible signatures
- null to generate automatically a new field name
- RenderingMode.GRAPHIC
- or RenderingMode.GRAPHIC_AND_DESCRIPTION.
- @param signatureGraphic image rendered. If null the mode is defaulted
- to RenderingMode.DESCRIPTION
- false if you want to ignore this recommendation.
- @param acro6Layers if true only the layers n0 and n2 will be present
- @deprecated Adobe no longer supports Adobe Acrobat / Reader versions older than 9
- null or not set
- a standard description will be used
- null or not set
- the description "Signature Not Verified" will be used
- PdfStamper associated with this instance.
- @return the PdfStamper associated with this instance
- null is the document is created in memory
- true if the document is in the process of closing,
- false otherwise
- PdfSpotColor defines a ColorSpace
-
- @see PdfDictionary
- PdfSpotColor.
-
- @param name a string value
- @param tint a tint value between 0 and 1
- @param altcs a altnative colorspace value
- String map to add or change values in
- the info dictionary.
- @return the map or null
-
- An optional String map to add or change values in
- the info dictionary. Entries with null
- values delete the key in the original info dictionary
- @param moreInfo additional entries to the info dictionary
-
- PdfReader from where the new page will be imported
- @param pageImported the page number of the imported page
- @param pageReplaced the page to replace in this document
- pageNumber will
- be shifted up. If pageNumber is bigger than the total number of pages
- the new page will be the last one.
- @param pageNumber the page number position where the new page will be inserted
- @param mediabox the size of the new page
- PdfContentByte to write under the page of
- the original document.
- @param pageNum the page number where the extra content is written
- @return a PdfContentByte to write under the page of
- the original document
- PdfContentByte to write over the page of
- the original document.
- @param pageNum the page number where the extra content is written
- @return a PdfContentByte to write over the page of
- the original document
- true.
- @param rotateContents true to set auto-rotation, false
- otherwise
- true for 128 bit key length, false for 40 bit key length
- @throws DocumentException if anything was already written to the output
- true for 128 bit key length, false for 40 bit key length
- @param userPassword the user password. Can be null or empty
- @param ownerPassword the owner password. Can be null or empty
- @param permissions the user permissions
- @throws DocumentException if anything was already written to the output
- AcroFields object that allows to get and set field values
- and to merge FDF forms.
- @return the AcroFields object
- true to flatten the fields, false
- to keep the fields
- true to flatten the FreeText annotations, false
- (the default) to keep the FreeText annotations as active content.
- null to remove any
- null
- the file will be read from the disk
- @param file the path to the file. It will only be used if
- fileStore is not null
- @param fileDisplay the actual file name stored in the pdf
- @throws IOException on error
- true if the 1.5 compression is on
- PdfWriter.PAGE_OPEN
- or PdfWriter.PAGE_CLOSE
- @param action the action to perform
- @param page the page where the action will be applied. The first page is 1
- @throws PdfException if the action type is invalid
- null removes the transition
- @param page the page where the transition will be applied. The first page is 1
- UnsupportedOperationException.
- @param actionType ignore
- @param action ignore
- @throws PdfException ignore
- @see PdfStamper#setPageAction(PdfName, PdfAction, int)
- PdfWriter.PAGE_OPEN
- or PdfWriter.PAGE_CLOSE
- @param action the action to perform
- @param page the page where the action will be applied. The first page is 1
- @throws PdfException if the action type is invalid
- UnsupportedOperationException.
- @param seconds ignore
- UnsupportedOperationException.
- @param transition ignore
- null removes the transition
- @param page the page where the transition will be applied. The first page is 1
- DOCUMENT_CLOSE,
- WILL_SAVE, DID_SAVE, WILL_PRINT
- and DID_PRINT.
-
- @param actionType the action type
- @param action the action to execute in response to the trigger
- @throws PdfException on invalid action type
- PdfStream-object.
-
- @param bytes content of the new PdfObject as an array of byte.
- InputStream
- is totally consumed but is not closed. The general usage is:
- - InputStream in = ...; - PdfStream stream = new PdfStream(in, writer); - stream.FlateCompress(); - writer.AddToBody(stream); - stream.WriteLength(); - in.Close(); -- @param inputStream the data to write to this stream - @param writer the
PdfWriter for this stream
- PdfStream-object.
- PdfWriter.
- - This method must be called and can only be called if the contructor {@link #PdfStream(InputStream,PdfWriter)} - is used to create the stream. -
- @throws IOException on error - @see #PdfStream(InputStream,PdfWriter) -Stream.
- @param os the destination to write to
- @throws IOException on error
- PdfString-object.
- PdfString-object.
-
- @param value the content of the string
- PdfString-object.
-
- @param value the content of the string
- @param encoding an encoding
- PdfString-object.
-
- @param bytes an array of byte
- PdfString.
-
- @return an array of bytes
- string value of the PdfString-object.
-
- @return a string
- string
- PdfTemplate.
- PdfWriter
- null for no layer defined
- PdfTemplate. All
- the members are copied by reference but the buffer stays different.
- @return a copy of this PdfTemplate
- PdfNumber to the PdfArray.
-
- @param number displacement of the string
- Transition.
-
- Transition.
-
- @param type type of the transition effect
- Transition.
-
- @param type type of the transition effect
- @param duration duration of the transition effect
- DocWriter class for PDF.
-
- When this PdfWriter is added
- to a certain PdfDocument, the PDF representation of every Element
- added to this Document will be written to the outputstream.
PdfCrossReference is an entry in the PDF Cross-Reference table.
- PdfObject.
- @param os
- @throws IOException
- PdfBody.
- @param writer
- Body.
-
- @return a number of objects
- Body.
- @param os
- @param root
- @param info
- @param encryption
- @param fileID
- @param prevxref
- @throws IOException
- PdfCrossReferenceTable
- @param offset offset of the PdfCrossReferenceTable
- @param root an indirect reference to the root of the PDF document
- @param info an indirect reference to the info object of the PDF document
- @param encryption
- @param fileID
- @param prevxref
- PdfObject.
- @param writer
- @param os
- @throws IOException
- PdfWriter.
- PdfWriter.
-
- @param document The Document that has to be written
- @param os The Stream the writer has to write to.
- @return a new PdfWriter
-
- @throws DocumentException on error
- PdfWriter.
-
- @return a new PdfWriter
- @param document The Document that has to be written
- @param os The Stream the writer has to write to.
- @param listener A DocListener to pass to the PdfDocument.
- @throws DocumentException on error
- PdfDocument associated with this writer.
- @return the PdfDocument
- Hashtable containing the destinations
- @throws IOException on error
- PdfIndirectReference for an object that
- will be created in the future.
- @return the PdfIndirectReference
- null argument value only returns the number of pages to process.
- It is advisable to issue a Document.NewPage() before using this method.
- @return the total number of pages
- @param order an array with the new page sequence. It must have the
- same size as the number of pages.
- @throws DocumentException if all the pages are not present in the array
- PdfPageEvent for this document.
- PdfPageEvent for this document or null
- if none is set.
- @return the PdfPageEvent for this document or null
- if none is set
- null to remove any
- null
- the file will be read from the disk
- @param file the path to the file. It will only be used if
- fileStore is not null
- @param fileDisplay the actual file name stored in the pdf
- @throws IOException on error
- action will be
- invoked.
- @param action the action to be invoked
- DOCUMENT_CLOSE,
- WILL_SAVE, DID_SAVE, WILL_PRINT
- and DID_PRINT.
-
- @param actionType the action type
- @param action the action to execute in response to the trigger
- @throws PdfException on invalid action type
- PdfAcroForm
- PdfAnnotation or a PdfFormField
- to the document. Only the top parent of a PdfFormField
- needs to be added.
- @param annot the PdfAnnotation or the PdfFormField to add
- PdfAnnotation to the calculation order
- array.
- @param annot the PdfAnnotation to be added
- true if the PDF has to be in conformance with any of the PDF ISO specifications
- ICC_Profile-based version of this method.
- @param outputConditionIdentifier a value
- @param outputCondition a value, "PDFA/A" to force GTS_PDFA1, otherwise cued by pdfxConformance.
- @param registryName a value
- @param info a value
- @param destOutputProfile a value
- @since 1.x
-
- @throws IOException
- true to just check for the existence of a valid output intent
- dictionary, false to insert the dictionary if it exists
- @throws IOException on error
- @return true if the output intent dictionary exists, false
- otherwise
- true for 128 bit key length, false for 40 bit key length
- @throws DocumentException if the document is already open
- true for 128 bit key length, false for 40 bit key length
- @param userPassword the user password. Can be null or empty
- @param ownerPassword the owner password. Can be null or empty
- @param permissions the user permissions
- @throws DocumentException if the document is already open
- true if the 1.5 compression is on
- BaseFont to the document but not to the page resources.
- It is used for templates.
- @param bf the BaseFont to add
- @return an Object[] where position 0 is a PdfName
- and position 1 is an PdfIndirectReference
- PdfName for this template
- PdfReader to free
- @throws IOException on error
- freeReader() when concatenating many documents
- and an idea of the current size is needed.
- @return the approximate size without fonts or templates
- SpotColor to the document but not to the page resources.
- @param spc the SpotColor to add
- @return an Object[] where position 0 is a PdfName
- and position 1 is an PdfIndirectReference
- true if the document is marked for tagging
- null.
- @return the structure tree root
- PdfWriter.PAGE_OPEN
- or PdfWriter.PAGE_CLOSE
- @param action the action to perform
- @throws PdfException if the action type is invalid
- ratio times more than extra character spacing.
- spaceCharRatio times more than extra character spacing.
- If the ratio is PdfWriter.NO_SPACE_CHAR_RATIO then the extra character spacing
- will be zero.
- @param spaceCharRatio the ratio between the extra word spacing and the extra character spacing
- Document.Add(Image).
- @param image the Image to add
- @return the name of the image added
- @throws PdfException on error
- @throws DocumentException on error
- Document.Add(Image).
- @param image the Image to add
- @param fixedRef the reference to used. It may be null,
- a PdfIndirectReference or a PRIndirectReference.
- @return the name of the image added
- @throws PdfException on error
- @throws DocumentException on error
- PdfImage to the outputstream.
-
- @param pdfImage the image to be added
- @return a PdfIndirectReference to the encapsulated image
- @throws PdfException when a document isn't open yet, or has been closed
- PdfIndirectReference to the image with a given name.
-
- @param name the name of the image
- @return a PdfIndirectReference
- true to set the transparency blending colorspace to RGB, false
- to use the default blending colorspace
- PdfIndirectReference.
-
- @param reader a PdfReader
- @param number the object number.
- @param generation the generation number.
- PdfIndirectReference.
-
- @param reader a PdfReader
- @param number the object number.
- PdfWriter
- @param box the field location and dimensions
- @param fieldName the field name. If null only the widget keys
- will be included in the field allowing it to be used as a kid field.
- LAYOUT_LABEL_ONLY,
- LAYOUT_ICON_ONLY, LAYOUT_ICON_TOP_LABEL_BOTTOM,
- LAYOUT_LABEL_TOP_ICON_BOTTOM, LAYOUT_ICON_LEFT_LABEL_RIGHT,
- LAYOUT_LABEL_LEFT_ICON_RIGHT and LAYOUT_LABEL_OVER_ICON.
- The default is LAYOUT_LABEL_ONLY.
- @param layout New value of property layout.
- SCALE_ICON_ALWAYS, SCALE_ICON_NEVER,
- SCALE_ICON_IS_TOO_BIG and SCALE_ICON_IS_TOO_SMALL.
- The default is SCALE_ICON_ALWAYS.
- @param scaleIcon the way the icon will be scaled
- true the icon is scaled proportionally,
- if false the scaling is done anamorphicaly.
- @param proportionalIcon the way the icon is scaled
- true the icon will be scaled to fit fully within the bounds of the annotation,
- if false the border width will be taken into account. The default
- is false.
- @param iconFitToBounds if true the icon will be scaled to fit fully within the bounds of the annotation,
- if false the border width will be taken into account
- A simple, fast array of bits, represented compactly by an array of ints internally.
- - @author Sean Owen -Represents a 2D matrix of bits. In function arguments below, and throughout the common - module, x is the column position, and y is the row position. The ordering is always x, y. - The origin is at the top-left.
- -Internally the bits are represented in a 1-D array of 32-bit ints. However, each row begins - with a new int. This is done intentionally so that we can copy out a row into a BitArray very - efficiently.
- -The ordering of bits is row-major. Within each int, the least significant bits are used first, - meaning they represent lower x values. This is compatible with BitArray's implementation.
- - @author Sean Owen - @author dswitkin@google.com (Daniel Switkin) -Gets the requested bit, where true means black.
- - @param x The horizontal component (i.e. which column) - @param y The vertical component (i.e. which row) - @return value of given bit in matrix -Sets the given bit to true.
- - @param x The horizontal component (i.e. which column) - @param y The vertical component (i.e. which row) -Flips the given bit.
- - @param x The horizontal component (i.e. which column) - @param y The vertical component (i.e. which row) -Sets a square region of the bit matrix to true.
- - @param left The horizontal position to begin at (inclusive) - @param top The vertical position to begin at (inclusive) - @param width The width of the region - @param height The height of the region -See ISO 18004:2006, 6.5.1. This enum encapsulates the four error correction levels - defined by the QR code standard.
- - @author Sean Owen -Encapsulates a QR Code's format information, including the data mask used and - error correction level.
- - @author Sean Owen - @see ErrorCorrectionLevel -null
- if doesn't seem to match any known pattern
- This class contains utility methods for performing mathematical operations over - the Galois Field GF(256). Operations use a given primitive polynomial in calculations.
- -Throughout this package, elements of GF(256) are represented as an int
- for convenience and speed (but at the cost of memory).
- Only the bottom 8 bits are really used.
Represents a polynomial whose coefficients are elements of GF(256). - Instances of this class are immutable.
- -Much credit is due to William Rucklidge since portions of this code are an indirect - port of his C++ Reed-Solomon implementation.
- - @author Sean Owen -See ISO 18004:2006, 6.4.1, Tables 2 and 3. This enum encapsulates the various modes in which - data can be encoded to bits in the QR code standard.
- - @author Sean Owen -Implements Reed-Solomon enbcoding, as the name implies.
- - @author Sean Owen - @author William Rucklidge -Thrown when an exception occurs during Reed-Solomon decoding, such as when - there are too many errors to correct.
- - @author Sean Owen -Deduces version information purely from QR Code dimensions.
- - @param dimension dimension in modules - @return {@link Version} for a QR Code of that dimension - @throws FormatException if dimension is not 1 mod 4 -Encapsulates a set of error-correction blocks in one symbol version. Most versions will - use blocks of differing sizes within one version, so, this encapsulates the parameters for - each set of blocks. It also holds the number of error-correction codewords per block since it - will be the same across all blocks within one version.
-Encapsualtes the parameters for one error-correction block in one symbol version. - This includes the number of data codewords, and the number of times a block with these - parameters is used consecutively in the QR code version's format.
-PdfWriter
- @param box the field location and dimensions
- @param fieldName the field name. It must not be null
- @param onValue the value when the field is checked
- TYPE_CHECK,
- TYPE_CIRCLE,
- TYPE_CROSS,
- TYPE_DIAMOND,
- TYPE_SQUARE and
- TYPE_STAR.
- @param checkType the checked symbol
- true for checked
- and false for unchecked
- true for a radio field and false
- for a check field
- @param on true for the checked state, false
- otherwise
- @throws IOException on error
- @throws DocumentException on error
- @return the appearance
- true for the checked state, false
- otherwise
- @return the appearance
- true, exactly one radio button must be selected at all
- times; clicking the currently selected button has no effect.
- If false, clicking
- the selected button deselects it, leaving no button selected.
- @param radiosInUnison if true, a group of radio buttons within a radio button field that
- use the same value for the on state will turn on and off in unison; that is if
- one is checked, they are all checked. If false, the buttons are mutually exclusive
- (the same behavior as HTML radio buttons)
- @return the radio group
- true to get a radio field, false to get
- a check field
- @throws IOException on error
- @throws DocumentException on error
- @return the field
-
- if (certificate.PrivateKey is RSACryptoServiceProvider)
- {
- RSACryptoServiceProvider rsa = (RSACryptoServiceProvider)certificate.PrivateKey;
-
- // Modified by J. Arturo
- // Workaround for SHA-256 and SHA-512
-
- if (rsa.CspKeyContainerInfo.ProviderName == "Microsoft Strong Cryptographic Provider" ||
- rsa.CspKeyContainerInfo.ProviderName == "Microsoft Enhanced Cryptographic Provider v1.0" ||
- rsa.CspKeyContainerInfo.ProviderName == "Microsoft Base Cryptographic Provider v1.0")
- {
- string providerName = "Microsoft Enhanced RSA and AES Cryptographic Provider";
- int providerType = 24;
-
- Type CspKeyContainerInfo_Type = typeof(CspKeyContainerInfo);
-
- FieldInfo CspKeyContainerInfo_m_parameters = CspKeyContainerInfo_Type.GetField("m_parameters", BindingFlags.NonPublic | BindingFlags.Instance);
- CspParameters parameters = (CspParameters)CspKeyContainerInfo_m_parameters.GetValue(rsa.CspKeyContainerInfo);
-
- var cspparams = new CspParameters(providerType, providerName, rsa.CspKeyContainerInfo.KeyContainerName);
- cspparams.Flags = parameters.Flags;
-
- using (var rsaKey = new RSACryptoServiceProvider(cspparams))
- {
- // use rsaKey now
- }
- }
- else
- {
- // Use rsa directly
- }
- }
-
-
- null
- @param calendar the date or null for the current date
- @return a String with the error description or null
- if no error
- KeyStore
- @param crls the certificate revocation list or null
- @param calendar the date or null for the current date
- @return null if the certificate chain could be validated or a
- Object[]{cert,error} where cert is the
- failed certificate and error is the error message
- KeyStore
- @param calendar the date or null for the current date
- @return null if the certificate chain could be validated or a
- Object[]{cert,error} where cert is the
- failed certificate and error is the error message
- KeyStore
- @param provider the provider or null to use the BouncyCastle provider
- @return true is a certificate was found
- KeyStore
- @param provider the provider or null to use the BouncyCastle provider
- @return true is a certificate was found
- VerificationOK objects.
- The list will be empty if the certificate couldn't be verified.
- @throws GeneralSecurityException
- @throws IOException
- VerificationOK objects.
- The list will be empty if the certificate couldn't be verified.
- @see com.itextpdf.text.pdf.security.RootStoreVerifier#verify(java.security.cert.X509Certificate, java.security.cert.X509Certificate, java.util.Date)
- null for the highest revision.
- VerificationOK objects.
- The list will be empty if the certificate couldn't be verified.
- @throws GeneralSecurityException
- @throws IOException
- @see com.itextpdf.text.pdf.security.RootStoreVerifier#verify(java.security.cert.X509Certificate, java.security.cert.X509Certificate)
- VerificationOK objects.
- The list will be empty if the certificate couldn't be verified.
- @see com.itextpdf.text.pdf.security.RootStoreVerifier#verify(java.security.cert.X509Certificate, java.security.cert.X509Certificate, java.util.Date)
- null for the default provider
- @param hasRSAdata true if the sub-filter is adbe.pkcs7.sha1
- @throws InvalidKeyException on error
- @throws NoSuchProviderException on error
- @throws NoSuchAlgorithmException on error
- null for the default provider
- null if the digest
- is also null. If the digest is not null
- then it may be "RSA" or "DSA"
- null, none will be used.
- @param secondDigest the digest in the authenticatedAttributes
- @return the bytes for the PKCS7SignedData object
- true if the signature checks out, false otherwise
- VerificationOK objects.
- The list will be empty if the certificate couldn't be verified.
- - Created by Aiken Sam, 2006-11-15, refactored by Martin Brunecky, 07/15/2007 - for ease of subclassing. -
- @since 2.1.6 -Integer
- Color.
-
- @author Paulo Soares
- List with the bookmarks. It returns null if
- the document doesn't have any bookmarks.
- @param reader the document
- @return a List with the bookmarks or null if the
- document doesn't have any
- List with the bookmarks that are children of outline. It returns null if
- the document doesn't have any bookmarks.
- @param reader the document
- @param outline the outline dictionary to get bookmarks from
- @param includeRoot indicates if to include outline parameter itself into returned list of bookmarks
- @return a List with the bookmarks or null if the
- document doesn't have any
- pageShift to the page number.
- The page ranges
- consists of a number of pairs with the start/end page range. The page numbers
- are inclusive.
- @param list the bookmarks
- @param pageShift the number to add to the pages in range
- @param pageRange the page ranges, always in pairs. It can be null
- to include all the pages
- -1 for no indents.
- @param onlyASCII codes above 127 will always be escaped with &#nn; if true,
- whatever the encoding
- @throws IOException on error
- true,
- whatever the encoding
- @throws IOException on error
- true,
- whatever the encoding
- @throws IOException on error
- PdfContentByte. All
- the members are copied by reference but the buffer stays different.
-
- @return a copy of this PdfContentByte
- byte array according to the PDF conventions.
-
- @param b the byte array to escape
- @return an escaped byte array
- byte array according to the PDF conventions.
-
- @param b the byte array to escape
- TextField.
- @param writer the document PdfWriter
- @param box the field location and dimensions
- @param fieldName the field name. If null only the widget keys
- will be included in the field allowing it to be used as a kid field.
- String.
- Every character is replaced by an asterisk (*).
-
- @param text
- @return String
- @since 2.1.5
- PdfAppearance of a text or combo field
- @throws IOException on error
- @throws DocumentException on error
- @return A PdfAppearance
- PdfAppearance of a list field
- @throws IOException on error
- @throws DocumentException on error
- @return A PdfAppearance
- null then the choice values will also be used
- as the export values.
- @param choiceExports the export values in list/combo fields
- BaseFont and can also be null. The fonts in this list will be used if the original
- font doesn't contain the needed glyphs.
- @param substitutionFonts the list
- null.
- @param extensionFont New value of property extensionFont.
- int[2] where position 0
- is the offset from the start of the file and position 1 is the length
- of the table.
- string for a
- TTF file.
- int[2] where position 0
- is the glyph number and position 1 is the glyph width normalized to 1000
- units.
- Integer where the top 16 bits
- are the glyph number for the first character and the lower 16 bits are the
- glyph number for the second character. The value is the amount of kerning in
- normalized 1000 units as an Integer. This value is usually negative.
- true if all the glyphs have the same width.
- byte array
- @throws DocumentException the font is invalid
- @throws IOException the font file could not be read
- byte array, possibly null
- @throws DocumentException the font is invalid
- @throws IOException the font file could not be read
- string from the font file as bytes using the Cp1252
- encoding.
- @param length the length of bytes to read
- @return the string read
- @throws IOException the font file could not be read
- string from the font file. Each character is
- represented by two bytes.
- @param length the length of bytes to read. The string will have length/2
- characters
- @return the string read
- @throws IOException the font file could not be read
- Hashtable representing this map
- @throws IOException the font file could not be read
- Hashtable representing this map
- @throws IOException the font file could not be read
- Hashtable representing this map
- @throws IOException the font file could not be read
- c.
- If the name is null it's a symbolic font.
- @param c the unicode char
- @param name the glyph name
- @return the width of the char
- null
- @param subsetPrefix the subset prefix
- @param fontStream the indirect reference to a PdfStream containing the font or null
- @throws DocumentException if there is an error
- byte array where each unused byte is represented by 0
- @param fontDescriptor the indirect reference to a PdfDictionary containing the font descriptor or null
- @throws DocumentException if there is an error
- key. Valid values
- for key are ASCENT, CAPHEIGHT, DESCENT
- and ITALICANGLE.
- @param key the parameter to be extracted
- @param fontSize the font size in points
- @return the parameter in points
- int array with {glyph index, width}
- true if the font has any kerning pairs
- true if the kerning was applied, false otherwise
- true if the font can be correctly used with winansi encodings
- int[3] where position 0
- is the checksum, position 1 is the offset from the start of the file
- and position 2 is the length of the table.
- true if the table cmap is to be included in the generated font
- string from the font file as bytes using the Cp1252
- encoding.
- @param length the length of bytes to read
- @return the string read
- @throws IOException the font file could not be read
- byte array
- @throws DocumentException the font is invalid
- @throws IOException the font file could not be read
- char in normalized 1000 units.
- @param char1 the unicode char to get the width of
- @return the width in normalized 1000 units
- string in normalized 1000 units.
- @param text the string to get the witdth of
- @return the width in normalized 1000 units
- null
- null
- int array with {glyph index, width}
- true if the character has a glyph,
- false otherwise
- true if the advance was set,
- false otherwise
- byte array.
- true if all the characters have the same
- width.
- Object[4] with an
- Integer, Integer, String and int[]. This is the code, width, name and char bbox.
- The key is the name of the char and also an Integer with the char number.
- Object[]
- with 2 elements for each kern pair. Position 0 is the name of
- the second character and position 1 is the kerning distance. This is
- repeated for all the pairs.
- true if this font is one of the 14 built in fonts.
- byte array
- @param pfb the PFB file if the input is made with a byte array
- @param afmFile the name of one of the 14 built-in fonts or the location of an AFM file. The file must end in '.afm'
- @param enc the encoding to be applied to this font
- @param emb true if the font is to be embedded in the PDF
- @throws DocumentException the AFM file is invalid
- @throws IOException the AFM file could not be read
- name or,
- if the name is null, meaning it is a symbolic font,
- the char c.
- @param c the char if the font is symbolic
- @param name the glyph name
- @return the width of the char
- Hashtable KernPairs.
- @param char1 the first char
- @param char2 the second char
- @return the kerning to be applied
- false or if the font is
- one of the 14 built in types, it returns null,
- otherwise the font is read and output in a PdfStream object.
- @return the PdfStream containing the font or null
- @throws DocumentException if there is an error reading the font
- null if it is
- one of the 14 built in fonts.
- @param fontStream the indirect reference to a PdfStream containing the font or null
- @return the PdfDictionary containing the font descriptor or null
- byte array where each unused byte is represented by 0
- @param fontDescriptor the indirect reference to a PdfDictionary containing the font descriptor or null
- key. Valid values
- for key are ASCENT, CAPHEIGHT, DESCENT,
- ITALICANGLE, BBOXLLX, BBOXLLY, BBOXURX
- and BBOXURY.
- @param key the parameter to be extracted
- @param fontSize the font size in points
- @return the parameter in points
- key. Valid values
- for key are ASCENT, CAPHEIGHT, DESCENT,
- ITALICANGLE, BBOXLLX, BBOXLLY, BBOXURX
- and BBOXURY.
- @param key the parameter to be updated
- @param value the parameter value
- true if the font has any kerning pairs
- true if the kerning was applied, false otherwise
- true the font may specify color, if false no color commands are allowed
- and only images as masks can be used
- colorize option is
- true the value is ignored
- @param lly the Y lower left corner of the glyph bounding box. If the colorize option is
- true the value is ignored
- @param urx the X upper right corner of the glyph bounding box. If the colorize option is
- true the value is ignored
- @param ury the Y upper right corner of the glyph bounding box. If the colorize option is
- true the value is ignored
- @return a content where the glyph can be defined
- PdfContent where the text will be written to.
- Phrase to the current text array.
- @param phrase the text
- Chunk to the current text array.
- @param chunk the text
- go(false).
- @return returns the result of the operation. It can be NO_MORE_TEXT
- and/or NO_MORE_COLUMN
- @throws DocumentException on error
- true to simulate the writting to the document
- @return returns the result of the operation. It can be NO_MORE_TEXT
- and/or NO_MORE_COLUMN
- @throws DocumentException on error
- go().
- @return the X coordinate
- go().
- @return Value of property maxLines.
- PdfReader. It basically does everything
- from finding the XFA stream to the XML parsing.
- @param reader the reader
- @throws java.io.IOException on error
- @throws javax.xml.parsers.ParserConfigurationException on error
- @throws org.xml.sax.SAXException on error
- true if it is a XFA form.
- @return true if it is a XFA form
- null if not found
- null if not found
- Node contained in the datasets section from a
- possibly partial name.
- @param name the complete or partial name
- @return the Node or null if not found
- Node
- @return the text found or "" if no text was found
- Node to add the text to
- @param text the text to add
- PdfReader to be used by this instance.
- @param reader the PdfReader to be used by this instance
- true if this XFA form was changed
- true if a similitude was found
- item argument
- true if and only if this stack contains no items; false otherwise
- #subform removed.
- @param s the long name
- @return the short name
- null if not found
- Node that will match the short name.
- @param n the datasets top Node
- @param shortName the short name
- @return the new Node of the inserted name
- template section of the XFA.
- @param s the exact template name
- @return the field type or null if not found
- true if it's a dynamic form; false
- if it's a static form.
- @return true if it's a dynamic form; false
- if it's a static form
- Node that corresponds to the datasets part.
- @return the Node that corresponds to the datasets part
- PdfDictionary
- with the field content.
- @return all the fields
- null if the field does not
- exist or has no value defined.
- @param name the fully qualified field name
- @return the field value or null
- null if the field does not
- exist or has no value defined.
- @param name the fully qualified field name
- @return the field values or null
- @since 2.1.4
- tableLayout method and before the table is drawn.
-
- @param table the PdfPTable in use
- ArrayList
- ElementListener.
-
- @param listener an ElementListener
- @return true if the element was processed successfully
- Anchor with a certain Phrase.
-
- @param phrase a Phrase
-
- Paragraph title2 = new Paragraph("This is Chapter 2", FontFactory.GetFont(FontFactory.HELVETICA, 18, Font.BOLDITALIC, new BaseColor(0, 0, 255)));
- Chapter chapter2 = new Chapter(title2, 2);
- chapter2.SetNumberDepth(0);
- Paragraph someText = new Paragraph("This is some text");
- chapter2.Add(someText);
- Paragraph title21 = new Paragraph("This is Section 1 in Chapter 2", FontFactory.GetFont(FontFactory.HELVETICA, 16, Font.BOLD, new BaseColor(255, 0, 0)));
- Section section1 = chapter2.AddSection(title21);
- Paragraph someSectionText = new Paragraph("This is some silly paragraph in a chapter and/or section. It contains some text to test the functionality of Chapters and Section.");
- section1.Add(someSectionText);
-
- Chapter.
- @param number the Chapter number
- Paragraph)
- String)
- String)
- @return Returns the new section.
- Paragraph)
- @return Returns the new section.
-
- Chunk chunk = new Chunk("Hello world", FontFactory.GetFont(FontFactory.COURIER, 20, Font.ITALIC, new BaseColor(255, 0, 0)));
- document.Add(chunk);
-
- Chunk copy constructor.
- @param ck the Chunk to be copied
- Font.
-
- @param c the content
- @param font the font
- Font.
-
- @param c the content
- Chunk.
-
- @return false if there aren't any.
- Chunk
- Chunk width. Multiple call to this method will
- produce multiple lines.
- @param thickness the absolute thickness of the line
- @param yPosition the absolute y position relative to the baseline
- @return this Chunk
- Chunk width. Multiple call to this method will
- produce multiple lines.
- @param color the color of the line or null to follow
- the text color
- @param thickness the absolute thickness of the line
- @param thicknessMul the thickness multiplication factor with the font size
- @param yPosition the absolute y position relative to the baseline
- @param yPositionMul the position multiplication factor with the font size
- @param cap the end line cap. Allowed values are
- PdfContentByte.LINE_CAP_BUTT, PdfContentByte.LINE_CAP_ROUND and
- PdfContentByte.LINE_CAP_PROJECTING_SQUARE
- @return this Chunk
- alpha=0 and beta=12.
- @param alpha the first angle in degrees
- @param beta the second angle in degrees
- @return this Chunk
- Chunk.
- @param color the color of the background
- @param extraLeft increase the size of the rectangle in the left
- @param extraBottom increase the size of the rectangle in the bottom
- @param extraRight increase the size of the rectangle in the right
- @param extraTop increase the size of the rectangle in the top
- @return this Chunk
- PdfContentByte.TEXT_RENDER_MODE_FILL,
- PdfContentByte.TEXT_RENDER_MODE_STROKE, PdfContentByte.TEXT_RENDER_MODE_FILL_STROKE
- and PdfContentByte.TEXT_RENDER_MODE_INVISIBLE.
- @param strokeWidth the stroke line width for the modes PdfContentByte.TEXT_RENDER_MODE_STROKE and
- PdfContentByte.TEXT_RENDER_MODE_FILL_STROKE.
- @param strokeColor the stroke color or null to follow the text color
- @return this Chunk
- Chunk
- Chunk
- Chunk
-
- // creation of the document with a certain size and certain margins
- Document document = new Document(PageSize.A4, 50, 50, 50, 50);
- try {
- // creation of the different writers
- HtmlWriter.GetInstance(document, System.out);
- PdfWriter.GetInstance(document, new FileOutputStream("text.pdf"));
- // we add some meta information to the document
- document.AddAuthor("Bruno Lowagie");
- document.AddSubject("This is the result of a Test.");
-
- // we define a header and a footer
- HeaderFooter header = new HeaderFooter(new Phrase("This is a header."), false);
- HeaderFooter footer = new HeaderFooter(new Phrase("This is page "), new Phrase("."));
- footer.SetAlignment(Element.ALIGN_CENTER);
- document.SetHeader(header);
- document.SetFooter(footer);
- // we open the document for writing
- document.Open();
- document.Add(new Paragraph("Hello world"));
- }
- catch (DocumentException de) {
- Console.Error.WriteLine(de.Message);
- }
- document.Close();
-
- true if successfull, false otherwise
- true if writing temporarely has to be paused, false otherwise.
- Element.
- Element.
- @since 2.1.5
- Element.
- @since 5.3.0
- Element.
- Element.
- @since 2.1.2
-
- Paragraph p = new Paragraph("This is a paragraph",
- new Font(Font.HELVETICA, 18, Font.BOLDITALIC, new BaseColor(0, 0, 255)));
-
- BaseFont.
- @return the size that can be used with the calculated BaseFont
- BaseFont.
- @return the style that can be used with the calculated BaseFont
- BaseFont this class represents.
- For the built-in fonts a BaseFont is calculated.
- @param specialEncoding true to use the special encoding for Symbol and ZapfDingbats,
- false to always use Cp1252
- @return the BaseFont this class represents
- LIST whitch use greek-letters.
-
- @see com.lowagie.text.List
- Object to the List.
-
- @param o the object to add.
- @return true if adding the object succeeded
-
- Header header = new Header("inspired by", "William Shakespeare");
-
- String to the HTML-format of this String.
-
- @param string The String to convert
- @return a String
- BaseColor into a HTML representation of this BaseColor.
-
- @param color the BaseColor that has to be converted.
- @return the HTML representation of this DocListener
- DocListener
- @param tags A map containing the supported tags
- @param style A StyleSheet
- @since 5.0.6
- BaseColor into a HTML representation of this
- BaseColor.
-
- @param s
- the BaseColor that has to be converted.
- @return the HTML representation of this Font-object.
-
- @param fontname the name of the font
- @param encoding the encoding of the font
- @param embedded true if the font is to be embedded in the PDF
- @param size the size of this font
- @param style the style of this font
- @param color the BaseColor of this font.
- @return the Font constructed based on the parameters
- Stream to get the resource or
- null if not found
- Jpeg2000 is the representation of a graphic element (JPEG)
- that has to be inserted into the document
-
- @see Element
- @see Image
- Jpeg2000-object, using an url.
-
- @param url the URL where the image can be found
- @throws BadElementException
- @throws IOException
- Jpeg2000-object from memory.
-
- @param img the memory image
- @throws BadElementException
- @throws IOException
- Jpeg2000-object from memory.
-
- @param img the memory image.
- @param width the width you want the image to have
- @param height the height you want the image to have
- @throws BadElementException
- @throws IOException
- true if the image is JP2, false if a codestream.
-
- List list = new List(true, 20);
- list.Add(new ListItem("First line"));
- list.Add(new ListItem("The second line is longer to see what happens once the end of the line is reached. Will it start on a new line?"));
- list.Add(new ListItem("Third line"));
-
-
- The result of this code looks like this:
-
- List overview = new List(false, 10);
- overview.Add(new ListItem("This is an item"));
- overview.Add("This is another item");
-
-
- The result of this code looks like this:
- List.
- List with a specific symbol indentation.
- @param symbolIndent the symbol indentation
- @since iText 2.0.8
- List.
-
- @param numbered a bool
- List.
-
- @param numbered a bool
- @param lettered has the list to be 'numbered' with letters
- true if the list is empty.
-
- @return true if the list is empty
-
- List list = new List(true, 20);
- list.Add(new ListItem("First line"));
- list.Add(new ListItem("The second line is longer to see what happens once the end of the line is reached. Will it start on a new line?"));
- list.Add(new ListItem("Third line"));
-
-
- The result of this code looks like this:
-
- List overview = new List(false, 10);
- overview.Add(new ListItem("This is an item"));
- overview.Add("This is another item");
-
-
- The result of this code looks like this:
- CounterFactory.getInstance().setCounter(new SysoCounter());
- SysoCounter is just an example of a Counter implementation.
- It writes info about files being read and written to the System.out.
-
- This functionality can be used to create metrics in a SaaS context.
- ArrayList
- ElementListener.
-
- @param listener an ElementListener
- @return true if the element was processed successfully
- Paragraph, List or Table
- to this Section.
-
- @param index index at which the specified element is to be inserted
- @param o an object of type Paragraph, List or Table=
- @throws ClassCastException if the object is not a Paragraph, List or Table
- Paragraph, List, Table or another Section
- to this Section.
-
- @param o an object of type Paragraph, List, Table or another Section
- @return a bool
- @throws ClassCastException if the object is not a Paragraph, List, Table or Section
- ElementListener.
-
- @param listener an ElementListener
- @return true if the element was processed successfully
- Elements
- to this Section.
-
- @param collection a collection of Paragraphs, Lists and/or Tables
- @return true if the action succeeded, false if not.
- @throws ClassCastException if one of the objects isn't a Paragraph, List, Table
- Section, adds it to this Section and returns it.
-
- @param indentation the indentation of the new section
- @param numberDepth the numberDepth of the section
- @return a new Section object
- Section, adds it to this Section and returns it.
-
- @param indentation the indentation of the new section
- @return a new Section object
- Section, add it to this Section and returns it.
-
- @param numberDepth the numberDepth of the section
- @return a new Section object
- Section, adds it to this Section and returns it.
-
- @return a new Section object
- Section on the left side.
-
- @param indentation the indentation
- Section on the right side.
-
- @param indentation the indentation
- Section.
-
- @param indentation the indentation
-
- Paragraph p = new Paragraph("This is a paragraph",
- FontFactory.GetFont(FontFactory.HELVETICA, 18, Font.BOLDITALIC, new BaseColor(0, 0, 255)));
-
-
- // When no parameters are passed, the default leading = 16
- Phrase phrase0 = new Phrase();
- Phrase phrase1 = new Phrase("this is a phrase");
- // In this example the leading is passed as a parameter
- Phrase phrase2 = new Phrase(16, "this is a phrase with leading 16");
- // When a Font is passed (explicitely or embedded in a chunk), the default leading = 1.5 * size of the font
- Phrase phrase3 = new Phrase("this is a phrase with a red, normal font Courier, size 12", FontFactory.GetFont(FontFactory.COURIER, 12, Font.NORMAL, new Color(255, 0, 0)));
- Phrase phrase4 = new Phrase(new Chunk("this is a phrase"));
- Phrase phrase5 = new Phrase(18, new Chunk("this is a phrase", FontFactory.GetFont(FontFactory.HELVETICA, 16, Font.BOLD, new Color(255, 0, 0)));
-
- Phrase.
- String to this Phrase.
-
- @param s a string
- @return a boolean
- @since 5.0.1
- Rectangle-object.
-
- @param llx lower left x
- @param lly lower left y
- @param urx upper right x
- @param ury upper right y
- @param rotation the rotation (0, 90, 180, or 270)
- @since iText 5.0.6
- Rectangle-object starting from the origin
- (0, 0) and with a specific rotation (valid values are 0, 90, 180, 270).
-
- @param urx upper right x
- @param ury upper right y
- @param rotation the rotation of the rectangle
- @since iText 5.0.6
- Rectangle-object based on a com.itextpdf.awt.geom.Rectangle object
- @param rect com.itextpdf.awt.geom.Rectangle
- Rectangle object
- except the position.
-
- @param rect
- Rectangle to copy from
- Rectangle object
- except the position.
-
- @param rect
- Rectangle to copy from
- LEFT, RIGHT, TOP, BOTTOM
-
- LEFT, RIGHT, TOP, BOTTOM
-
- RectangleReadOnly -object.
-
- @param llx lower left x
- @param lly lower left y
- @param urx upper right x
- @param ury upper right y
- @param rotation the rotation of the Rectangle (0, 90, 180, 270)
- @since iText 5.0.6
- RectangleReadOnly-object starting from the origin
- (0, 0) and with a specific rotation (valid values are 0, 90, 180, 270).
-
- @param urx upper right x
- @param ury upper right y
- @since iText 5.0.6
- Rectangle object
- except the position.
-
- @param rect
- Rectangle to copy from
- Rectangle object
- except the position.
-
- @param rect
- Rectangle to copy from
- LEFT, RIGHT, TOP, BOTTOM
-
- LEFT, RIGHT, TOP, BOTTOM
-
- LIST which use roman-letters.
-
- @see com.lowagie.text.List
- @version 2003-06-22
- @author Michael Niedermair
- Object to the List.
-
- @param o the object to add.
- @return true if adding the object succeeded
-
- Paragraph title2 = new Paragraph("This is Chapter 2", FontFactory.GetFont(FontFactory.HELVETICA, 18, Font.BOLDITALIC, new Color(0, 0, 255)));
- Chapter chapter2 = new Chapter(title2, 2);
- Paragraph someText = new Paragraph("This is some text");
- chapter2.Add(someText);
- Paragraph title21 = new Paragraph("This is Section 1 in Chapter 2", FontFactory.GetFont(FontFactory.HELVETICA, 16, Font.BOLD, new Color(255, 0, 0)));
- Section section1 = chapter2.AddSection(title21);
- Paragraph someSectionText = new Paragraph("This is some silly paragraph in a chapter and/or section. It contains some text to test the functionality of Chapters and Section.");
- section1.Add(someSectionText);
- Paragraph title211 = new Paragraph("This is SubSection 1 in Section 1 in Chapter 2", FontFactory.GetFont(FontFactory.HELVETICA, 14, Font.BOLD, new Color(255, 0, 0)));
- Section section11 = section1.AddSection(40, title211, 2);
- section11.Add(someSectionText);strong>
-
- String.
-
- @param string a String
- @return an index of -1 if no special symbol was found
- null
- @param item the item to be added to the array
- @return a new array with the item appended
- ParserBase-class provides XML document parsing.
- SimpleXMLParser.
- @author Paulo Soares
- SimpleXMLParser.
- @author Paulo Soares
- true
- @return the escaped string
- p,
- blockqouteand br
-
- @author Balder
-
- Document that contains the node
- @param n the Node to add the text to
- @param value the text to add
- getProperty().
- @param value the value for the property (only leaf properties have a value).
- Arrays and non-leaf levels of structs do not have values.
- Must be null if the value is not relevant.toString() is called.
- @throws XMPException Wraps all errors and exceptions that may occur.
- true
- @return the escaped string
- @since 5.0.6
- LIST whitch use zapfdingbats-letters.
-
- @see com.lowagie.text.List
- @author Michael Niedermair and Bruno Lowagie
- Object to the List.
-
- @param o the object to add.
- @return true if adding the object succeeded
- LIST whitch use zapfdingbats-numbers (1..10).
-
- @see com.lowagie.text.List
- @version 2003-06-22
- @author Michael Niedermair
- Object to the List.
-
- @param o the object to add.
- @return true if adding the object succeeded
- TYPE_UNKNOWN is an initial type value
- type
- linefeed characters;
- must be dividable by four; 0 means no linefeeds
- ByteBuffer.
- ByteBuffer.
- the length of valid bytes in the array
- ByteBuffer.
- the offset of the provided buffer.
- the length of valid bytes in the array
- ByteBuffer
- OutputStream that counts the written bytes.
-
- @since 08.11.2006
- OutputStream
- FilterReader itself
- provides default methods that pass all requests to
- the contained stream. Subclasses of FilterReader
- should override some of these methods and may also provide
- additional methods and fields.
-
- @author Mark Reinhold
- @since JDK1.1
- Calendar with millisecond resolution.
-
- @since 16.02.2006
- (char)c.
- cbuf[off], the
- character after that will have the value cbuf[off+1], and
- so forth.
- cbuf[0], the character after that
- will have the value cbuf[1], and so forth.
- XMPDateTime. Internally a calendar is used
- plus an additional nano seconds field, because Calendar supports only milli
- seconds. The nanoSeconds convers only the resolution beyond a milli second.
-
- @since 16.02.2006
- XMPDateTime-instance with the current time in the default time
- zone.
- XMPDateTime-instance from a calendar.
- Calendar
- XMPDateTime-instance from
- a Date and a TimeZone.
- XMPDateTime-instance from an ISO 8601 string.
- XMPIterator implementation.
- Iterates the XMP Tree according to a set of options.
- During the iteration the XMPMeta-object must not be changed.
- Calls to skipSubtree() / skipSiblings() will affect the iteration.
-
- @since 29.06.2006
- propName is provided,
- schemaNs has also be provided. schemaNs
- advanced iteration options, see XMPIterator implementation.
- It first returns the node itself, then recursivly the children and qualifier of the node.
-
- @since 29.06.2006
- PropertyInfo to return hasNext(). XMPNode. XMPNode
- the base namespace to report
- the full property path
- XMPProperty-object that serves representation of the node. NodeIterator,
- and is only used for the option XMPNode contracts.
- null
-
- options for the new node, must not be null.
- flag if the existing value is to be overwritten
- ExpatAdapter.cpp and does the
- XML-parsing and fixes the prefix. After the parsing several normalisations
- are applied to the XMPTree.
-
- @since 01.02.2006
- InputStream, a String or
- a byte buffer containing the XMP packet.
- the parse options
- InputStream
- the parsing options
- String containing the XMP packet
- the parsing options
- XMPNode with initial values.
- XMPNode if node has been found, null otherwise. XMPNode if node has been found,
- null otherwise. nulls. XMPNode.
-
- @since Aug 28, 2006
- createNodes is false and
- null otherwise.
- Note: If createNodes is true, it is always
- returned a valid node. createNodes is true.
- null otherwise.
- Note: If createNodes is true, it is always
- returned a valid node. null. setProperty())
- the options for the created leaf nodes (only when
- createNodes == true).
- null. null they are created with default values.
- PropertyOptions
- the node value to set
- null otherwise. - 1. If there is no dc:rights array, or an empty array - - Create one with dc:rights['x-default'] set from double linefeed and xmpDM:copyright. - - 2. If there is a dc:rights array but it has no x-default item - - Create an x-default item as a copy of the first item then apply rule #3. - - 3. If there is a dc:rights array with an x-default item, - Look for a double linefeed in the value. - A. If no double linefeed, compare the x-default value to the xmpDM:copyright value. - A1. If they match then leave the x-default value alone. - A2. Otherwise, append a double linefeed and - the xmpDM:copyright value to the x-default value. - B. If there is a double linefeed, compare the trailing text to the xmpDM:copyright value. - B1. If they match then leave the x-default value alone. - B2. Otherwise, replace the trailing x-default text with the xmpDM:copyright value. - - 4. In all cases, delete the xmpDM:copyright property. --
XMPAliasInfo-object.
- XMPMeta-object to an OutputStream according to the
- SerializeOptions.
-
- @since 11.07.2006
- null for default.
- XMPMeta-object as RDF into a string.
- Note: Encoding is forced to UTF-16 when serializing to a
- string to ensure the correctness of "exact packet size".
- XMPMeta-object as RDF into a byte buffer.
- XMPMeta-object using the standard RDF serialization format.
- The output is written to an OutputStream
- according to the SerializeOptions.
-
- @since 11.07.2006
- - -- - *** Consider numbered array items, but has compatibility problems. *** - Consider qualified form with rdf:Description and attributes. -- <ns:UnqualifiedStructProperty-1 - ... The fields as attributes, if all are simple and unqualified - /> - - <ns:UnqualifiedStructProperty-2 rdf:parseType="Resource"> - ... The fields as elements, if none are simple and unqualified - </ns:UnqualifiedStructProperty-2> - - <ns:UnqualifiedStructProperty-3> - <rdf:Description - ... The simple and unqualified fields as attributes - > - ... The compound or qualified fields as elements - </rdf:Description> - </ns:UnqualifiedStructProperty-3> - - <ns:UnqualifiedArrayProperty> - <rdf:Bag> or Seq or Alt - ... Array items as rdf:li elements, same forms as top level properties - </rdf:Bag> - </ns:UnqualifiedArrayProperty> - - <ns:QualifiedProperty rdf:parseType="Resource"> - <rdf:value> ... Property "value" - following the unqualified forms ... </rdf:value> - ... Qualifiers looking like named struct fields - </ns:QualifiedProperty> -- -
- --- <ns:UnqualifiedSimpleProperty>value</ns:UnqualifiedSimpleProperty> - - <ns:UnqualifiedStructProperty> (If no rdf:resource qualifier) - <rdf:Description> - ... Fields, same forms as top level properties - </rdf:Description> - </ns:UnqualifiedStructProperty> - - <ns:ResourceStructProperty rdf:resource="URI" - ... Fields as attributes - > - - <ns:UnqualifiedArrayProperty> - <rdf:Bag> or Seq or Alt - ... Array items as rdf:li elements, same forms as top level properties - </rdf:Bag> - </ns:UnqualifiedArrayProperty> - - <ns:QualifiedProperty> - <rdf:Description> - <rdf:value> ... Property "value" following the unqualified - forms ... </rdf:value> - ... Qualifiers looking like named struct fields - </rdf:Description> - </ns:QualifiedProperty> -- -
' is never serialized. Note:
- Control chars are written unescaped, but if the user uses others than tab, LF
- and CR the resulting XML will become invalid.
- separateArrayItems(). doAllProperties. Empty schemas are automatically remove
- by XMPNode
- XMPNode
- an XMPNode
- XmpPath.
-
- @since 23.06.2006
- next() is
- called.
- next() is called.
- OutputStream.
-
- @since 20.01.2006
- null is returned. null or the empty string. Has the same namespace prefix usage as
- propName in GetProperty().
- The index of the desired item. Arrays in XMP are indexed from 1. The
- constant XMPProperty containing the value and the options or
- null if the property does not exist. null or the empty string. Has the same namespace prefix usage as
- propName in GetProperty().
- null or the empty string. Has the same namespace prefix usage as
- propName in GetProperty.
- The index of the desired item. Arrays in XMP are indexed from 1. To address
- the last existing item, use SetProperty().
- the set options for the item.
- null or the empty string. Has the same namespace prefix usage as
- propName in GetProperty.
- The index to insert the new item. Arrays in XMP are indexed from 1. Use
- XmpConst.ARRAY_LAST_ITEM to append items.
- the new value of the array item. Has the same usage as
- propValue in SetProperty().
- the set options that decide about the kind of the node.
- null or the empty string. Has the same namespace prefix usage as the
- propName parameter.
- A pointer to the null terminated UTF-8 string that is the
- value of the qualifier, if the qualifier has a value. Has the same usage as propValue
- in GetProperty.
- Option flags describing the qualifier. See the earlier description.
- GetProperty().
- The name of the property. Has the same usage as in GetProperty.
- null or the empty string. Has the same namespace prefix usage as
- propName in GetProperty().
- The index of the desired item. Arrays in XMP are indexed from 1. The
- constant XmpConst.ARRAY_LAST_ITEM always refers to the last
- existing array item.
- GetProperty().
- The name of the struct. May be a general path expression, must not be
- null or the empty string. Has the same namespace prefix usage as
- propName in GetProperty.
- The namespace URI for the field. Has the same URI and prefix usage as the
- schemaNs parameter.
- The name of the field. Must be a single XML name, must not be
- null or the empty string. Has the same namespace prefix usage as the
- structName parameter.
- GetProperty().
- The name of the property to which the qualifier is attached. Has the same
- usage as in GetProperty.
- The namespace URI for the qualifier. Has the same URI and prefix usage as the
- schemaNs parameter.
- The name of the qualifier. Must be a single XML name, must not be
- null or the empty string. Has the same namespace prefix usage as the
- propName parameter.
- GetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- GetProperty().
- The name of the array. May be a general path expression, must not be
- null or the empty string. Has the same namespace prefix usage as
- propName in GetProperty().
- The index of the desired item. Arrays in XMP are indexed from 1. The
- constant XmpConst.ARRAY_LAST_ITEM always refers to the last
- existing array item.
- true if the array exists, false otherwise. GetProperty().
- The name of the struct. May be a general path expression, must not be
- null or the empty string. Has the same namespace prefix usage as
- propName in GetProperty().
- The namespace URI for the field. Has the same URI and prefix usage as the
- schemaNs parameter.
- The name of the field. Must be a single XML name, must not be
- null or the empty string. Has the same namespace prefix usage as the
- structName parameter.
- GetProperty().
- The name of the property to which the qualifier is attached. Has the same
- usage as in GetProperty().
- The namespace URI for the qualifier. Has the same URI and prefix usage as the
- schemaNs parameter.
- The name of the qualifier. Must be a single XML name, must not be
- null or the empty string. Has the same namespace prefix usage as the
- propName parameter.
- java.lang.Locale will be added.
-
- GetProperty().
- The name of the alt-text array. May be a general path expression, must not
- be null or the empty string. Has the same namespace prefix usage as
- propName in GetProperty().
- The name of the generic language as an RFC 3066 primary subtag. May be
- null or the empty string if no generic language is wanted.
- The name of the specific language as an RFC 3066 tag. Must not be
- null or the empty string.
- A pointer to the null terminated UTF-8 string that is the new
- value for the appropriate array item.
- Option flags, none are defined at present.
- GetProperty() and SetProperty() above,
- but the value is returned or provided in a literal form instead of as a UTF-8 string.
- The path composition functions in XMPPathFactory may be used to compose an path
- expression for fields in nested structures, items in arrays, or qualifiers.
- GetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- Boolean value or null
- if the property does not exist. GetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- Integer value or null
- if the property does not exist. GetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- Long value or null
- if the property does not exist. GetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- Double value or null
- if the property does not exist. GetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- XMPDateTime-object or null
- if the property does not exist. GetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- Calendar-object or null
- if the property does not exist. GetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- byte[]-array contained the decoded base64 value
- or null if the property does not exist. SetPropertyString(),
- because SetProperty() sets a string value.
- GetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- String value or null
- if the property does not exist. boolean value.
- SetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- the literal property value as boolean.
- options of the property to set (optional).
- int value.
- SetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- the literal property value as int.
- options of the property to set (optional).
- long value.
- SetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- the literal property value as long.
- options of the property to set (optional).
- double value.
- SetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- the literal property value as double.
- options of the property to set (optional).
- SetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- the property value as XMPDateTime.
- options of the property to set (optional).
- SetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- the property value as Java Calendar.
- options of the property to set (optional).
- byte[]-array,
- which is serialized as base64-string.
- SetProperty().
- The name of the property.
- Has the same usage as in GetProperty().
- the literal property value as byte array.
- options of the property to set (optional).
- null or empty String.
- Optional property name to restrict the iteration. May be an arbitrary path
- expression. Omitted (visit all properties) by passing null or empty
- String. If no schema URI is given, it is ignored.
- Option flags to control the iteration. See XMPIterator for this XMPMeta-object
- considering the given options. true.
- Note: It does no harm to call this method to an already normalized xmp object.
- It was a PDF/A requirement to get hand on the unnormalized XMPMeta object.
- null or the empty
- string.
-
- The name of the alias. May be an arbitrary path expression
- path, must not be null or the empty string.
- XMPAliasInfo for the given alias namespace and property or
- null if there is no such alias. XMPAliasInfo-object. XMPIterator construction.
-
- @since 24.01.2006
- XMPMeta-object
- and provide more detailed information about the property.
-
- @since 03.07.2006
- true by their name,
- like "option1 | option4". XMPIterator.
-
- @since 06.07.2006
- XMPDateTime-instances from a Calendar or an
- ISO 8601 string or for the current time.
-
- @since 16.02.2006
- XMPDateTime from a Calendar-object.
- Calendar-object.
- XMPDateTime-object. XMPDateTime-object. XMPDateTime-object. XMPDateTime from an ISO 8601 string.
- XMPDateTime-object. XMPDateTime variable containing the value to be modified.
- XMPDateTime-object. XMPDateTime variable containing the time to
- be modified.
- XMPDateTime-object. XMPDateTime variable containing the time to be modified.
- XMPDateTime-object. Throwable XMPMeta-instances from an InputStream
-
- @since 30.01.2006
- XMPSchemaRegistry.
- XMPSchemaRegistry. XMPMeta-object. XMPMeta-object as RDF into an OutputStream
- with default options.
- OutputStream to write the serialized RDF to.
- XMPMeta-object as RDF into an OutputStream.
- OutputStream to write the serialized RDF to.
- XMPMeta-object as RDF into a byte buffer.
- XMPMeta-object as RDF into a string. Note: Encoding
- is ignored when serializing to a string.
- XMPMetaImpl.s
- null or the empty string.
- The index of the desired item. Arrays in XMP are indexed from 1.
- 0 and below means last array item and renders as [last()].
-
- null or the empty
- string.
- The name of the field. Must be a simple XML name, must not be
- null or the empty string.
- null or the empty
- string if the qualifier is in the XML empty namespace.
- The name of the qualifier. Must be a simple XML name, must not be
- null or the empty string.
- null or the empty string.
-
- The RFC 3066 code for the desired language.
- deleteEmptyValues. int.
- rawValue is null or empty or the
- conversion fails. long.
- rawValue is null or empty or the
- conversion fails. double.
- rawValue is null or empty or the
- conversion fails. XMPDateTime.
- XMPDateTime-object. rawValue is null or empty or the
- conversion fails. XMPDateTime to string.
- XMPDateTime
-
-
-
+
-
-
-
-
-
@@ -96,1205 +96,14 @@
"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"
-
-
-
-
<mapping>
- <level value="ERROR" />
- <eventLogEntryType value="Error" />
+ <level value="ERROR" />
+ <eventLogEntryType value="Error" />
</mapping>
<mapping>
- <level value="DEBUG" />
- <eventLogEntryType value="Information" />
+ <level value="DEBUG" />
+ <eventLogEntryType value="Information" />
</mapping>
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
- IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
- UdpClient udpClient;
- byte[] buffer;
- string loggingEvent;
-
- try
- {
- udpClient = new UdpClient(8080);
-
- while(true)
- {
- buffer = udpClient.Receive(ref remoteEndPoint);
- loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
- Console.WriteLine(loggingEvent);
- }
- }
- catch(Exception e)
- {
- Console.WriteLine(e.ToString());
- }
-
-
- Dim remoteEndPoint as IPEndPoint
- Dim udpClient as UdpClient
- Dim buffer as Byte()
- Dim loggingEvent as String
-
- Try
- remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
- udpClient = new UdpClient(8080)
-
- While True
- buffer = udpClient.Receive(ByRef remoteEndPoint)
- loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
- Console.WriteLine(loggingEvent)
- Wend
- Catch e As Exception
- Console.WriteLine(e.ToString())
- End Try
-
-
-
-
-
-
+ IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
+ UdpClient udpClient;
+ byte[] buffer;
+ string loggingEvent;
+
+ try
+ {
+ udpClient = new UdpClient(8080);
+
+ while(true)
+ {
+ buffer = udpClient.Receive(ref remoteEndPoint);
+ loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
+ Console.WriteLine(loggingEvent);
+ }
+ }
+ catch(Exception e)
+ {
+ Console.WriteLine(e.ToString());
+ }
+
+
+ Dim remoteEndPoint as IPEndPoint
+ Dim udpClient as UdpClient
+ Dim buffer as Byte()
+ Dim loggingEvent as String
+
+ Try
+ remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
+ udpClient = new UdpClient(8080)
+
+ While True
+ buffer = udpClient.Receive(ByRef remoteEndPoint)
+ loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
+ Console.WriteLine(loggingEvent)
+ Wend
+ Catch e As Exception
+ Console.WriteLine(e.ToString())
+ End Try
+
+
+
+
+
+
+
+
+
+
+
+ log4net configuration XML goes here
+
+
+
+
- using log4net.Config;
- using System.IO;
- using System.Configuration;
-
- ...
-
- DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
-
-
-
-
-
-
-
-
- using log4net.Config;
- using System.IO;
- using System.Configuration;
-
- ...
-
- DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
-
-
-
-
-
-
-
-
-
-
-
-
-
- log4net configuration XML goes here
-
-
-
-
-
-
+
+
-
-
-
+
+
+
-
-
+
+
-
-
-
+
+
+
- ILog log = LogManager.GetLogger("application-log");
-
- log.Info("Application Start");
- log.Debug("This is a debug message");
-
- if (log.IsDebugEnabled)
- {
- log.Debug("This is another debug message");
- }
-
-
- log.Debug("This is entry number: " + i );
-
-
- if (log.IsDebugEnabled)
- {
- log.Debug("This is entry number: " + i );
- }
-
-
- private static readonly bool isDebugEnabled = log.IsDebugEnabled;
-
-
- if (isDebugEnabled)
- {
- log.Debug("This is entry number: " + i );
- }
-
-
if (log.IsDebugEnabled())
{
- log.Debug("This is entry number: " + i );
+ log.Debug("This is entry number: " + i );
}
+ GlobalContext.Properties["hostname"] = Environment.MachineName;
+
+
+ ILog log = LogManager.GetLogger("application-log");
+
+ log.Info("Application Start");
+ log.Debug("This is a debug message");
+
+ if (log.IsDebugEnabled)
+ {
+ log.Debug("This is another debug message");
+ }
+
+
- {key1=value1, key2=value2, key3=value3}
+
+ This method does not take an
+
+ log.Debug("This is entry number: " + i );
+ if (log.IsDebugEnabled)
+ {
+ log.Debug("This is entry number: " + i );
+ }
+
+
+ private static readonly bool isDebugEnabled = log.IsDebugEnabled;
+
+
+ if (isDebugEnabled)
+ {
+ log.Debug("This is entry number: " + i );
+ }
+
+ | Format modifier | -left justify | -minimum width | -maximum width | -comment | -
|---|---|---|---|---|
| %20logger | -false | -20 | -none | -
- |
-
| %-20logger | -true | -20 | -none | -
- |
-
| %.30logger | -NA | -none | -30 | -
- |
-
| false | -20 | -30 | -
- |
- |
| %-20.30logger | -true | -20 | -30 | -
- |
-
| Format modifier | +left justify | +minimum width | +maximum width | +comment | +
|---|---|---|---|---|
| %20logger | +false | +20 | +none | +
+ |
+
| %-20logger | +true | +20 | +none | +
+ |
+
| %.30logger | +NA | +none | +30 | +
+ |
+
| false | +20 | +30 | +
+ |
+ |
| %-20.30logger | +true | +20 | +30 | +
+ |
+
@@ -18271,12 +16845,12 @@
</log4net:events>
+ LogicalThreadContext.Properties["user"] = userName;
+ log.Info("This log message has a LogicalThreadContext Property called 'user'");
+
+
+ using(LogicalThreadContext.Stacks["LDC"].Push("my context message"))
+ {
+ log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'");
+
+ } // at the end of the using block the message is automatically popped
+
+
+ ILog log = LogManager.GetLogger("application-log");
+
+ log.Info("Application Start");
+ log.Debug("This is a debug message");
+
+ if (log.IsDebugEnabled)
+ {
+ log.Debug("This is another debug message");
+ }
+
+
+ using(NDC.Push("my context message"))
+ {
+ ... all log calls will have 'my context message' included ...
+
+ } // at the end of the using block the message is automatically removed
+
+
+ using(log4net.NDC.Push("NDC_Message"))
+ {
+ log.Warn("This should have an NDC message");
+ }
+
+
+ var someValue = "ExampleContext"
+ using(log4net.NDC.PushFormat("NDC_Message {0}", someValue))
+ {
+ log.Warn("This should have an NDC message");
+ }
+
+
+ ThreadContext.Properties["user"] = userName;
+ log.Info("This log message has a ThreadContext Property called 'user'");
+
+
+ using(ThreadContext.Stacks["NDC"].Push("my context message"))
+ {
+ log.Info("This log message has a ThreadContext Stack message that includes 'my context message'");
+
+ } // at the end of the using block the message is automatically popped
+
+
+ using log4net.Util;
+
+ ILog log = LogManager.GetLogger("application-log");
+
+ log.InfoExt("Application Start");
+ log.DebugExt("This is a debug message");
+
+
+ using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))
+ {
+ log.Warn("This should have an ThreadContext Stack message");
+ }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
+
+
+ string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
+
+
+ {key1=value1, key2=value2, key3=value3}
+
+
+ {key1=value1, key2=value2, key3=value3}
+
+
+ using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
+ {
+ log.Warn("This should have an ThreadContext Stack message");
+ }
+
+
-
-
-
-
-
-
-
-
-
-
-
-
- string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
-
-
- string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
-
-
- using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
- {
- log.Warn("This should have an ThreadContext Stack message");
- }
-
-
- GlobalContext.Properties["hostname"] = Environment.MachineName;
-
-
- LogicalThreadContext.Properties["user"] = userName;
- log.Info("This log message has a LogicalThreadContext Property called 'user'");
-
-
- using(LogicalThreadContext.Stacks["LDC"].Push("my context message"))
- {
- log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'");
-
- } // at the end of the using block the message is automatically popped
-
-
- ILog log = LogManager.GetLogger("application-log");
-
- log.Info("Application Start");
- log.Debug("This is a debug message");
-
- if (log.IsDebugEnabled)
- {
- log.Debug("This is another debug message");
- }
-
-
- using(NDC.Push("my context message"))
- {
- ... all log calls will have 'my context message' included ...
-
- } // at the end of the using block the message is automatically removed
-
-
- using(log4net.NDC.Push("NDC_Message"))
- {
- log.Warn("This should have an NDC message");
- }
-
-
- ThreadContext.Properties["user"] = userName;
- log.Info("This log message has a ThreadContext Property called 'user'");
-
-
- using(ThreadContext.Stacks["NDC"].Push("my context message"))
- {
- log.Info("This log message has a ThreadContext Stack message that includes 'my context message'");
-
- } // at the end of the using block the message is automatically popped
-
-