CryptoPkg: Change OPTIONAL keyword usage style

[mirror_edk2.git] / CryptoPkg / Library / BaseCryptLibNull / Pk / CryptPkcs1OaepNull.c

/** @file\r
  This file contains UEFI wrapper functions for RSA PKCS1v2 OAEP encryption routines.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  Copyright (C) 2016 Microsoft Corporation. All Rights Reserved.\r
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
\r
**/\r
\r
#include "InternalCryptLib.h"\r
\r
/**\r
  Encrypts a blob using PKCS1v2 (RSAES-OAEP) schema. On success, will return the\r
  encrypted message in a newly allocated buffer.\r
\r
  Return FALSE to indicate this interface is not supported.\r
\r
  @param[in]  PublicKey           A pointer to the DER-encoded X509 certificate that\r
                                  will be used to encrypt the data.\r
  @param[in]  PublicKeySize       Size of the X509 cert buffer.\r
  @param[in]  InData              Data to be encrypted.\r
  @param[in]  InDataSize          Size of the data buffer.\r
  @param[in]  PrngSeed            [Optional] If provided, a pointer to a random seed buffer\r
                                  to be used when initializing the PRNG. NULL otherwise.\r
  @param[in]  PrngSeedSize        [Optional] If provided, size of the random seed buffer.\r
                                  0 otherwise.\r
  @param[out] EncryptedData       Pointer to an allocated buffer containing the encrypted\r
                                  message.\r
  @param[out] EncryptedDataSize   Size of the encrypted message buffer.\r
\r
  @retval FALSE                   This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
Pkcs1v2Encrypt (\r
  IN   CONST UINT8  *PublicKey,\r
  IN   UINTN        PublicKeySize,\r
  IN   UINT8        *InData,\r
  IN   UINTN        InDataSize,\r
  IN   CONST UINT8  *PrngSeed   OPTIONAL,\r
  IN   UINTN        PrngSeedSize   OPTIONAL,\r
  OUT  UINT8        **EncryptedData,\r
  OUT  UINTN        *EncryptedDataSize\r
  )\r
{\r
  ASSERT (FALSE);\r
  return FALSE;\r
}\r