Interface SybCert::SybCertInterface

Operation Index

• Base64Decode
• Base64Encode
• ChangePin
• DeleteCert
• DeleteCertAndPrivateKey
• DeletePrivateKey
• ExportPKCS12CertAndKey
• GenCertRequest
• GenCertRequest__1
• GenCertRequest__2
• GenerateAndSaveCertSignedByTestCA
• GenerateAndSaveCertSignedByTestCA__1
• GenerateAndSaveCertSignedByTestCA__2
• GenerateAndSaveEntrustCert
• GenerateAndSaveEntrustCert__1
• GenerateCertSignedByTestCA
• GenerateKeyPair
• GenerateKeyPair__1
• GenerateTestCA
• GetAvailablePbeAlgorithms
• GetCACertificates
• GetCATrustInfo
• GetCert
• GetCertificateByDigest
• GetCertificateDigest
• GetCertInfo
• GetCertInfo__1
• GetCertInfo__2
• GetErrMsg
• GetMaxRSAKeySize
• GetModules
• GetOtherCertificates
• GetPrivateKeyInfo
• GetPrivateKeyInfo__1
• GetPrivateKeys
• GetSCLProfileInfo
• GetSCLProfiles
• GetTokenContext
• GetTokens
• GetTrustedCAs
• GetUserCertificates
• ImportPKCS12CertAndKey
• InitUserPin
• InstallCert
• IsEntrustAvailable
• IsEntrustCMSAvailable
• Login
• Logout
• ModifyCATrustInfo
• ModuleInfo
• PbeDecrypt
• PbeEncrypt
• ReleaseTokenContext
• RemoveTestCA
• RenameLabel
• SetPrivateKeySensitivity
• TokenInfo
• VerifyCert
• VerifyEntrustCert

Operations

• Base64Decode

      boolean Base64Decode
      (
          in string EncodedData,
          out SybCert::BINARY PlainData,
          out SybCert::ERRCODE ErrNum
      );
  

• Base64Encode

      boolean Base64Encode
      (
          in SybCert::BINARY PlainData,
          out string EncodedData,
          out SybCert::ERRCODE ErrNum
      );
  

• ChangePin

      boolean ChangePin
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::PIN OldPin,
          in SybCert::PINLEN OldPinLen,
          in SybCert::PIN NewPin,
          in SybCert::PINLEN NewPinLen,
          out SybCert::ERRCODE ErrNum
      );
  

• DeleteCert

      boolean DeleteCert
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL certificateLabel,
          out SybCert::ERRCODE ErrNum
      );
  

• DeleteCertAndPrivateKey

      boolean DeleteCertAndPrivateKey
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL CertLabel,
          out SybCert::ERRCODE ErrNum
      );
  

• DeletePrivateKey

      boolean DeletePrivateKey
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL KeyLabel,
          out SybCert::ERRCODE ErrNum
      );
  

• ExportPKCS12CertAndKey

      boolean ExportPKCS12CertAndKey
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in boolean TwoPasswords,
          in SybCert::PASSPHRASE MacPassword,
          in SybCert::PASSPHRASE EncryptionPassword,
          in SybCert::LABEL certLabel,
          in boolean IncludePrivateKey,
          in boolean IncludecertificateChain,
          in SybCert::PBEALGO PrivKeyPbeAlgo,
          in SybCert::PBEALGO certificatePbeAlgo,
          in long EncryptionKeyIterationCount,
          in long MacKeyIterationCount,
          out SybCert::PKCS12KEYDATA PKCS12FormattedData,
          out SybCert::ERRCODE ErrNum
      );
  

• GenCertRequest

      boolean GenCertRequest
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::KEYSTRENGTH strength,
          in SybCert::LABEL KeyLabel,
          in SybCert::CERTREQINFO certificateReqInfo,
          out SybCert::CERTREQ certificateRequest,
          out SybCert::ERRCODE ErrNum
      );
  

• GenCertRequest__1

      boolean GenCertRequest__1
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::KEYSTRENGTH strength,
          in boolean Sensitive,
          in SybCert::LABEL KeyLabel,
          in SybCert::CERTREQINFO certificateReqInfo,
          out SybCert::CERTREQ certificateRequest,
          out SybCert::ERRCODE ErrNum
      );
  

• GenCertRequest__2

      boolean GenCertRequest__2
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::KEYSTRENGTH strength,
          in boolean Sensitive,
          in boolean utf8,
          in SybCert::LABEL KeyLabel,
          in SybCert::CERTREQINFO certificateReqInfo,
          out SybCert::CERTREQ certificateRequest,
          out SybCert::ERRCODE ErrNum
      );
  

