Skip to content

Latest commit

 

History

History
148 lines (123 loc) · 6.15 KB

nf-certenroll-iobjectid-initializefromalgorithmname.md

File metadata and controls

148 lines (123 loc) · 6.15 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:certenroll.IObjectId.InitializeFromAlgorithmName
IObjectId::InitializeFromAlgorithmName (certenroll.h)
Initializes the object from an algorithm name or an object identifier.
IObjectId interface [Security]
InitializeFromAlgorithmName method
IObjectId.InitializeFromAlgorithmName
IObjectId::InitializeFromAlgorithmName
InitializeFromAlgorithmName
InitializeFromAlgorithmName method [Security]
InitializeFromAlgorithmName method [Security]
IObjectId interface
certenroll/IObjectId::InitializeFromAlgorithmName
security.iobjectid_initializefromalgorithmname_method
security\iobjectid_initializefromalgorithmname_method.htm
security
ba8c1f11-9380-43a9-b444-b0fff114a176
12/05/2018
IObjectId interface [Security],InitializeFromAlgorithmName method, IObjectId.InitializeFromAlgorithmName, IObjectId::InitializeFromAlgorithmName, InitializeFromAlgorithmName, InitializeFromAlgorithmName method [Security], InitializeFromAlgorithmName method [Security],IObjectId interface, certenroll/IObjectId::InitializeFromAlgorithmName, security.iobjectid_initializefromalgorithmname_method
certenroll.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
CertEnroll.dll
Windows
19H1
IObjectId::InitializeFromAlgorithmName
certenroll/IObjectId::InitializeFromAlgorithmName
c++
APIRef
kbSyntax
COM
CertEnroll.dll
IObjectId.InitializeFromAlgorithmName

IObjectId::InitializeFromAlgorithmName

-description

The InitializeFromAlgorithmName method initializes the object from an algorithm name or an object identifier. This method has been provided primarily to enable you to initialize the object from a Cryptography API: Next Generation (CNG) algorithm name. You can, however, specify any OID name. This method is web enabled.

-parameters

-param GroupId [in]

An ObjectIdGroupId enumeration value that specifies the OID group to search. This can be any of the following algorithm groups:

  • XCN_CRYPT_HASH_ALG_OID_GROUP_ID
  • XCN_CRYPT_ENCRYPT_ALG_OID_GROUP_ID
  • XCN_CRYPT_PUBKEY_ALG_OID_GROUP_ID
  • XCN_CRYPT_SIGN_ALG_OID_GROUP_ID
In addition, you can also specify groups that do not contain cryptographic algorithms:
  • XCN_CRYPT_RDN_ATTR_OID_GROUP_ID
  • XCN_CRYPT_EXT_OR_ATTR_OID_GROUP_ID
  • XCN_CRYPT_ENHKEY_USAGE_OID_GROUP_ID
  • XCN_CRYPT_POLICY_OID_GROUP_ID
  • XCN_CRYPT_TEMPLATE_OID_GROUP_ID

-param KeyFlags [in]

An ObjectIdPublicKeyFlags enumeration value that specifies whether to search for a signing or an encryption algorithm. This can be one of the following values:

  • XCN_CRYPT_OID_INFO_PUBKEY_SIGN_KEY_FLAG
  • XCN_CRYPT_OID_INFO_PUBKEY_ENCRYPT_KEY_FLAG
You can use either value to disambiguate among algorithms such as RSA that can be used to both encrypt and sign messages. You must also specify XCN_CRYPT_PUBKEY_ALG_OID_GROUP_ID in the GroupId parameter.

-param AlgFlags [in]

An AlgorithmFlags enumeration value. This can be one of the following values:

  • AlgorithmFlagsNone
  • AlgorithmFlagsWrap
If you specify XCN_CRYPT_ENCRYPT_ALG_OID_GROUP_ID for the GroupId parameter, you can use the AlgorithmFlags enumeration to search for an OID that can be used to wrap a key. For example, you can retrieve information about the AES128wrap algorithm if you specify a bit length of 128 (see the Remarks section), set the strAlgorithmName parameter to AES, and specify AlgorithmFlagsWrap.

-param strAlgorithmName [in]

A BSTR variable that contains the name. You can specify a name, or an OID in dotted decimal format. The method verifies that the format is consistent with the ASN.1 X.208 standard. For more information about CNG algorithm names, see CNG Algorithm Identifiers.

-returns

If the function succeeds, the function returns S_OK.

If the function fails, it returns an HRESULT value that indicates the error. Possible values include, but are not limited to, those in the following table. For a list of common error codes, see Common HRESULT Values.

Return code/value Description
CERTSRV_E_PROPERTY_EMPTY
 The OID information could not be found.
CRYPT_E_UNKNOWN_ALGO
 The algorithm name is not recognized.
HRESULT_FROM_WIN32(ERROR_ALREADY_INITIALIZED)
 The object is already initialized.

-remarks

You can use the upper 16 bits of the GroupId parameter to specify the key size for algorithms that accept a variable bit length. For example, to initialize an IObjectId object from a 192-bit AES algorithm, specify "AES" for the strAlgorithmName parameter, shift the length left by 16, and perform a bitwise-OR combination on the shifted bit length and the GroupId value.

-see-also

IObjectId