SecureBlackbox 2020 Java Edition Reference

SecureBlackbox 2020 Java Edition Website Download Support Questions / Feedback?
SecureBlackbox 2020 Java Edition Introduction Licensing Instructions Upgrade Guide Frequently Asked Questions Supported Platforms Supported Algorithms Common Errors Delphi Edition Variants Supported CAs Supported HSMs Tips and Tricks Validating TLS certificates Configuring TSA authentication Signing with external keys SAML: Using Okta, OneLogin, and other identity providers Constants ArchiveReader Class Introduction Properties ArchiveType DecryptionCertificates (Collection) DecryptionPassword FileData Files (Collection) FileStream HashAlgorithm KnownCertificates (Collection) Opened SignatureValidationResult SigningCertificate Methods Close Config Extract ExtractAll Open OpenBytes OpenStream Events AfterExtractFile BeforeExtractFile DecryptionPasswordNeeded Error Notification Progress RecipientFound SignatureFound Types ArchivedFile Certificate SecureBlackboxStream Configuration Error Codes ArchiveWriter Class Introduction Properties ArchiveType CompressionLevel DecryptionCertificates (Collection) DecryptionPassword EncryptionAlgorithm EncryptionCertificate EncryptionPassword EncryptionType FileData Files (Collection) FileStream NewArchive Opened SigningCertificate SigningChain (Collection) Methods AddEmptyDir AddFile AddFiles AddVirtual Close Config CreateNew Open OpenBytes OpenStream Remove Save SaveBytes SaveStream UpdateFile UpdateFiles UpdateVirtual Events AfterCompressFile BeforeCompressFile DecryptionPasswordNeeded Error Notification PrepareFile Progress RecipientFound Types ArchivedFile Certificate SecureBlackboxStream Configuration Error Codes ASiCSigner Class Introduction Properties BlockedCertificates (Collection) ChainValidationDetails ChainValidationResult ClaimedSigningTime Extended ExternalCrypto HashAlgorithm IgnoreChainValidationErrors InputBytes InputFile InputStream KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) Level OfflineMode OutputBytes OutputFile OutputStream PolicyHash PolicyHashAlgorithm PolicyID PolicyURI Profile Proxy RevocationCheck SignatureIndex SignatureType SigningCertificate SigningChain (Collection) SocketSettings SourceBytes SourceFiles SourceName TimestampServer TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) ValidationLog Methods Config ExtractAsyncData Sign SignAsyncBegin SignAsyncEnd SignExternal Timestamp Upgrade Events Error ExternalSign Notification StoreCertificate StoreCRL StoreOCSPResponse TLSCertValidate Types Certificate CRL ExternalCrypto OCSPResponse ProxySettings SocketSettings TLSSettings SecureBlackboxStream Configuration Error Codes ASiCVerifier Class Introduction Properties AllSignaturesValid BlockedCertificates (Collection) Certificates (Collection) ChainValidationDetails ChainValidationResult ClaimedSigningTime ContentType CRLs (Collection) ExtractionMode HashAlgorithm IgnoreChainValidationErrors InputBytes InputFile InputStream KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) Level OCSPs (Collection) OfflineMode OutputBytes OutputPath OutputStream PolicyHash PolicyHashAlgorithm PolicyID PolicyURI Profile Qualified RevocationCheck Signature Signatures (Collection) SignatureValidationResult SigningCertificate SocketSettings Timestamp Timestamped TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) TSACertificate ValidatedSigningTime ValidationLog ValidationMoment Methods Config Verify Events ChainValidated Error FileExtractionStart Notification RetrieveCertificate RetrieveCRL RetrieveOCSPResponse SignatureFound SignatureValidated StoreCertificate StoreCRL StoreOCSPResponse TimestampFound TimestampValidated TLSCertValidate Types ASiCSignature Certificate CRL OCSPResponse SocketSettings TimestampInfo TLSSettings SecureBlackboxStream Configuration Error Codes Authenticator Class Introduction Properties AuthInfo BlockedCertificates (Collection) Certificates (Collection) ChainValidationDetails ChainValidationResult DefaultAuthMethods ExternalCrypto IgnoreChainValidationErrors KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) OfflineMode Proxy RevocationCheck SigningCertificate SocketSettings TLSSettings TrustedCertificates (Collection) Users (Collection) ValidationLog ValidationMoment Methods Config ContinueAuth StartAuth Events AuthAttemptResult AuthAttemptStart AuthStart AuthVerify CustomAuthStart Error Notification Types AuthInfo Certificate CRL ExternalCrypto OCSPResponse ProxySettings SocketSettings TLSSettings UserAccount Configuration Error Codes AuthenticodeSigner Class Introduction Properties BlockedCertificates (Collection) ClaimedSigningTime ExternalCrypto HashAlgorithm IgnoreChainValidationErrors InputBytes InputFile InputStream KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) OfflineMode OutputBytes OutputFile OutputStream Profile Proxy RemoveExistingSignatures RevocationCheck SignatureDescription SignatureURL SigningCertificate SigningChain (Collection) SocketSettings StatementType TimestampServer TimestampType TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) ValidationLog Methods Config ExtractAsyncData Sign SignAsyncBegin SignAsyncEnd SignExternal Events Error ExternalSign Notification Start TLSCertValidate Types Certificate CRL ExternalCrypto OCSPResponse ProxySettings SocketSettings TLSSettings SecureBlackboxStream Configuration Error Codes AuthenticodeVerifier Class Introduction Properties ActualChecksum AllSignaturesValid BlockedCertificates (Collection) Certificates (Collection) ChainValidationDetails ChainValidationResult ClaimedSigningTime CRLs (Collection) IgnoreChainValidationErrors InputBytes InputFile InputStream KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) OCSPs (Collection) OfflineMode Profile Proxy RevocationCheck Signature Signatures (Collection) SignatureValidationResult Signed SigningCertificate SocketSettings SpecifiedChecksum Timestamp Timestamped TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) TSACertificate ValidatedSigningTime ValidationLog ValidationMoment Methods Config Verify Events ChainValidated Error Notification SignatureFound SignatureValidated TimestampFound TimestampValidated TLSCertValidate Types AuthenticodeSignature Certificate CRL OCSPResponse ProxySettings SocketSettings TimestampInfo TLSSettings SecureBlackboxStream Configuration Error Codes CAdESSigner Class Introduction Properties BlockedCertificates (Collection) ChainValidationDetails ChainValidationResult ClaimedSigningTime DataBytes DataFile DataStream ExternalCrypto HashAlgorithm IgnoreChainValidationErrors InputBytes InputFile InputStream KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) OfflineMode OutputBytes OutputFile OutputStream PolicyHash PolicyHashAlgorithm PolicyID PolicyURI Profile Proxy RevocationCheck SignatureIndex SignedAttributes (Collection) SigningCertificate SigningChain (Collection) SocketSettings TimestampServer TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) UnsignedAttributes (Collection) ValidationLog Methods Archive Config Countersign CountersignExternal ExtractAsyncData Sign SignAsyncBegin SignAsyncEnd SignExternal Timestamp Upgrade Events Error ExternalSign Notification TLSCertValidate Types Certificate CRL ExternalCrypto OCSPResponse ProxySettings SignatureAttribute SocketSettings TLSSettings SecureBlackboxStream Configuration Error Codes CAdESVerifier Class Introduction Properties AllSignaturesValid BlockedCertificates (Collection) Certificates (Collection) ChainValidationDetails ChainValidationResult ClaimedSigningTime CompatibilityErrors ContentType Countersigned CountersigningCertificate CRLs (Collection) DataBytes DataFile DataStream HashAlgorithm IgnoreChainValidationErrors InputBytes InputFile InputStream KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) LastArchivalTime Level MessageDigest OCSPs (Collection) OfflineMode OutputBytes OutputFile OutputStream PolicyHash PolicyID PolicyURI Profile Proxy PublicKeyAlgorithm Qualified RevocationCheck SignatureValidationResult SignedAttributes (Collection) SigningCertificate SocketSettings Timestamp Timestamped TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) TSACertificate UnsignedAttributes (Collection) ValidatedSigningTime ValidationLog ValidationMoment Methods Config Verify VerifyDetached Events ChainValidated CountersignatureFound CountersignatureValidated Error Notification SignatureFound SignatureValidated TimestampFound TimestampValidated TLSCertValidate Types Certificate CRL OCSPResponse ProxySettings SignatureAttribute SocketSettings TimestampInfo TLSSettings SecureBlackboxStream Configuration Error Codes CertificateManager Class Introduction Properties CACertificate Certificate CertificateRequest ExternalCrypto Methods Config Download ExportCert ExportCSR ExportKey ExportKeyToFile ExportKeyToStream ExportToFile ExportToStream Generate GenerateAsyncBegin GenerateAsyncEnd GenerateCSR GenerateExternal GetSampleCert ImportCert ImportFromFile ImportFromStream ImportKey ImportKeyFromFile ImportKeyFromStream Update Validate Events Error ExternalSign Notification PasswordNeeded Types Certificate CertificateRequest ExternalCrypto Configuration Error Codes CertificateStorage Class Introduction Properties Certificates (Collection) Opened PinnedCert SelectedCertificates (Collection) StorageID StorageLocation Methods Add AddFromFile AddFromStream AddPinned Clear Close Config CreateNew Open Refresh Remove Select SelectChain Events Error Notification PasswordNeeded Types Certificate Configuration Error Codes CertificateValidator Class Introduction Properties BlockedCertificates (Collection) CacheValidationResults Certificate ChainValidationDetails ChainValidationResult CurrentCACertificate CurrentCertificate GracePeriod InterimValidationDetails InterimValidationResult KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) MaxValidationTime OfflineMode Proxy Qualified RevocationCheck SocketSettings TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) UsedCertificates (Collection) UsedCRLs (Collection) UseDefaultTSLs UsedOCSPs (Collection) UseSystemCertificates ValidationLog ValidationMoment Methods Config RefreshCache ResetCache Terminate Validate ValidateForSMIME ValidateForSSL Events AfterCertificateProcessing AfterCertificateValidation BeforeCACertificateDownload BeforeCertificateProcessing BeforeCertificateValidation BeforeCRLDownload BeforeOCSPDownload CACertificateDownloaded CACertificateNeeded CRLDownloaded CRLNeeded Error Notification OCSPDownloaded TLSCertValidate Types Certificate CRL OCSPResponse ProxySettings SocketSettings TLSSettings Configuration Error Codes CRLManager Class Introduction Properties CACertificate CRL EntryCount EntryInfo ExternalCrypto Methods Add Clear Config Download GetCertEntryIndex Load LoadFromFile LoadFromStream Remove Save SaveToFile SaveToStream SelectEntry Validate Events Error ExternalSign Notification Types Certificate CRL CRLEntryInfo ExternalCrypto Configuration Error Codes CryptoKeyManager Class Introduction Properties Certificate Key Methods Config DeriveKey ExportBytes ExportToCert ExportToFile ExportToStream Generate GetKeyParam GetKeyParamStr ImportBytes ImportFromCert ImportFromFile ImportFromStream SetKeyParam SetKeyParamStr Events Error Notification PasswordNeeded Types Certificate CryptoKey Configuration Error Codes CryptoKeyStorage Class Introduction Properties Keys (Collection) Opened PinnedKey SelectedKeys (Collection) StorageID StorageLocation Methods AddPinned Clear Close Config CreateNew ImportBytes ImportFromFile ImportFromStream Open Refresh Remove Select Events Error Notification PasswordNeeded Types CryptoKey Configuration Error Codes DCAuth Class Introduction Properties CertPassword ExternalCrypto Input InputEncoding KeyId KeySecret Output OutputEncoding Profile SigningCertificate StorageId Methods Config ProcessRequest Events CustomParametersReceived Error ExternalSign KeySecretNeeded Notification ParameterReceived PasswordNeeded SelectCert SignRequest SignRequestCompleted Types ExternalCrypto Configuration Error Codes DCAuthWebServer Class Introduction Properties Active AllowOrigin AuthBasic AuthDigest AuthDigestExpire AuthRealm BoundPort CertPassword ErrorOrigin ErrorSeverity ExternalCrypto HandshakeTimeout Host KeyId KeySecret PinnedClient PinnedClientChain (Collection) Port PortRangeFrom PortRangeTo ServerCertificates (Collection) SessionTimeout SignEndpoint SigningCertificate SocketSettings StorageId TLSSettings Users (Collection) UseTLS WebsiteName Methods Config DropClient ListClients PinClient Start Stop Events Accept AuthAttempt BeforeOpenStorage CertificateValidate Connect CustomParametersReceived Disconnect Error ExternalSign KeySecretNeeded Log Notification ParameterReceived PasswordNeeded ReadOption SelectCert SignRequest SignRequestCompleted TLSEstablished TLSPSK TLSShutdown WriteOption Types Certificate ExternalCrypto SocketSettings TLSClientEntry TLSSettings UserAccount Configuration Error Codes DTLSClient Class Introduction Properties BlockedCertificates (Collection) ClientChain (Collection) Connected ConnectionInfo ErrorOrigin ErrorSeverity ExternalCrypto KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) OutputBytes OutputString ServerChain (Collection) SocketSettings TLSSettings TrustedCertificates (Collection) Methods Config Connect Disconnect ReceiveAllData ReceiveData SendData SendKeepAlive SendText Events CertificateValidate Error ExternalSign Notification Types Certificate ConnectionInfo CRL ExternalCrypto OCSPResponse SocketSettings TLSSettings Configuration Error Codes DTLSServer Class Introduction Properties Active BoundPort ErrorOrigin ErrorSeverity ExternalCrypto Host PinnedClient PinnedClientChain (Collection) Port PortRangeFrom PortRangeTo ServerCertificates (Collection) SocketSettings TLSSettings WebsiteName Methods Config DropClient ListClients PinClient SendData SendKeepAlive SendText Start Stop Events Accept CertificateValidate Data Error ExternalSign Notification TLSEstablished TLSPSK TLSShutdown Types Certificate ExternalCrypto SocketSettings TLSClientEntry TLSSettings Configuration Error Codes FTPClient Class Introduction Properties AdjustPasvAddress BlockedCertificates (Collection) ClientChain (Collection) Connected ControlConnectionInfo CurrentListEntry DataConnectionInfo EncryptDataChannel ExternalCrypto KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) PassiveMode Password Proxy RestartAt ServerChain (Collection) SocketSettings TLSSettings TransferType TrustedCertificates (Collection) Username Methods Abort Acct AppendBytes AppendFile AppendStream ChangeDir ClearCommandChannel Config Connect DeleteDir DeleteFile DirExists Disconnect DownloadBytes DownloadFile DownloadFiles DownloadStream FileExists GetCurrentDir GetFileSize ListDir MakeDir Noop Rename SendCommand UploadBytes UploadFile UploadFiles UploadStream Events CertificateValidate ControlReceive ControlSend Error ExternalSign FileOperation FileOperationResult ListEntry Notification Progress TextDataLine Types Certificate ConnectionInfo CRL ExternalCrypto FTPListEntry OCSPResponse ProxySettings SocketSettings TLSSettings Configuration Error Codes FTPServer Class Introduction Properties Active AllowAnonymous ClientFileEntry DataHost DataPortRangeFrom DataPortRangeTo ExternalCrypto HandshakeTimeout Host ImplicitSSL PassiveModeHost PinnedClient PinnedClientChain (Collection) Port ReadOnly RootDirectory ServerCertificates (Collection) SessionTimeout SocketSettings TLSSettings Users (Collection) UseUTF8 Methods Config DropClient GetClientBuffer ListClients PinClient SetClientBuffer SetClientFileEntry Start Stop Events Accept AfterChangeDirectory AfterCreateDirectory AfterRemoveDirectory AfterRemoveFile AfterRenameFile AfterRequestAttributes AuthAttempt BeforeChangeDirectory BeforeCreateDirectory BeforeDownloadFile BeforeFind BeforeRemoveDirectory BeforeRemoveFile BeforeRenameFile BeforeRequestAttributes BeforeSendReply BeforeUploadFile CertificateValidate ChangeDirectory CommandProcessed CommandReceived Connect CreateDirectory Disconnect DownloadFile Error ExternalSign FindClose FindInit FindNext Notification ReadFile RemoveDirectory RemoveFile RenameFile RequestAttributes TransferCompleted UploadFile WriteFile Types Certificate ExternalCrypto FTPListEntry SocketSettings TLSClientEntry TLSSettings UserAccount Configuration Error Codes HashFunction Class Introduction Properties Algorithm InputStream JsonSettings Key OutputEncoding Methods Config Finish Hash HashFile HashStream Reset Update UpdateFile UpdateStream Events Error Notification Types CryptoKey JWSettings SecureBlackboxStream Configuration Error Codes HTTPClient Class Introduction Properties BlockedCertificates (Collection) ClientChain (Collection) ConnectionInfo CustomRequest DynamicData ExternalCrypto KeepAlivePolicy KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) OutputBytes OutputString Proxy ReasonPhrase RequestHeaders (Collection) RequestParameters ResponseHeaders (Collection) ResponseParameters ServerChain (Collection) SocketSettings StatusCode TLSSettings TrustedCertificates (Collection) UseDigestAuth UseNTLMAuth Methods Config Delete Get GetBytes GetFile GetStream Head Options Post PostBytes PostFile PostStream PostWebForm Put PutBytes PutFile PutStream Trace Events CertificateValidate Cookie DocumentBegin DocumentEnd DynamicDataNeeded Error ExternalSign HeadersPrepared HeadersReceived Notification Progress Redirection Types Certificate ConnectionInfo CRL ExternalCrypto HTTPRequestParameters HTTPResponseParameters OCSPResponse ProxySettings SocketSettings StringNameValuePair TLSSettings Configuration Error Codes HTTPServer Class Introduction Properties Active AllowKeepAlive AuthBasic AuthDigest AuthDigestExpire AuthRealm BoundPort CompressionLevel DocumentRoot ErrorOrigin ErrorSeverity ExternalCrypto HandshakeTimeout Host PinnedClient PinnedClientChain (Collection) Port PortRangeFrom PortRangeTo ServerCertificates (Collection) SessionTimeout SocketSettings TempDir TLSSettings UseChunkedTransfer UseCompression Users (Collection) UseTLS WebsiteName Methods Config DropClient GetRequestBytes GetRequestHeader GetRequestStream GetRequestString GetRequestUsername ListClients PinClient SetResponseBytes SetResponseFile SetResponseHeader SetResponseStatus SetResponseStream SetResponseString Start Stop Events Accept AuthAttempt CertificateValidate Connect CustomRequest Data DeleteRequest Disconnect Error ExternalSign FileError GetRequest HeadRequest Notification OptionsRequest PatchRequest PostRequest PutRequest TLSEstablished TLSPSK TLSShutdown TraceRequest Types Certificate ExternalCrypto SocketSettings TLSClientEntry TLSSettings UserAccount Configuration Error Codes IMAPClient Class Introduction Properties BlockedCertificates (Collection) ClientChain (Collection) ConnectionInfo CurrentMailbox KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) Mailboxes (Collection) Message Messages (Collection) Password Proxy ServerChain (Collection) ServerInfo SocketSettings TLSSettings TrustedCertificates (Collection) Username Methods CloseMailbox Config Connect CopyMessage CreateMailbox DeleteMailbox Disconnect ExamineMailbox GetMailboxStatus ListAllMessages ListDeletedMessages ListMailboxes ListNewMessages ListRecentMessages ListUnseenMessages MarkMessageDeleted MarkMessageSeen Ping PostBytes PostFile PostMessage PostStream PurgeMessages ReceiveBytes ReceiveFile ReceiveMessage ReceiveStream RefreshMailbox RenameMailbox SelectMailbox UpdateMessage Events BeforeAuth CertificateValidate Command CommandData CommandReply CommandReplyData Error MailboxStatus Notification Progress Types Certificate ConnectionInfo CRL IMAPMailboxInfo IMAPMailboxStatus IMAPMessageInfo IMAPServerInfo MailMessage OCSPResponse ProxySettings SocketSettings TLSSettings Configuration Error Codes KMIPClient Class Introduction Properties DataFile DataStream EncoderType ExternalCrypto Host InputFile InputStream Objects (Collection) OutputFile OutputStream Password PinnedCert PinnedCertRequest Port Proxy SignatureValidationResult SocketSettings TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings Username Methods AddCertificate AddKey AddPinned Config Decrypt Encrypt GenerateCert GenerateCertFromPinned GenerateCertFromRequest GenerateKey GetList Remove Sign Verify Events Error ExternalSign Notification TLSCertValidate Types Certificate CertificateRequest ExternalCrypto KMIPObject ProxySettings SocketSettings TLSSettings SecureBlackboxStream Configuration Error Codes KMIPServer Class Introduction Properties Active CACertificate CertificateRequest CertStorage (Collection) EncoderType ExternalCrypto GeneratedCert Port SocketSettings StorageFileName TLSSettings Users (Collection) Methods Config GetClientCert GetClientCertRequest SetClientCert Start Stop Events AfterGenerateCert AfterGenerateKey AuthAttempt BeforeGenerateCert BeforeGenerateKey DestroyAction Error ExternalSign Notification Request Types Certificate CertificateRequest ExternalCrypto SocketSettings TLSSettings UserAccount Configuration Error Codes MailReader Class Introduction Properties Attachments (Collection) Bcc (Collection) BlockedCertificates (Collection) Cc (Collection) DecryptionCertificate ExternalCrypto From (Collection) IgnoreChainValidationErrors KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) Message OfflineMode OtherHeaders (Collection) Profile Proxy ReplyTo (Collection) RevocationCheck SecurityInfo Sender SendTo (Collection) SigningCertificate SocketSettings TLSSettings TrustedCertificates (Collection) UsedCertificates (Collection) ValidationMoment Methods Config FindAttachment LoadFromBytes LoadFromFile LoadFromStream Events ChainValidated DecryptionInfoNeeded Error ExternalDecrypt Notification SignatureFound SignatureValidated Types Certificate CRL ExternalCrypto MailAddress MailAttachment MailMessage MailSecurityInfo OCSPResponse ProxySettings SocketSettings StringNameValuePair TLSSettings Configuration Error Codes MailWriter Class Introduction Properties AttachEncoding Attachments (Collection) Bcc (Collection) Cc (Collection) Charset EncryptionCertificates (Collection) ExternalCrypto From (Collection) HeaderEncoding Mailer Message OtherHeaders (Collection) Profile ReplyTo (Collection) SecuritySettings Sender SendTo (Collection) SigningCertificate SigningChain (Collection) TextEncoding Methods AttachBytes AttachFile AttachImage Config SaveToBytes SaveToFile SaveToStream Events Error ExternalSign Notification Types Certificate ExternalCrypto MailAddress MailAttachment MailMessage MailSecuritySettings StringNameValuePair Configuration Error Codes MessageCompressor Class Introduction Properties CompressionLevel InputBytes InputFile InputStream OutputBytes OutputFile OutputStream Methods Compress Config Events Error Notification Types SecureBlackboxStream Configuration Error Codes MessageDecompressor Class Introduction Properties InputBytes InputFile InputStream OutputBytes OutputFile OutputStream Methods Config Decompress Events Error Notification Types SecureBlackboxStream Configuration Error Codes MessageDecryptor Class Introduction Properties Certificate Certificates (Collection) EncryptionAlgorithm ExternalCrypto InputBytes InputFile InputStream Key OutputBytes OutputFile OutputStream Methods Config Decrypt Events Error ExternalDecrypt Notification RecipientFound Types Certificate ExternalCrypto SecureBlackboxStream Configuration Error Codes MessageEncryptor Class Introduction Properties BitsInKey EncryptionAlgorithm EncryptionCertificate InputBytes InputFile InputStream Key OutputBytes OutputFile OutputStream Methods Config Encrypt Events Error Notification Types Certificate SecureBlackboxStream Configuration Error Codes MessageSigner Class Introduction Properties ClaimedSigningTime ExternalCrypto HashAlgorithm InputBytes InputFile InputStream OutputBytes OutputFile OutputStream Proxy SignatureType SignedAttributes (Collection) SigningCertificate SigningChain (Collection) SocketSettings TimestampServer TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings UnsignedAttributes (Collection) Methods Config Countersign ExtractAsyncData Sign SignAsyncBegin SignAsyncEnd Timestamp Events Error ExternalSign Notification TLSCertValidate Types Certificate ExternalCrypto ProxySettings SignatureAttribute SocketSettings TLSSettings SecureBlackboxStream Configuration Error Codes MessageTimestamper Class Introduction Properties DataFileName DataURI Detached InputBytes InputFile InputStream OutputBytes OutputFile OutputStream TimestampServer Methods Config Timestamp Events Error Notification Types SecureBlackboxStream Configuration Error Codes MessageTimestampVerifier Class Introduction Properties Certificates (Collection) DataBytes DataFile DataFileName DataStream DataURI InputBytes InputFile InputStream OutputBytes OutputFile OutputStream SignatureValidationResult SigningCertificate ValidatedSigningTime Methods Config Verify VerifyDetached Events Error Notification Types Certificate SecureBlackboxStream Configuration Error Codes MessageVerifier Class Introduction Properties Certificates (Collection) ClaimedSigningTime ContentType DataBytes DataFile DataStream HashAlgorithm InputBytes InputFile InputStream KnownCertificates (Collection) OutputBytes OutputFile OutputStream SignatureValidationResult SignedAttributes (Collection) SigningCertificate Timestamp Timestamped TSACertificate UnsignedAttributes (Collection) ValidatedSigningTime Methods Config GetSignatureType Verify VerifyDetached Events Error Notification SignatureFound SignatureValidated TimestampFound TimestampValidated Types Certificate SignatureAttribute TimestampInfo SecureBlackboxStream Configuration Error Codes OAuthClient Class Introduction Properties AccessToken AuthURL AutoRefresh BlockedCertificates (Collection) ClientChain (Collection) ClientID ClientSecret ConnectionInfo CustomParameters (Collection) ExpiresAt ExpiresIn ExternalCrypto FailureResponse GrantType KeepAlivePolicy KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) Password Proxy RedirectURL RefreshToken Scope ServerChain (Collection) SocketSettings State SuccessResponse Timeout TLSSettings TokenType TokenURL TrustedCertificates (Collection) Username Methods Authorize Config Events CertificateValidate Error ExternalSign LaunchBrowser Wait Types Certificate ConnectionInfo CRL ExternalCrypto OCSPResponse ProxySettings SocketSettings StringNameValuePair TLSSettings Configuration Error Codes OCSPManager Class Introduction Properties BlockedCertificates (Collection) CACertificate Certificate ClientChain (Collection) ConnectionInfo Entries (Collection) KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) OCSPResponse Proxy ServerChain (Collection) SocketSettings TLSSettings TrustedCertificates (Collection) Methods Config GetCertEntryIndex LoadFromBytes LoadFromStream Request SaveToBytes SaveToFile SaveToStream Validate Events CertificateValidate Error Notification Types Certificate ConnectionInfo CRL CRLEntryInfo OCSPResponse ProxySettings SocketSettings TLSSettings Configuration Error Codes OCSPServer Class Introduction Properties Active AuthBasic AuthDigest AuthDigestExpire AuthRealm BadEntries (Collection) BoundPort CACertificate Endpoint ErrorOrigin ErrorSeverity ExternalCrypto GoodEntries (Collection) Host PinnedCerts (Collection) PinnedClient PinnedClientChain (Collection) Port PortRangeFrom PortRangeTo ServerCertificates (Collection) SigningCertificate SocketSettings TLSSettings UpdatePeriod Users (Collection) UseTLS WebsiteName Methods Config DropClient GetRequestBytes GetRequestHeader GetRequestUsername ImportBadCertificates ImportGoodCertificates ListClients PinClient ProcessGenericRequest Start Stop Events Accept AuthAttempt CertificateValidate Connect Disconnect Error ExternalSign Notification StatusRequest TLSEstablished TLSPSK TLSShutdown Types Certificate CRLEntryInfo ExternalCrypto SocketSettings TLSClientEntry TLSSettings UserAccount Configuration Error Codes OfficeDecryptor Class Introduction Properties DocumentFormat EncryptionAlgorithm EncryptionType InputBytes InputFile InputStream OutputBytes OutputFile OutputStream Password Methods Config Decrypt Events DecryptionPasswordNeeded Error Notification Types SecureBlackboxStream Configuration Error Codes OfficeEncryptor Class Introduction Properties DocumentFormat EncryptionAlgorithm EncryptionType InputBytes InputFile InputStream OutputBytes OutputFile OutputStream Password Methods Config Encrypt Events Error Notification Types SecureBlackboxStream Configuration Error Codes OfficeQuickSigner Class Introduction Properties DocumentFormat ExternalCrypto HashAlgorithm InputBytes InputFile InputStream OutputBytes OutputFile OutputStream SignatureType SignCoreProperties SignDocument SigningCertificate SigningChain (Collection) SignSignatureOrigin Methods Config ExtractAsyncData Sign SignAsyncBegin SignAsyncEnd SignExternal Events Error ExternalSign Notification Types Certificate ExternalCrypto SecureBlackboxStream Configuration Error Codes OfficeSigner Class Introduction Properties BlockedCertificates (Collection) ChainValidationDetails ChainValidationResult ClaimedSigningTime DocumentFormat EnableXAdES ExternalCrypto HashAlgorithm IgnoreChainValidationErrors InputBytes InputFile InputStream KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) OfflineMode OutputBytes OutputFile OutputStream Profile Proxy RevocationCheck SignatureIndex SignatureType SignCoreProperties SignDocument SigningCertificate SigningChain (Collection) SignSignatureOrigin SocketSettings TimestampServer TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) ValidationLog XAdESForm XAdESVersion Methods Config ExtractAsyncData Sign SignAsyncBegin SignAsyncEnd SignExternal Timestamp Upgrade Events Error ExternalSign Notification StoreCertificate StoreCRL StoreOCSPResponse TLSCertValidate Types Certificate CRL ExternalCrypto OCSPResponse ProxySettings SocketSettings TLSSettings SecureBlackboxStream Configuration Error Codes OfficeVerifier Class Introduction Properties AllSignaturesValid BlockedCertificates (Collection) Certificates (Collection) ChainValidationDetails ChainValidationResult ClaimedSigningTime CRLs (Collection) DocumentFormat IgnoreChainValidationErrors InputBytes InputFile InputStream KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) LastArchivalTime OCSPs (Collection) OfflineMode OutputBytes OutputFile OutputStream Profile Proxy Qualified RevocationCheck Signature SignatureIndex Signatures (Collection) SignatureValidationResult SignedParts (Collection) SigningCertificate SocketSettings Timestamp Timestamped TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) TSACertificate ValidatedSigningTime ValidationLog ValidationMoment XAdESEnabled XAdESForm XAdESVersion Methods AddTimestamp AddTimestampValidationData AddValidationDataRefs AddValidationDataValues Config Verify Events ChainValidated Error Notification RetrieveCertificate RetrieveCRL RetrieveOCSPResponse SignatureFound SignatureValidated StoreCertificate StoreCRL StoreOCSPResponse TimestampFound TimestampValidated TLSCertValidate Types Certificate CRL OCSPResponse OfficeSignature OfficeSignedPart ProxySettings SocketSettings TimestampInfo TLSSettings SecureBlackboxStream Configuration Error Codes OTPClient Class Introduction Properties KeySecret PasswordLength Methods Config GenerateHOTPPassword GenerateTOTPPassword Events Error Notification Configuration Error Codes OTPServer Class Introduction Properties Users (Collection) Methods Config IsHOTPPasswordValid IsPasswordValid IsTOTPPasswordValid Events Error Notification Types UserAccount Configuration Error Codes PasswordVault Class Introduction Properties Description EntryKey EntryPassword Key Password PlatformProtection Title Methods AddEntry ChangeEntryKey ChangeEntryPassword Close Config GetEntryValue GetEntryValueStr ListEntries ListFields OpenBytes OpenFile OpenStream RemoveAllEntries RemoveEntry RemoveField SaveBytes SaveFile SaveStream SetEntryValue SetEntryValueStr Events EntryKeyNeeded Error KeyNeeded Notification Configuration Error Codes PDFDecryptor Class Introduction Properties DecryptionCertificate DecryptionCertificates (Collection) Encrypted EncryptionAlgorithm EncryptionType ExternalCrypto InputBytes InputFile InputStream MetadataEncrypted OutputBytes OutputFile OutputStream Password Permissions Methods Config Decrypt Events DecryptionInfoNeeded Error ExternalDecrypt Notification RecipientFound Types Certificate ExternalCrypto PDFPermissions SecureBlackboxStream Configuration Error Codes PDFEncryptor Class Introduction Properties EncryptionAlgorithm EncryptionCertificate EncryptionCertificates (Collection) EncryptionType EncryptMetadata InputBytes InputFile InputStream OutputBytes OutputFile OutputStream OwnerPassword Permissions UserPassword Methods Config Encrypt Events Error Notification Types Certificate PDFPermissions SecureBlackboxStream Configuration Error Codes PDFSigner Class Introduction Properties BlockedCertificates (Collection) ClaimedSigningTime DecryptionCertificate DecryptionCertificates (Collection) EmptyFieldIndex Encrypted EncryptionAlgorithm EncryptionType ExternalCrypto FieldIndex IgnoreChainValidationErrors InputBytes InputFile InputStream KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) MetadataEncrypted OfflineMode OutputBytes OutputFile OutputStream Password Permissions Profile Proxy RevocationCheck Signature SigningCertificate SigningChain (Collection) SocketSettings TimestampServer TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) ValidationLog Methods Config ExtractAsyncData Sign SignAsyncBegin SignAsyncEnd SignExternal Update Events DecryptionInfoNeeded Error ExternalDecrypt ExternalSign Notification RecipientFound TLSCertValidate Types Certificate CRL ExternalCrypto OCSPResponse PDFPermissions PDFSignature ProxySettings SocketSettings TLSSettings SecureBlackboxStream Configuration Error Codes PDFVerifier Class Introduction Properties AllSignaturesValid BlockedCertificates (Collection) Certificates (Collection) ChainValidationDetails ChainValidationResult ClaimedSigningTime CRLs (Collection) DecryptionCertificate DecryptionCertificates (Collection) Encrypted EncryptionAlgorithm EncryptionType IgnoreChainValidationErrors InputBytes InputFile InputStream KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) MetadataEncrypted OCSPs (Collection) OfflineMode Password Permissions Profile Proxy Qualified RevocationCheck Signature Signatures (Collection) SignatureValidationResult SigningCertificate SocketSettings Timestamp Timestamped TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) TSACertificate ValidatedSigningTime ValidationLog ValidationMoment Methods Config GetSignedVersion Verify Events ChainValidated DecryptionInfoNeeded Error Notification RecipientFound SignatureFound SignatureValidated TimestampFound TimestampValidated TLSCertValidate Types Certificate CRL OCSPResponse PDFPermissions PDFSignature ProxySettings SocketSettings TimestampInfo TLSSettings SecureBlackboxStream Configuration Error Codes PGPKeyManager Class Introduction Properties Key Methods AddSubkey BindUser ChangePassphrase ChangeProtection CheckPassphrase Config ExportKey ExportPublicKey ExportPublicToFile ExportPublicToStream ExportToFile ExportToStream Generate GenerateLegacy GeneratePair ImportFromFile ImportFromStream ImportKey RemoveSubkey RemoveUser RevokeKey RevokeSubkey RevokeSubkeybyID RevokeUser RevokeUserByName Validate Events Error Notification Types PGPKey Configuration Error Codes PGPKeyring Class Introduction Properties Opened PinnedKey PublicKeys (Collection) SecretKeys (Collection) SelectedPublicKeys (Collection) SelectedSecretKeys (Collection) Methods AddFromFile AddFromFiles AddFromStream AddFromStreams AddPinned Clear Close Config CreateNew Load LoadFromBytes LoadFromStreams RemoveByID RemovePublic RemoveSecret Save SaveToBytes SaveToStreams Select Events Error Notification Types PGPKey Configuration Error Codes PGPReader Class Introduction Properties Armored Compressed DecryptingKeys (Collection) ExternalCrypto KeyPassphrase Passphrase ProcessedLength Profile Signatures (Collection) VerifyingKeys (Collection) Methods Config DecryptAndVerify DecryptAndVerifyFile DecryptAndVerifyStream DecryptAndVerifyString VerifyDetached VerifyDetachedFile VerifyDetachedStream VerifyDetachedString Events EncryptionInfo Error ExternalDecrypt FileExtractionStart KeyPassphraseNeeded MultipleFilesFound Notification PassphraseNeeded Progress Signed Types ExternalCrypto PGPKey PGPSignature Configuration Error Codes PGPWriter Class Introduction Properties Armor ArmorBoundary ArmorHeaders Compress CompressionAlgorithm CompressionLevel EncryptingKeys (Collection) EncryptionAlgorithm ExternalCrypto Filename HashAlgorithm InputIsText Passphrase Profile Protection SigningKeys (Collection) Timestamp Methods ClearTextSign ClearTextSignFile ClearTextSignStream ClearTextSignString Config Encrypt EncryptAndSign EncryptAndSignFile EncryptAndSignFolder EncryptAndSignStream EncryptAndSignString EncryptFile EncryptFolder EncryptStream EncryptString Sign SignFile SignFolder SignStream SignString Events Error ExternalSign KeyPassphraseNeeded Notification Progress Types ExternalCrypto PGPKey Configuration Error Codes POP3Client Class Introduction Properties BlockedCertificates (Collection) ClientChain (Collection) ConnectionInfo ExternalCrypto KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) Message Messages (Collection) Password Proxy ServerChain (Collection) ServerInfo SocketSettings TLSSettings TrustedCertificates (Collection) Username Methods Config Connect DeleteMessage Disconnect ListMessages Ping ReceiveBytes ReceiveFile ReceiveMessage ReceiveStream Undelete Events BeforeAuth CertificateValidate Command CommandReply CommandReplyData Error ExternalSign Notification Progress Types Certificate ConnectionInfo CRL ExternalCrypto MailMessage OCSPResponse POP3MessageInfo POP3ServerInfo ProxySettings SocketSettings TLSSettings Configuration Error Codes PublicKeyCrypto Class Introduction Properties CanEncrypt CanSign HashAlgorithm InputEncoding InputIsHash JsonDetails Key OutputEncoding Scheme SchemeParams SignatureValidationResult Methods Config Decrypt DecryptFile DecryptStream Encrypt EncryptFile EncryptStream Sign SignFile SignStream Verify VerifyDetached VerifyDetachedFile VerifyDetachedStream VerifyFile VerifyStream Events Error Notification Types CryptoKey JWSettings Configuration Error Codes RESTClient Class Introduction Properties BlockedCertificates (Collection) ClientChain (Collection) ConnectionInfo CustomRequest DynamicData ExternalCrypto KeepAlivePolicy KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) OutputBytes OutputString Proxy ReasonPhrase RequestHeaders (Collection) RequestParameters ResponseHeaders (Collection) ResponseParameters ServerChain (Collection) SocketSettings StatusCode TLSSettings TrustedCertificates (Collection) UseDigestAuth UseNTLMAuth Methods Config Delete Get GetBytes GetFile GetStream Head Options Post PostBytes PostFile PostJSON PostStream PostWebForm PostXML Put PutBytes PutFile PutJSON PutStream PutXML Trace Events CertificateValidate Cookie DocumentBegin DocumentEnd DynamicDataNeeded Error ExternalSign HeadersPrepared HeadersReceived Notification Progress Redirection Types Certificate ConnectionInfo CRL ExternalCrypto HTTPRequestParameters HTTPResponseParameters OCSPResponse ProxySettings SocketSettings StringNameValuePair TLSSettings Configuration Error Codes RESTServer Class Introduction Properties Active AllowKeepAlive AuthBasic AuthDigest AuthDigestExpire AuthRealm BoundPort CompressionLevel DocumentRoot ErrorOrigin ErrorSeverity ExternalCrypto HandshakeTimeout Host PinnedClient PinnedClientChain (Collection) Port PortRangeFrom PortRangeTo ServerCertificates (Collection) SessionTimeout SocketSettings TempDir TLSSettings UseChunkedTransfer UseCompression Users (Collection) UseTLS WebsiteName Methods Config DropClient GetRequestBytes GetRequestHeader GetRequestStream GetRequestString GetRequestUsername ListClients PinClient SetResponseBytes SetResponseFile SetResponseHeader SetResponseJSON SetResponseStatus SetResponseStream SetResponseString SetResponseXML Start Stop Events Accept AuthAttempt CertificateValidate Connect CustomRequest Data DeleteRequest Disconnect Error ExternalSign FileError GetRequest HeadRequest Notification OptionsRequest PatchRequest PostRequest PutRequest TLSEstablished TLSPSK TLSShutdown TraceRequest Types Certificate ExternalCrypto SocketSettings TLSClientEntry TLSSettings UserAccount Configuration Error Codes Rnd Class Introduction Properties Alphabet Methods Config NextBytes NextInt NextPass NextString Randomize SeedBytes SeedInt SeedString SeedTime Events Error Notification Configuration Error Codes SAMLIdPServer Class Introduction Properties Active AllowIDPSSO ArtifactResolutionService AttributeQueryService AuthFormTemplate EncryptAssertions EncryptionCertificate ErrorOrigin ErrorSeverity ExternalCrypto Host IDPSSOPage IDPSSOPageContent LoginAttemptsLimit MetadataURL MetaSigningCertificate Port PreferredSingleLogoutResponseBinding PreferredSingleSignOnResponseBinding ServerCertificates (Collection) SignAssertions SigningCertificate SigningChain (Collection) SignMetadata SignResponse SingleLogoutService SingleLogoutServiceBindings SingleSignOnService SingleSignOnServiceBindings SocketSettings TLSSettings URL UseTLS Methods AddIdPSSOLink AddUser AddUserWithEmail ClearUsers Config LoadSPMetadata RemoveIdPSSOLink RemoveSP RemoveUser SaveMetadata SaveMetadataToStream Start Stop Events Accept Connect Disconnect Error ExternalSign Notification SessionClosed SessionEstablished Types Certificate ExternalCrypto SocketSettings TLSSettings Configuration Error Codes SAMLReader Class Introduction Properties Artifact ArtifactResolveQuery AssertionCount AssertionIDRequest AttrQueryAttributes (Collection) AuthnQuery AuthnRequest AuthnRequestConditions (Collection) AuthnRequestScopingIDPList (Collection) AuthzDecisionQuery Binding BlockedCertificates (Collection) ChainValidationDetails ChainValidationResult Consent DecryptionCertificate Destination ID IgnoreChainValidationErrors InputType InputTypeString InResponseTo IssueInstant Issuer KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) LogoutRequest ManageNameIDRequest NameIDMappingRequest OfflineMode PinnedAssertionAttributes (Collection) PinnedAssertionConditions (Collection) PinnedAssertionInfo PinnedAssertionIssuer PinnedAssertionStatements (Collection) PinnedAssertionSubjectConfirmations (Collection) PinnedAssertionSubjectID POSTBinding Profile Proxy RedirectBinding RedirectBindingCertificate Response SignatureValidationResult Signed SigningCertificate SocketSettings SubjectConfirmations (Collection) SubjectID TLSSettings TrustedCertificates (Collection) UseBinding ValidateSignatures ValidationLog ValidationMoment Version Methods CompareIDs Config GetIDProp Open OpenBytes OpenFile OpenStream PinAdviceAssertion PinAssertion Events Error Notification SignatureFound SignatureValidated Types Certificate CRL OCSPResponse ProxySettings SAMLArtifact SAMLAssertionCondition SAMLAssertionIDRequest SAMLAssertionInfo SAMLAssertionStatement SAMLAttribute SAMLAuthnQuery SAMLAuthnRequest SAMLAuthzDecisionQuery SAMLIDPEntry SAMLLogoutRequest SAMLManageNameIDRequest SAMLNameIDMappingRequest SAMLPOSTBinding SAMLRedirectBinding SAMLResponse SAMLSubjectConfirmation SocketSettings TLSSettings Configuration Error Codes SAMLSPServer Class Introduction Properties Active ArtifactResolutionService AssertionConsumerService AssertionConsumerServiceBindings BaseDir EncryptionCertificate ErrorOrigin ErrorSeverity ExternalCrypto Host Issuer LogoutPage MetadataURL MetaSigningCertificate Port PreferredIDPToSPBinding ProtectedResources RedirectOnLogoutPage ServerCertificates (Collection) SignArtifactResolveRequests SignAuthnRequests SigningCertificate SigningChain (Collection) SignLogoutRequests SignMetadata SingleLogoutService SingleLogoutServiceBindings SocketSettings SPToIDPBinding TLSSettings URL UseTLS Methods Config LoadIDPMetadata LoadIDPMetadataFromStream SaveMetadata SaveMetadataToStream Start Stop Events Accept Connect Disconnect Error ExternalSign Notification SessionClosed SessionEstablished Types Certificate ExternalCrypto SocketSettings TLSSettings Configuration Error Codes SAMLWriter Class Introduction Properties AddXMLHeader Artifact ArtifactResolveQuery AssertionAttributes (Collection) AssertionConditions (Collection) AssertionCount AssertionIDRequest AssertionInfo AssertionIssuer AssertionStatements (Collection) AssertionSubjectConfirmations (Collection) AssertionSubjectID AttrQueryAttributes (Collection) AuthnQuery AuthnRequest AuthnRequestConditions (Collection) AuthnRequestScopingIDPList (Collection) AuthzDecisionQuery Binding Consent Destination EncryptionCertificate ID InResponseTo IssueInstant Issuer LogoutRequest ManageNameIDRequest NameIDMappingRequest OutputType POSTBinding Profile RedirectBinding RedirectBindingCertificate Response Sign SigningCertificate SigningChain (Collection) SubjectConfirmations (Collection) SubjectID Version Methods AddAdviceAssertion AddAssertion ClearAssertion CompareIDs Config CreateNew GetIDProp RemoveAdvice RemoveAdviceAssertion RemoveAllAssertions RemoveAssertion Save SaveBytes SaveFile SaveStream Events Error Notification Types Certificate SAMLArtifact SAMLAssertionCondition SAMLAssertionIDRequest SAMLAssertionInfo SAMLAssertionStatement SAMLAttribute SAMLAuthnQuery SAMLAuthnRequest SAMLAuthzDecisionQuery SAMLIDPEntry SAMLLogoutRequest SAMLManageNameIDRequest SAMLNameIDMappingRequest SAMLPOSTBinding SAMLRedirectBinding SAMLResponse SAMLSubjectConfirmation Configuration Error Codes SFTPClient Class Introduction Properties AuthAttempts AutoAdjustTransferBlock Connected ConnectionInfo CurrentListEntry DownloadBlockSize ExternalCrypto ForceCompression Key MaxSFTPVersion MinSFTPVersion Password PipelineLength Proxy ServerKey SocketSettings SSHSettings TrustedKeysFile UploadBlockSize Username UseUTF8 Version Methods AbsolutePath ChangeDir Config Connect CreateLink DeleteDir DeleteFile DeleteFiles DirExists Disconnect DownloadBytes DownloadFile DownloadFiles DownloadStream ExecuteSSHCommand ExtensionCmd FileExists GetCurrentDir GetFileSize ListDir MakeDir RenameFile RequestAttributes SetAttributes UploadBytes UploadFile UploadFiles UploadStream Events AuthAttempt AuthFailed AuthSucceeded Banner Disconnect Error ExternalSign FileOperation FileOperationResult KnownKeyReceived ListEntry Notification PasswordChangeRequest PrivateKeyNeeded Progress UnknownKeyReceived Types ExternalCrypto ProxySettings SFTPListEntry SocketSettings SSHInfo SSHKey SSHSettings Configuration Error Codes SFTPServer Class Introduction Properties Active AuthTypes BaseDir ClientFileEntry CompressionLevel ExternalCrypto ForceCompression Host Key MaxSFTPVersion MinSFTPVersion PinnedClient Port ReadOnly ServerKeys (Collection) SocketSettings SSHSettings Users (Collection) UseUTF8 Methods Config DropClient GetClientBuffer GetClientFileEntry ListClients PinClient SetClientBuffer SetClientFileEntry Start Stop Events Accept AfterCreateDirectory AfterRemove AfterRenameFile AfterRequestAttributes AfterSetAttributes AuthAttempt AuthFailed AuthPassword AuthPublicKey AuthSucceeded BeforeCreateDirectory BeforeDownloadFile BeforeFind BeforeRemove BeforeRenameFile BeforeRequestAttributes BeforeSetAttributes BeforeUploadFile CloseFile Connect CreateDirectory Disconnect Error ExternalSign FindClose FindFirst FindNext Notification OpenFile ReadFile Remove RenameFile RequestAttributes SessionClosed SessionEstablished SetAttributes WriteFile Types ExternalCrypto SFTPListEntry SocketSettings SSHClientEntry SSHKey SSHSettings UserAccount Configuration Error Codes SMTPClient Class Introduction Properties BlockedCertificates (Collection) ClientChain (Collection) ConnectionInfo Domain ExternalCrypto KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) Message Password Proxy ServerChain (Collection) ServerInfo SocketSettings TLSSettings TrustedCertificates (Collection) Username Methods Config Connect Disconnect SendBytes SendFile SendMessage SendStream Events BeforeAuth CertificateValidate Command CommandData CommandReply Error ExternalSign Notification Progress Types Certificate ConnectionInfo CRL ExternalCrypto MailMessage OCSPResponse ProxySettings SMTPServerInfo SocketSettings TLSSettings Configuration Error Codes SOAPClient Class Introduction Properties AttachmentBytes AttachmentFile AttachmentStream BlockedCertificates (Collection) ClientChain (Collection) ConnectionInfo Encoding ExternalCrypto FaultActor FaultCode FaultDetail FaultString InputBytes InputFile InputStream KeepAlivePolicy KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) MimeType OperationName OperationNamespaceURI OperationResponseName OperationResponseNamespaceURI OperationResponseTextContent OperationResponseXML OutputAttachmentBytes OutputAttachmentFile OutputAttachmentStream OutputBytes OutputFile OutputStream Proxy ReasonPhrase RequestHeaders (Collection) RequestParameters ResponseHeaders (Collection) ResponseParameters ServerChain (Collection) SOAPAction SOAPResponseType SOAPVersion SocketSettings StatusCode TLSSettings TrustedCertificates (Collection) UseDigestAuth UseNTLMAuth Methods Config SendMessage SendMessageWithAttachments Events BeforeReceiveAttachment BeforeSendAttachment CertificateValidate Cookie DocumentBegin DocumentEnd Error ExternalSign HeadersPrepared HeadersReceived Notification Progress Redirection Types Certificate ConnectionInfo CRL ExternalCrypto HTTPRequestParameters HTTPResponseParameters OCSPResponse ProxySettings SocketSettings StringNameValuePair TLSSettings SecureBlackboxStream Configuration Error Codes SOAPQuickSigner Class Introduction Properties CanonicalizationMethod EmbedCertificateMethod Encoding ExternalCrypto HashAlgorithm InputFile InputStream OutputFile OutputStream References (Collection) SignatureType SigningCertificate SigningChain (Collection) XPathNamespaces (Collection) Methods AddBodyReference AddDataReference AddReference Config ExtractAsyncData Sign SignAsyncBegin SignAsyncEnd SignExternal Events Error ExternalSign FormatElement FormatText Notification ResolveReference Types Certificate ExternalCrypto XMLNamespace XMLReference SecureBlackboxStream Configuration Error Codes SOAPSigner Class Introduction Properties BlockedCertificates (Collection) CanonicalizationMethod ChainValidationDetails ChainValidationResult ClaimedSigningTime EmbedCertificateMethod EnableXAdES Encoding ExternalCrypto HashAlgorithm IgnoreChainValidationErrors InputBytes InputFile InputStream KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) OfflineMode OutputBytes OutputFile OutputStream Profile Proxy References (Collection) RevocationCheck SignatureIndex SignatureType SigningCertificate SigningChain (Collection) SocketSettings TimestampServer TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) ValidationLog XAdESForm XAdESVersion XPathNamespaces (Collection) Methods AddBodyReference AddDataReference AddReference Config ExtractAsyncData Sign SignAsyncBegin SignAsyncEnd SignExternal Timestamp Upgrade Events Error ExternalSign FormatElement FormatText Notification ResolveReference StoreCertificate StoreCRL StoreOCSPResponse TLSCertValidate Types Certificate CRL ExternalCrypto OCSPResponse ProxySettings SocketSettings TLSSettings XMLNamespace XMLReference SecureBlackboxStream Configuration Error Codes SOAPVerifier Class Introduction Properties AllSignaturesValid BlockedCertificates (Collection) CanonicalizationMethod Certificates (Collection) ChainValidationDetails ChainValidationResult ClaimedSigningTime CRLs (Collection) Encoding HashAlgorithm IgnoreChainValidationErrors InputBytes InputFile InputStream KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) LastArchivalTime OCSPs (Collection) OfflineMode OutputBytes OutputFile OutputStream Profile Proxy Qualified References (Collection) RevocationCheck SignatureIndex SignatureType SignatureValidationResult SigningCertificate SocketSettings Timestamp Timestamped TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) TSACertificate ValidatedSigningTime ValidationLog ValidationMoment XAdESEnabled XAdESForm XAdESVersion XPathNamespaces (Collection) Methods AddTimestamp AddTimestampValidationData AddValidationDataRefs AddValidationDataValues Config Verify Events ChainValidated Error Notification ReferenceValidated ResolveReference RetrieveCertificate RetrieveCRL RetrieveOCSPResponse SignatureFound SignatureValidated StoreCertificate StoreCRL StoreOCSPResponse TimestampFound TimestampValidated TLSCertValidate Types Certificate CRL OCSPResponse ProxySettings SocketSettings TimestampInfo TLSSettings XMLNamespace XMLReference SecureBlackboxStream Configuration Error Codes SSHClient Class Introduction Properties AsyncMode AuthAttempts Commands Connected ConnectionInfo ExitMessage ExitSignal ExitStatus ExternalCrypto Key Password Proxy ServerKey SocketSettings SSHSettings Subsystem Terminal TrustedKeysFile Username Methods Config Connect ConnectAndExec Disconnect Ping Poll Receive ReceiveBytes ReceiveBytesFrom ReceiveFrom Send SendBytes SendSpecial Events AuthAttempt AuthFailed AuthSucceeded Banner CommandCompleted CommandStart Connect DataReceived DataSent Disconnect Error ExternalSign KnownKeyReceived Notification PasswordChangeRequest PrivateKeyNeeded UnknownKeyReceived Types ExternalCrypto ProxySettings SocketSettings SSHInfo SSHKey SSHSettings SSHTerm Configuration Error Codes SSHKeyManager Class Introduction Properties Certificate CryptoKey Key Methods Config ExportBytes ExportToCert ExportToCryptoKey ExportToFile ExportToStream Generate GetKeyParam GetKeyParamStr ImportBytes ImportFromCert ImportFromCryptoKey ImportFromFile ImportFromStream SetKeyParam SetKeyParamStr Events Error Notification Types Certificate CryptoKey SSHKey Configuration Error Codes SymmetricCrypto Class Introduction Properties AssociatedData BlockSize EncryptionAlgorithm HashAlgorithm InputEncoding Key KeySize MACAlgorithm Mode Nonce OutputEncoding Padding PayloadSize StreamCipher TagSize Methods Config Decrypt DecryptFile DecryptFinal DecryptInit DecryptStream DecryptUpdate Encrypt EncryptFile EncryptFinal EncryptInit EncryptStream EncryptUpdate Events Error Notification Progress Types CryptoKey Configuration Error Codes TLSClient Class Introduction Properties BlockedCertificates (Collection) ClientChain (Collection) Connected ConnectionInfo ErrorOrigin ErrorSeverity ExternalCrypto KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) OutputBytes OutputString Proxy ServerChain (Collection) SocketSettings TLSSettings TrustedCertificates (Collection) Methods Config Connect Disconnect ReceiveAllData ReceiveData SendData SendKeepAlive SendStream SendText Events CertificateValidate Error ExternalSign Notification Types Certificate ConnectionInfo CRL ExternalCrypto OCSPResponse ProxySettings SocketSettings TLSSettings Configuration Error Codes TLSServer Class Introduction Properties Active BoundPort ErrorOrigin ErrorSeverity ExternalCrypto HandshakeTimeout Host PinnedClient PinnedClientChain (Collection) Port PortRangeFrom PortRangeTo ServerCertificates (Collection) SessionTimeout SocketSettings TLSSettings UseTLS WebsiteName Methods Config DropClient ListClients PinClient SendData SendKeepAlive SendText Start Stop Events Accept CertificateValidate Connect Data Disconnect Error ExternalSign Notification TLSEstablished TLSPSK TLSShutdown Types Certificate ExternalCrypto SocketSettings TLSClientEntry TLSSettings Configuration Error Codes TSPServer Class Introduction Properties Accuracy Active AuthBasic AuthDigest AuthDigestExpire AuthRealm BoundPort DefaultPolicy Endpoint ErrorOrigin ErrorSeverity ExternalCrypto Host PinnedClient PinnedClientChain (Collection) Port PortRangeFrom PortRangeTo ServerCertificates (Collection) SessionTimeout SigningCertificate SigningChain (Collection) SocketSettings TLSSettings TSAName Users (Collection) UseTLS WebsiteName Methods Config DropClient GetRequestBytes GetRequestHeader GetRequestUsername ListClients PinClient ProcessGenericRequest Start Stop Events Accept AuthAttempt CertificateValidate Connect Disconnect Error ExternalSign Notification TimestampRequest TLSEstablished TLSPSK TLSShutdown Types Certificate ExternalCrypto SocketSettings TLSClientEntry TLSSettings UserAccount Configuration Error Codes UserManager Class Introduction Properties Users (Collection) Methods Config Load LoadFromStream LoadUser LoadUserFromStream Save SaveToStream SaveUser SaveUserToStream Events Error Notification Types UserAccount Configuration Error Codes WebDAVClient Class Introduction Properties BaseURL ClientChain (Collection) Connected ConnectionInfo CurrentListEntry CurrentLocks EncodeURL ExternalCrypto KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) LockDepth LockScope LockTimeout MoveToRename OverwriteOnCopy OverwriteOnMove Password Proxy ResourceOwner ServerChain (Collection) SocketSettings TLSSettings TrustedCertificates (Collection) Username Methods Config Connect Copy CustomRequest DeleteDir DeleteFile DirExists Disconnect DownloadFile DownloadStream FileExists GetFileSize ListDir ListDirRecursive Lock MakeDir MoveFile RefreshLock Rename Unlock UploadFile UploadStream Events CertificateValidate Error ExternalSign ListEntry Notification OperationError Progress Types Certificate ConnectionInfo CRL ExternalCrypto OCSPResponse ProxySettings SocketSettings TLSSettings WebDAVListEntry Configuration Error Codes WebDAVServer Class Introduction Properties Active AuthBasic AuthDigest AuthDigestExpire AuthRealm BoundPort DocumentRoot ErrorOrigin ErrorSeverity ExternalCrypto Host MetadataFlushTimeout MetadataRoot PinnedClient PinnedClientChain (Collection) Port PortRangeFrom PortRangeTo ServerCertificates (Collection) SocketSettings TLSSettings Users (Collection) UseTLS WebsiteName Methods Config DropClient ListClients PinClient Start Stop Events Accept AuthAttempt BeforeRequest CertificateValidate Connect Data Disconnect Error ExternalSign FileError Notification QueryQuota TLSEstablished TLSPSK TLSShutdown Types Certificate ExternalCrypto SocketSettings TLSClientEntry TLSSettings UserAccount Configuration Error Codes WebSocketClient Class Introduction Properties BlockedCertificates (Collection) ClientChain (Collection) Connected ConnectionInfo ExternalCrypto KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) Proxy RequestParameters ServerChain (Collection) SocketSettings TLSSettings TrustedCertificates (Collection) UseDigestAuth UseNTLMAuth Methods Config Connect Disconnect SendData SendKeepAlive SendText Events BinaryData CertificateValidate Error ExternalSign KeepAliveResponse Notification TextData Types Certificate ConnectionInfo CRL ExternalCrypto HTTPRequestParameters OCSPResponse ProxySettings SocketSettings TLSSettings Configuration Error Codes WebSocketServer Class Introduction Properties Active BoundPort ErrorOrigin ErrorSeverity ExternalCrypto HandshakeTimeout Host PinnedClient PinnedClientChain (Collection) Port PortRangeFrom PortRangeTo ServerCertificates (Collection) SessionTimeout SocketSettings TLSSettings Users (Collection) UseTLS WebsiteName Methods Config DropClient ListClients PinClient SendData SendKeepAlive SendText SetResponseBytes SetResponseStatus SetResponseStream SetResponseString Start Stop Events Accept AuthAttempt BinaryData CertificateValidate Connect Data Disconnect Error ExternalSign GetRequest KeepAliveResponse Notification TextData TLSEstablished TLSPSK TLSShutdown Types Certificate ExternalCrypto SocketSettings TLSClientEntry TLSSettings UserAccount Configuration Error Codes XAdESSigner Class Introduction Properties BlockedCertificates (Collection) CanonicalizationMethod ChainValidationDetails ChainValidationResult ClaimedSigningTime EnableXAdES Encoding ExternalCrypto HashAlgorithm IgnoreChainValidationErrors InputBytes InputFile InputStream KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) OfflineMode OutputBytes OutputFile OutputStream Profile Proxy References (Collection) RevocationCheck SignatureType SigningCertificate SigningChain (Collection) SocketSettings TimestampServer TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) ValidationLog XAdESForm XAdESVersion XMLElement XPathNamespaces (Collection) Methods AddDataReference AddReference Config ExtractAsyncData Sign SignAsyncBegin SignAsyncEnd SignExternal Timestamp Upgrade Events Error ExternalSign FormatElement FormatText Notification ResolveReference StoreCertificate StoreCRL StoreOCSPResponse TLSCertValidate Types Certificate CRL ExternalCrypto OCSPResponse ProxySettings SocketSettings TLSSettings XMLNamespace XMLReference SecureBlackboxStream Configuration Error Codes XAdESVerifier Class Introduction Properties AllSignaturesValid BlockedCertificates (Collection) CanonicalizationMethod Certificates (Collection) ChainValidationDetails ChainValidationResult ClaimedSigningTime CRLs (Collection) DataFile DataStream Encoding HashAlgorithm IgnoreChainValidationErrors InputBytes InputFile InputStream KnownCertificates (Collection) KnownCRLs (Collection) KnownOCSPs (Collection) LastArchivalTime OCSPs (Collection) OfflineMode OutputBytes OutputFile OutputStream Profile Proxy Qualified References (Collection) RevocationCheck SignatureValidationResult SigningCertificate SocketSettings Timestamp Timestamped TLSClientChain (Collection) TLSServerChain (Collection) TLSSettings TrustedCertificates (Collection) TSACertificate ValidatedSigningTime ValidationLog ValidationMoment XAdESEnabled XAdESForm XAdESVersion XMLElement XPathNamespaces (Collection) Methods AddTimestamp AddTimestampValidationData AddValidationDataRefs AddValidationDataValues Config Verify VerifyDetached Events ChainValidated Error Notification ReferenceValidated ResolveReference RetrieveCertificate RetrieveCRL RetrieveOCSPResponse SignatureFound SignatureValidated StoreCertificate StoreCRL StoreOCSPResponse TimestampFound TimestampValidated TLSCertValidate Types Certificate CRL OCSPResponse ProxySettings SocketSettings TimestampInfo TLSSettings XMLNamespace XMLReference SecureBlackboxStream Configuration Error Codes XMLDecryptor Class Introduction Properties DecryptionKey Encoding EncryptedDataType EncryptionMethod EncryptKey ExternalCrypto ExternalData InputBytes InputFile InputStream KeyDecryptionCertificate KeyDecryptionKey KeyEncryptionType KeyInfo (Collection) KeyInfoCertificates (Collection) KeyTransportMethod KeyWrapMethod OutputBytes OutputFile OutputStream UseGCM XMLElement XPathNamespaces (Collection) Methods Config Decrypt Events DecryptionInfoNeeded Error ExternalDecrypt Notification SaveExternalData Types Certificate ExternalCrypto XMLKeyInfoItem XMLNamespace SecureBlackboxStream Configuration Error Codes XMLEncryptor Class Introduction Properties Encoding EncryptedDataType EncryptionKey EncryptionMethod EncryptKey ExternalData InputBytes InputFile InputStream KeyEncryptionCertificate KeyEncryptionKey KeyEncryptionType KeyTransportMethod KeyWrapMethod OutputBytes OutputFile OutputStream UseGCM XMLNode XPathNamespaces (Collection) Methods Config Encrypt Events Error FormatElement FormatText Notification Types Certificate XMLNamespace SecureBlackboxStream Configuration Error Codes XMLSigner Class Introduction Properties CanonicalizationMethod Encoding ExternalCrypto HashAlgorithm InputBytes InputFile InputStream OutputBytes OutputFile OutputStream References (Collection) SignatureType SigningCertificate SigningChain (Collection) XMLElement XPathNamespaces (Collection) Methods AddDataReference AddReference Config ExtractAsyncData Sign SignAsyncBegin SignAsyncEnd SignExternal Events Error ExternalSign FormatElement FormatText Notification ResolveReference Types Certificate ExternalCrypto XMLNamespace XMLReference SecureBlackboxStream Configuration Error Codes XMLVerifier Class Introduction Properties AllSignaturesValid CanonicalizationMethod DataFile DataStream Encoding HashAlgorithm InputBytes InputFile InputStream KnownCertificates (Collection) References (Collection) SignatureValidationResult SigningCertificate XMLElement XPathNamespaces (Collection) Methods Config Verify VerifyDetached Events Error Notification ReferenceValidated ResolveReference SignatureFound SignatureValidated Types Certificate XMLNamespace XMLReference SecureBlackboxStream Configuration Error Codes Software License	Encrypt Method Encrypts the PDF document. Syntax public void encrypt(); Remarks Use this method to encrypt the PDF document as configured in the object's properties.
Copyright (c) 2022 /n software inc. - All rights reserved. SecureBlackbox 2020 Java Edition - Version 20.0 [Build 8156]