• GenerateAndSaveCertSignedByTestCA

      boolean GenerateAndSaveCertSignedByTestCA
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::PASSPHRASE CAPassPhrase,
          in SybCert::CERTREQINFO certificateReqInfo,
          in SybCert::LABEL KeyLabel,
          in SybCert::KEYSTRENGTH strength,
          in long ValidityPeriod,
          in SybCert::CERTUSAGETYPE certificateUsage,
          out SybCert::ERRCODE ErrNum
      );
  

• GenerateAndSaveCertSignedByTestCA__1

      boolean GenerateAndSaveCertSignedByTestCA__1
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::PASSPHRASE CAPassPhrase,
          in SybCert::CERTREQINFO certificateReqInfo,
          in SybCert::LABEL KeyLabel,
          in SybCert::KEYSTRENGTH strength,
          in boolean Sensitive,
          in long ValidityPeriod,
          in SybCert::CERTUSAGETYPE certificateUsage,
          out SybCert::ERRCODE ErrNum
      );
  

• GenerateAndSaveCertSignedByTestCA__2

      boolean GenerateAndSaveCertSignedByTestCA__2
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::PASSPHRASE CAPassPhrase,
          in SybCert::CERTREQINFO certificateReqInfo,
          in SybCert::LABEL KeyLabel,
          in SybCert::KEYSTRENGTH strength,
          in boolean Sensitive,
          in boolean utf8,
          in long ValidityPeriod,
          in SybCert::CERTUSAGETYPE certificateUsage,
          out SybCert::ERRCODE ErrNum
      );
  

• GenerateAndSaveEntrustCert

      boolean GenerateAndSaveEntrustCert
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::KEYSTRENGTH strength,
          in boolean Sensitive,
          in SybCert::LABEL KeyLabel,
          in SybCert::CERTREQINFO certificateReqInfo,
          in SybCert::NAME cmsIniFile,
          in SybCert::NAME refNum,
          in SybCert::NAME authCode,
          out SybCert::ERRMSG ErrorMessage,
          out SybCert::ERRCODE ErrNum
      );
  

• GenerateAndSaveEntrustCert__1

      boolean GenerateAndSaveEntrustCert__1
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::KEYSTRENGTH strength,
          in boolean Sensitive,
          in boolean utf8,
          in SybCert::LABEL KeyLabel,
          in SybCert::CERTREQINFO certificateReqInfo,
          in SybCert::NAME cmsIniFile,
          in SybCert::NAME refNum,
          in SybCert::NAME authCode,
          out SybCert::ERRMSG ErrorMessage,
          out SybCert::ERRCODE ErrNum
      );
  

• GenerateCertSignedByTestCA

      boolean GenerateCertSignedByTestCA
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::PASSPHRASE CAPassPhrase,
          in SybCert::CERTREQ certificateReq,
          in SybCert::FORMATTYPE certificateFormatType,
          in long ValidityPeriod,
          in SybCert::CERTUSAGETYPE certificateUsage,
          out SybCert::CERT certificate,
          out SybCert::ERRCODE ErrNum
      );
  

• GenerateKeyPair

      boolean GenerateKeyPair
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::KEYSTRENGTH strength,
          in SybCert::LABEL certLabel,
          out SybCert::ERRCODE ErrNum
      );
  

• GenerateKeyPair__1

      boolean GenerateKeyPair__1
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::KEYSTRENGTH strength,
          in boolean Sensitive,
          in SybCert::LABEL certLabel,
          out SybCert::ERRCODE ErrNum
      );
  

• GenerateTestCA

      boolean GenerateTestCA
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::PASSPHRASE secret,
          out SybCert::ERRCODE ErrNum
      );
  

• GetAvailablePbeAlgorithms

      boolean GetAvailablePbeAlgorithms
      (
          in SybCert::TOKENREFERENCE TokenRef,
          out SybCert::PBEALGOS algo,
          out SybCert::ERRCODE ErrNum
      );
  

• GetCACertificates

      boolean GetCACertificates
      (
          in SybCert::TOKENREFERENCE TokenRef,
          out SybCert::LABELS certificateLabels,
          out SybCert::ERRCODE ErrNum
      );
  

• GetCATrustInfo

      boolean GetCATrustInfo
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL caLabel,
          out SybCert::TRUSTINFO ti,
          out SybCert::ERRCODE ErrNum
      );
  

