TElCustomCertStorage.LoadFromStreamPFX method

TElCustomCertStorage.LoadFromStreamPFX

Use this method to load multiple certificates stored in PFX (PKCS12) format from stream.

Declaration

[C#]
int LoadFromStreamPFX(System.IO.Stream Stream, string Password, int Count);

[VB.NET]
Function LoadFromStreamPFX(ByVal Stream As System.IO.Stream, ByVal Password As String, ByVal Count As Integer) As Integer

[Pascal]
function LoadFromStreamPFX(Stream: TStream; const Password: string; Count: integer = 0): integer;

[C++]
int32_t LoadFromStreamPFX(TStream &Stream, const std::string &Password, int32_t Count);
int32_t LoadFromStreamPFX(TStream *Stream, const std::string &Password, int32_t Count);

[PHP]
integer LoadFromStreamPFX(TStream $Stream, string $Password, integer $Count)

[Java]
int loadFromStreamPFX(InputStream Stream, String Password, int Count);
int loadFromStreamPFX(TElStream Stream, String Password, int Count);

Parameters

Stream - The stream from which the certificates are loaded.
Count - Optional parameter that specified the number of bytes to be read. If this parameter is zero, the stream from current position till the end is read.
Password - Specifies the pass phrase to decrypt the certificates data. If certificates are not encrypted, set this parameter to empty string.

Return value

0 if certificates were successfully loaded.
PKCS12 error code otherwise.

PKCS12 Error codes

[.NET] [Pascal]	Value	Description
SB_PKCS12_ERROR_INVALID_ASN_DATA	7937 (0x1F01)	Buffer doesn't contain a valid PFX sequence
SB_PKCS12_ERROR_NO_DATA	7938 (0x1F02)	The PFX message doesn't contain any certificate
SB_PKCS12_ERROR_INVALID_DATA	7939 (0x1F03)	Some parameters of PFX message are invalid
SB_PKCS12_ERROR_INVALID_VERSION	7940 (0x1F04)	PFX message version is invalid
SB_PKCS12_ERROR_INVALID_CONTENT	7941 (0x1F05)	PFX message contains invalid content
SB_PKCS12_ERROR_INVALID_AUTHENTICATED_SAFE_DATA	7942 (0x1F06)	AuthenticatedSafe part of PFX message is invalid
SB_PKCS12_ERROR_INVALID_MAC_DATA	7943 (0x1F07)	MAC part of PFX message PFX message is invalid
SB_PKCS12_ERROR_INVALID_SAFE_CONTENTS	7944 (0x1F08)	The entity located in PFX message has invalid content type.
SB_PKCS12_ERROR_INVALID_SAFE_BAG	7945 (0x1F09)	The entity located in PFX message has invalid format
SB_PKCS12_ERROR_INVALID_SHROUDED_KEY_BAG	7946 (0x1F0A)	The private key contained in PFX message has invalid format
SB_PKCS12_ERROR_UNKNOWN_PBE_ALGORITHM	7947 (0x1F0B)	Saving: invalid PBE algorithm specified Loading: unknown PBE algorithm was used to encrypt the message.
SB_PKCS12_ERROR_INTERNAL_ERROR	7948 (0x1F0C)	Internal error occured. Please contact SecureBlackbox support.
SB_PKCS12_ERROR_INVALID_PBE_ALGORITHM_PARAMS	7949 (0x1F0D)	PBE algorithm params (iteration count and salt) are invalid
SB_PKCS12_ERROR_INVALID_CERT_BAG	7950 (0x1F0E)	The certificate contained in PFX message has invalid format
SB_PKCS12_ERROR_UNSUPPORTED_CERTIFICATE_TYPE	7951 (0x1F0F)	The certificate contained in PFX message has unsupported type
SB_PKCS12_ERROR_INVALID_PRIVATE_KEY	7952 (0x1F10)	The private key contained in PFX message has invalid format
SB_PKCS12_ERROR_INVALID_MAC	7953 (0x1F11)	MAC verification failed
SB_PKCS12_ERROR_NO_CERTIFICATES	7954 (0x1F12)	Saving: nothing to save
SB_PKCS12_ERROR_INVALID_PASSWORD	7955 (0x1F13)	Invalid password was specified. Can not decrypt certificate.
SB_PKCS12_ERROR_BUFFER_TOO_SMALL	7956 (0x1F14)	Buffer doesn't have enough space to store encoded certificate
SB_PKCS12_ERROR_INVALID_CRL_BAG	7957 (0x1F15)	Invalid PKCS12 Bag structure.
SB_PKCS12_ERROR_UNSUPPORTED_CRL_TYPE	7958 (0x1F16)	Unsupported CRL type.

Description

Use this method to load certificates in PFX format from the stream. PFX format supports storing of private keys.

Discuss this help topic in SecureBlackbox Forum