Prerequisites (Windows* OS)

Build and Run Your First Intel® Cryptography Primitives Library Application (Windows* OS)

The library_get_started example helps you to check that the library is installed correctly. The application consists of two sections:

1. Get the library layer name and version.

2. Show the hardware optimizations used by the selected library layer and supported by CPU.

Its source code, along with examples for other algorithms, is available in the Intel® Cryptography Primitives Library open-source repository.

On Windows* OS, Intel® Cryptography Primitives Library applications are significantly easier to build with Microsoft* Visual Studio*. To build and run the example, follow the steps:

1. Make sure the compiler and Intel® Cryptography Primitives Library variables are set in your environment.

2. Get the examples sources:

   git clone https://github.com/intel/cryptography-primitives.git
   cd cryptography-primitives\examples

3. Run the cmake command to generate a Microsoft* Visual Studio* solution. On Windows* OS it is required to specify a generator (-G option) and optionally a toolchain (-T option) to build with Intel® oneAPI DPC++/C++ Compiler. Example:

   cmake CMakeLists.txt -B_build -G<vs_generator> [-T"Intel C++ Compiler <version>"]

   For the Visual Studio* generators options, please refer to the CMake help.

4. The build system will scan the system for the Intel® Cryptography Primitives Library, using the IPPCRYPTOROOT environment variable among other locations, so it works for both the Component and the Unified Directory Layout. If the library is found, you will see the following message:

   -- Found Intel® Cryptography Primitives Library at: C:/Program Files (x86)/Intel/oneAPI/ippcp/latest
   -- Configuring done

   If the library is not found automatically, you can specify the path to the library root folder (where the include\ and lib\ directories are located) using the -DIPPCRYPTO_ROOT_DIR option:

   cmake CMakeLists.txt -B_build -G<vs_generator> -DIPPCRYPTO_ROOT_DIR=<path>

5. Open the generated Visual Studio* solution in the IDE, select the (example) library_get_started project in the examples folder of project structure in IDE and run Build. You can also select a project that builds all examples by category (ippcp_examples_<category>) or the whole set of examples (ippcp_examples_all).

   To run the build from the command line, open “Developer Command Prompt for VS <version>” console and run the cmake command:

   cmake --build _build --target example_library_get_started --config Release

   where _build is the path to CMake build directory.

6. Run the application:

   _build\.build\RELEASE\examples\example_library_get_started.exe

For other build options, including building the examples together with the library sources, see README.md in the examples folder.

Training and Documentation

Notices and Disclaimers

Intel, the Intel logo, Intel Atom, Intel Core, Intel Xeon Phi, VTune and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries.

*Other names and brands may be claimed as the property of others.

© Intel Corporation.

This software and the related documents are Intel copyrighted materials, and your use of them is governed by the express license under which they were provided to you (License). Unless the License provides otherwise, you may not use, modify, copy, publish, distribute, disclose or transmit this software or the related documents without Intel’s prior written permission.

This software and the related documents are provided as is, with no express or implied warranties, other than those that are expressly stated in the License.