• GetCert

      boolean GetCert
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL certificateLabel,
          in SybCert::FORMATTYPE ft,
          out SybCert::CERT certificate,
          out SybCert::ERRCODE ErrNum
      );
  

• GetCertificateByDigest

      boolean GetCertificateByDigest
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in string ShaDigest,
          out SybCert::LABEL certificateLabel,
          out SybCert::ERRCODE ErrNum
      );
  

• GetCertificateDigest

  This routine returns base64 encoded SHA digest of the subject public key specified by the certificate label and binary version of SHA digest (20 bytes).

      boolean GetCertificateDigest
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL certificateLabel,
          out string ShaDigest,
          out SybCert::BINARY Digest,
          out SybCert::ERRCODE ErrNum
      );
  

• GetCertInfo

      boolean GetCertInfo
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL certificateLabel,
          out SybCert::CERTINFO certificateInfo,
          out SybCert::ERRCODE ErrNum
      );
  

• GetCertInfo__1

      boolean GetCertInfo__1
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL certificateLabel,
          out boolean Sensitive,
          out SybCert::CERTINFO certificateInfo,
          out SybCert::ERRCODE ErrNum
      );
  

• GetCertInfo__2

      boolean GetCertInfo__2
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL certificateLabel,
          out boolean Sensitive,
          out SybCert::CERTINFO certificateInfo,
          out SybCert::CERTEXTENSIONS otherExtensions,
          out SybCert::ERRCODE ErrNum
      );
  

• GetErrMsg

      boolean GetErrMsg
      (
          in SybCert::ERRCODE ErrNum,
          out SybCert::ERRMSG msg
      );
  

• GetMaxRSAKeySize

      boolean GetMaxRSAKeySize
      (
          in SybCert::TOKENREFERENCE TokenRef,
          out SybCert::KEYSTRENGTH strength,
          out SybCert::ERRCODE ErrNum
      );
  

• GetModules

      boolean GetModules
      (
          out SybCert::NAMES PKCSModuleNames,
          out SybCert::ERRCODE ErrNum
      );
  

• GetOtherCertificates

      boolean GetOtherCertificates
      (
          in SybCert::TOKENREFERENCE TokenRef,
          out SybCert::LABELS certificateLabels,
          out SybCert::ERRCODE ErrNum
      );
  

• GetPrivateKeyInfo

      boolean GetPrivateKeyInfo
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL certLabel,
          out SybCert::KEYINFO ki,
          out SybCert::ERRCODE ErrNum
      );
  

• GetPrivateKeyInfo__1

      boolean GetPrivateKeyInfo__1
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL certLabel,
          out boolean Sensitive,
          out SybCert::KEYINFO ki,
          out SybCert::ERRCODE ErrNum
      );
  

• GetPrivateKeys

      boolean GetPrivateKeys
      (
          in SybCert::TOKENREFERENCE TokenRef,
          out SybCert::LABELS certificateLabels,
          out SybCert::ERRCODE ErrNum
      );
  

• GetSCLProfileInfo

      boolean GetSCLProfileInfo
      (
          in SybCert::SCLPROFILE profile,
          out SybCert::SCLPROFILEDESC ProfileDesc,
          out SybCert::ERRCODE ErrNum
      );
  

• GetSCLProfiles

      boolean GetSCLProfiles
      (
          out SybCert::SCLPROFILES profile,
          out SybCert::ERRCODE ErrNum
      );
  

• GetTokenContext

      boolean GetTokenContext
      (
          in SybCert::NAME PKCSModuleName,
          in SybCert::NAME PKCSSlotName,
          out SybCert::TOKENREFERENCE TokenRef,
          out SybCert::ERRCODE ErrNum
      );
  

• GetTokens

      boolean GetTokens
      (
          in SybCert::NAME PKCSModuleName,
          out SybCert::NAMES TokenNames,
          out SybCert::ERRCODE ErrNum
      );
  

• GetTrustedCAs

      boolean GetTrustedCAs
      (
          in SybCert::TOKENREFERENCE TokenRef,
          out SybCert::LABELS certificateLabels,
          out SybCert::ERRCODE ErrNum
      );
  

• GetUserCertificates

      boolean GetUserCertificates
      (
          in SybCert::TOKENREFERENCE TokenRef,
          out SybCert::LABELS certificateLabels,
          out SybCert::ERRCODE ErrNum
      );
  

