Documentation fixes.

pull/236/head
David Garske 2022-07-28 13:24:05 -07:00
parent ed551006fb
commit cf89cc42a7
2 changed files with 4 additions and 4 deletions

View File

@ -479,7 +479,7 @@ WOLFTPM_API int wolfTPM2_SetAuthHandleName(WOLFTPM2_DEV* dev, int index, const W
\param tpmKey pointer to a WOLFTPM2_KEY that will be used as a salt for the session
\param bind pointer to a WOLFTPM2_HANDLE that will be used to make the session bounded
\param sesType byte value, the session type (HMAC, Policy or Trial)
\param encDecAlg integer value, specifying the algorithm in case of parameter encryption
\param encDecAlg integer value, specifying the algorithm in case of parameter encryption (TPM_ALG_CFB or TPM_ALG_XOR). Any value not CFB or XOR is considered NULL and parameter encryption is disabled.
\sa wolfTPM2_SetAuthSession
*/
@ -500,7 +500,7 @@ WOLFTPM_API int wolfTPM2_StartSession(WOLFTPM2_DEV* dev,
\param session pointer to an empty WOLFTPM2_SESSION struct
\sa wolfTPM2_SetAuthSession
\sa wolfTPM2_StartAuthSession
\sa wolfTPM2_StartSession
*/
WOLFTPM_API int wolfTPM2_CreateAuthSession_EkPolicy(WOLFTPM2_DEV* dev,
WOLFTPM2_SESSION* tpmSession);

View File

@ -645,7 +645,7 @@ namespace wolfTPM
/// </summary>
/// <param name="device">Reference to Device class reference</param>
/// <param name="parentKey"></param>
/// <param name="algMode">The algorithm for parameter encryption (TPM2_Alg.NULL or TPM2_Alg.CFB or TPM2_Alg.XOR)</param>
/// <param name="encDecAlg">The algorithm for parameter encryption (TPM2_Alg.NULL, TPM2_Alg.CFB or TPM2_Alg.XOR). Using NULL disables parameter encryption</param>
/// <returns>Success: 0</returns>
public int StartAuth(Device device, Key parentKey, TPM2_Alg encDecAlg)
{
@ -1007,7 +1007,7 @@ namespace wolfTPM
/// <param name="tmpKey">A key that will be used as a salt for the session.</param>
/// <param name="bind">A handle that will be used to make the session bounded.</param>
/// <param name="sesType">The session type (HMAC, Policy or Trial).</param>
/// <param name="encDecAlg">The algorithm for parameter encryption (TPM2_Alg.NULL or TPM2_Alg.CFB or TPM2_Alg.XOR)</param>
/// <param name="encDecAlg">The algorithm for parameter encryption (TPM2_Alg.NULL, TPM2_Alg.CFB or TPM2_Alg.XOR). Using NULL disables parameter encryption</param>
/// <returns>0: Success; BAD_FUNC_ARG: check provided arguments.</returns>
public int StartSession(Session tpmSession,
Key tmpKey,