\r
## Statically Linking Cryptographic Services\r
\r
-The figure below shows an example of a firmware modules that requires the use of\r
+The figure below shows an example of a firmware module that requires the use of\r
cryptographic services. The cryptographic services are provided by three library\r
classes called BaseCryptLib, TlsLib, and HashApiLib. These library classes are\r
implemented using APIs from the OpenSSL project that are abstracted by the\r
the smallest subset of services required to build the OpenSSL project in the\r
private library class called IntrinsicLib.\r
\r
-The CryptoPkg provides several instances if the BaseCryptLib and OpensslLib with\r
+The CryptoPkg provides several instances of the BaseCryptLib and OpensslLib with\r
different cryptographic service features and performance optimizations. The\r
platform developer must select the correct instances based on cryptographic\r
service requirements in each UEFI/PI firmware phase (SEC, PEI, DXE, UEFI,\r
\r
The EDK II modules/libraries that require cryptographic services use the same\r
BaseCryptLib/TlsLib/HashApiLib APIs. This means no source changes are required\r
-to use static linking or dynamic linking. It is a platform configuration options\r
-to select static linking or dynamic linking. This choice can be make globally,\r
-per firmware module type, or individual modules.\r
+to use static linking or dynamic linking. It is a platform configuration option\r
+to select static linking or dynamic linking. This choice can be made globally,\r
+per firmware module type, or for individual modules.\r
\r
```\r
+===================+ +===================+ +===================+\r
indicates if the family or service is deprecated or recommended to not be used.\r
It also shows which *CryptLib library instances support the family or service.\r
If a cell is blank then the service or family is always disabled and the\r
-`PcdCryptoServiceFamilyEnable` settings for that family or service is ignored.\r
+`PcdCryptoServiceFamilyEnable` setting for that family or service is ignored.\r
If the cell is not blank, then the service or family is configurable using\r
`PcdCryptoServiceFamilyEnable` as long as the correct OpensslLib or TlsLib is\r
also configured.\r
\r
The following table can be used to help select the best OpensslLib instance for\r
each phase. The Size column only shows the estimated size increase for a\r
-compressed IA32/X64 modules that uses the cryptographic services with\r
+compressed IA32/X64 module that uses the cryptographic services with\r
`OpensslLib.inf` as the baseline size. The actual size increase depends on the\r
specific set of enabled cryptographic services. If ECC services are not\r
-required, then size can be reduced by using OpensslLib.inf instead of\r
+required, then the size can be reduced by using OpensslLib.inf instead of\r
`OpensslLibFull.inf`. Performance optimization requires a size increase.\r
\r
| OpensslLib Instance | SSL | ECC | Perf Opt | CPU Arch | Size |\r
\r
### UEFI Runtime Driver Library Mappings\r
\r
-UEFI Runtime Drivers only supports static linking of cryptographic services.\r
-The following library mappings are recommended for UEFI Runtime Drivers. It uses\r
-the runtime specific version of the BaseCryptLib and the null version of the\r
-TlsLib because TLS services are not typically used in runtime.\r
+UEFI Runtime Drivers only support static linking of cryptographic services.\r
+The following library mappings are recommended for UEFI Runtime Drivers. They\r
+use the runtime specific version of the BaseCryptLib and the null version of the\r
+TlsLib because TLS services are not typically used at runtime.\r
\r
```\r
[LibraryClasses.common.DXE_RUNTIME_DRIVER]\r
and CryptoSmm modules.\r
\r
* `gEfiCryptoPkgTokenSpaceGuid.PcdHashApiLibPolicy` - This PCD indicates the\r
- HASH algorithm to to use in the BaseHashApiLib to calculate hash of data. The\r
+ HASH algorithm to use in the BaseHashApiLib to calculate hash of data. The\r
default hashing algorithm for BaseHashApiLib is set to HASH_ALG_SHA256.\r
| Setting | Algorithm |\r
|------------|------------------|\r
* `gEfiCryptoPkgTokenSpaceGuid.PcdCryptoServiceFamilyEnable` - Enable/Disable\r
the families and individual services produced by the EDK II Crypto\r
Protocols/PPIs. The default is all services disabled. This Structured PCD is\r
- associated with `PCD_CRYPTO_SERVICE_FAMILY_ENABLE` structure that defined in\r
- `Include/Pcd/PcdCryptoServiceFamilyEnable.h`.\r
+ associated with the `PCD_CRYPTO_SERVICE_FAMILY_ENABLE` structure that is\r
+ defined in `Include/Pcd/PcdCryptoServiceFamilyEnable.h`.\r
\r
There are three layers of priority that determine if a specific family or\r
individual cryptographic service is actually enabled in the CryptoPei,\r
OpensslLib instance linked, then the service is always disabled.\r
2) BaseCryptLib instance selection.\r
* CryptoPei is always linked with the PeiCryptLib instance of the\r
- BaseCryptLib library class. The table above have a column for the\r
+ BaseCryptLib library class. The table above has a column for the\r
PeiCryptLib. If the family or service is blank, then that family or\r
service is always disabled.\r
* CryptoDxe is always linked with the BaseCryptLib instance of the\r
- BaseCryptLib library class. The table above have a column for the\r
+ BaseCryptLib library class. The table above has a column for the\r
BaseCryptLib. If the family or service is blank, then that family or\r
service is always disabled.\r
* CryptoSmm is always linked with the SmmCryptLib instance of the\r
- BaseCryptLib library class. The table above have a column for the\r
+ BaseCryptLib library class. The table above has a column for the\r
SmmCryptLib. If the family or service is blank, then that family or\r
service is always disabled.\r
3) If a family or service is enabled in the OpensslLib instance and it is\r
bit fields for each family of services. All of the families are disabled\r
by default. An entire family of services can be enabled by setting the\r
family field to the value `PCD_CRYPTO_SERVICE_ENABLE_FAMILY`. Individual\r
- services can be enabled by setting a single service name to `TRUE`.\r
- Settings listed later in the DSC file have priority over settings earlier\r
- in the DSC file, so it is legal for an entire family to be enabled first\r
- and then a few individual services disabled by setting the service name to\r
- `FALSE`.\r
+ services can be enabled by setting a single service name (bit) to `TRUE`.\r
+ Settings listed later in the DSC file have priority over settings listed\r
+ earlier in the DSC file, so it is valid for an entire family to be enabled\r
+ first and then for a few individual services to be disabled by setting\r
+ those service names to `FALSE`.\r
\r
#### Common PEI PcdCryptoServiceFamilyEnable Settings\r
\r
projects / mirror_edk2.git / commitdiff