• ImportPKCS12CertAndKey

      boolean ImportPKCS12CertAndKey
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::PKCS12KEYDATA certificateKey,
          in boolean MarkPrivKeyExportable,
          in boolean TwoPasswords,
          in SybCert::PASSPHRASE MacPassword,
          in SybCert::PASSPHRASE EncryptionPassword,
          out SybCert::LABELS CertLabels,
          out SybCert::ERRCODE ErrNum
      );
  

• InitUserPin

      boolean InitUserPin
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::PIN UserPin,
          in SybCert::PINLEN UserPinLen,
          out SybCert::ERRCODE ErrNum
      );
  

• InstallCert

      boolean InstallCert
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::CERT certificate,
          in SybCert::FORMATTYPE certificateFormatType,
          out SybCert::LABEL CAcertificateLabel,
          out SybCert::ERRCODE ErrNum
      );
  

• IsEntrustAvailable

      boolean IsEntrustAvailable
      (
          out SybCert::ERRCODE ErrNum
      );
  

• IsEntrustCMSAvailable

      boolean IsEntrustCMSAvailable
      (
          out SybCert::ERRMSG ErrorMessage,
          out SybCert::ERRCODE ErrNum
      );
  

• Login

      boolean Login
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::PIN UserPin,
          in SybCert::PINLEN PinLength,
          in SybCert::USERTYPE ut,
          out SybCert::ERRCODE ErrNum
      );
  

• Logout

      boolean Logout
      (
          in SybCert::TOKENREFERENCE TokenRef,
          out SybCert::ERRCODE ErrNum
      );
  

• ModifyCATrustInfo

      boolean ModifyCATrustInfo
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL certificateLabel,
          in SybCert::TRUSTINFO ti,
          out SybCert::ERRCODE ErrNum
      );
  

• ModuleInfo

      boolean ModuleInfo
      (
          in SybCert::TOKENREFERENCE TokenRef,
          out SybCert::MODULEINFO theModuleInfo,
          out SybCert::ERRCODE ErrNum
      );
  

• PbeDecrypt

      boolean PbeDecrypt
      (
          in SybCert::BINARY Password,
          in SybCert::BINARY Salt,
          in SybCert::PBEALGO Algo,
          in SybCert::BINARY EncrData,
          out SybCert::BINARY PlainText,
          out SybCert::ERRCODE ErrNum
      );
  

• PbeEncrypt

  If password is supplied, password will be used as input to the PBE, otherwise password is ignored. salt if supplied will be used, otherwise salt will be randomly generated and returned to the caller. algo is the PBE algo to use. plainText is the data to encrypt, and encrData is the encrypted data.

      boolean PbeEncrypt
      (
          in SybCert::BINARY Password,
          inout SybCert::BINARY Salt,
          in SybCert::PBEALGO Algo,
          in SybCert::BINARY PlainText,
          out SybCert::BINARY EncrData,
          out SybCert::ERRCODE ErrNum
      );
  

• ReleaseTokenContext

      boolean ReleaseTokenContext
      (
          in SybCert::TOKENREFERENCE TokenRef,
          out SybCert::ERRCODE ErrNum
      );
  

• RemoveTestCA

      boolean RemoveTestCA
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::PASSPHRASE CAPassPhrase,
          out SybCert::ERRCODE ErrNum
      );
  

• RenameLabel

      boolean RenameLabel
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL oldLabel,
          in SybCert::LABEL newLabel,
          out SybCert::ERRCODE ErrNum
      );
  

• SetPrivateKeySensitivity

      boolean SetPrivateKeySensitivity
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL certLabel,
          out SybCert::ERRCODE ErrNum
      );
  

• TokenInfo

      boolean TokenInfo
      (
          in SybCert::TOKENREFERENCE TokenRef,
          out SybCert::TOKENINFO theTokenInfo,
          out SybCert::ERRCODE ErrNum
      );
  

• VerifyCert

      boolean VerifyCert
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL certificateLabel,
          out SybCert::CERTVRFYINFO certificateVrfyStatus,
          out SybCert::ERRCODE ErrNum
      );
  

• VerifyEntrustCert

      boolean VerifyEntrustCert
      (
          in SybCert::TOKENREFERENCE TokenRef,
          in SybCert::LABEL certificateLabel,
          in SybCert::NAME cmsIniFile,
          out SybCert::CERTVRFYINFO certificateVrfyStatus,
          out SybCert::ERRMSG ErrorMessage,
          out SybCert::ERRCODE ErrNum
      );