1 /*
2  * Copyright 2022-2024 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9 
10 #ifndef OSSL_SM4_PLATFORM_H
11 # define OSSL_SM4_PLATFORM_H
12 # pragma once
13 
14 # if defined(OPENSSL_CPUID_OBJ)
15 #  if defined(__aarch64__) ||  defined (_M_ARM64)
16 #   include "arm_arch.h"
17 extern unsigned int OPENSSL_arm_midr;
vpsm4_capable(void)18 static inline int vpsm4_capable(void)
19 {
20     return (OPENSSL_armcap_P & ARMV8_CPUID) &&
21             (MIDR_IS_CPU_MODEL(OPENSSL_arm_midr, ARM_CPU_IMP_ARM, ARM_CPU_PART_V1) ||
22              MIDR_IS_CPU_MODEL(OPENSSL_arm_midr, ARM_CPU_IMP_ARM, ARM_CPU_PART_N1));
23 }
vpsm4_ex_capable(void)24 static inline int vpsm4_ex_capable(void)
25 {
26     return (OPENSSL_armcap_P & ARMV8_CPUID) &&
27             (MIDR_IS_CPU_MODEL(OPENSSL_arm_midr, HISI_CPU_IMP, HISI_CPU_PART_KP920));
28 }
29 #   if defined(VPSM4_ASM)
30 #    define VPSM4_CAPABLE vpsm4_capable()
31 #    define VPSM4_EX_CAPABLE vpsm4_ex_capable()
32 #   endif
33 #   define HWSM4_CAPABLE (OPENSSL_armcap_P & ARMV8_SM4)
34 #   define HWSM4_set_encrypt_key sm4_v8_set_encrypt_key
35 #   define HWSM4_set_decrypt_key sm4_v8_set_decrypt_key
36 #   define HWSM4_encrypt sm4_v8_encrypt
37 #   define HWSM4_decrypt sm4_v8_decrypt
38 #   define HWSM4_cbc_encrypt sm4_v8_cbc_encrypt
39 #   define HWSM4_ecb_encrypt sm4_v8_ecb_encrypt
40 #   define HWSM4_ctr32_encrypt_blocks sm4_v8_ctr32_encrypt_blocks
41 #  elif defined(OPENSSL_CPUID_OBJ) && defined(__riscv) && __riscv_xlen == 64
42 /* RV64 support */
43 #   include "riscv_arch.h"
44 /* Zvksed extension (vector crypto SM4). */
45 int rv64i_zvksed_sm4_set_encrypt_key(const unsigned char *userKey,
46                                      SM4_KEY *key);
47 int rv64i_zvksed_sm4_set_decrypt_key(const unsigned char *userKey,
48                                      SM4_KEY *key);
49 void rv64i_zvksed_sm4_encrypt(const unsigned char *in, unsigned char *out,
50                               const SM4_KEY *key);
51 void rv64i_zvksed_sm4_decrypt(const unsigned char *in, unsigned char *out,
52                               const SM4_KEY *key);
53 #  elif (defined(__x86_64) || defined(__x86_64__) || defined(_M_AMD64) || defined(_M_X64))
54 /* Intel x86_64 support */
55 #   include "internal/cryptlib.h"
56 #   define HWSM4_CAPABLE_X86_64 \
57     ((OPENSSL_ia32cap_P[2] & (1 << 5)) && (OPENSSL_ia32cap_P[5] & (1 << 2)))
58 int hw_x86_64_sm4_set_key(const unsigned char *userKey, SM4_KEY *key);
59 int hw_x86_64_sm4_set_decryption_key(const unsigned char *userKey, SM4_KEY *key);
60 void hw_x86_64_sm4_encrypt(const unsigned char *in, unsigned char *out,
61                            const SM4_KEY *key);
62 void hw_x86_64_sm4_decrypt(const unsigned char *in, unsigned char *out,
63                            const SM4_KEY *key);
64 #  endif
65 # endif /* OPENSSL_CPUID_OBJ */
66 
67 # if defined(HWSM4_CAPABLE)
68 int HWSM4_set_encrypt_key(const unsigned char *userKey, SM4_KEY *key);
69 int HWSM4_set_decrypt_key(const unsigned char *userKey, SM4_KEY *key);
70 void HWSM4_encrypt(const unsigned char *in, unsigned char *out,
71                    const SM4_KEY *key);
72 void HWSM4_decrypt(const unsigned char *in, unsigned char *out,
73                    const SM4_KEY *key);
74 void HWSM4_cbc_encrypt(const unsigned char *in, unsigned char *out,
75                        size_t length, const SM4_KEY *key,
76                        unsigned char *ivec, const int enc);
77 void HWSM4_ecb_encrypt(const unsigned char *in, unsigned char *out,
78                        size_t length, const SM4_KEY *key,
79                        const int enc);
80 void HWSM4_ctr32_encrypt_blocks(const unsigned char *in, unsigned char *out,
81                                 size_t len, const void *key,
82                                 const unsigned char ivec[16]);
83 # endif /* HWSM4_CAPABLE */
84 
85 # ifdef VPSM4_CAPABLE
86 int vpsm4_set_encrypt_key(const unsigned char *userKey, SM4_KEY *key);
87 int vpsm4_set_decrypt_key(const unsigned char *userKey, SM4_KEY *key);
88 void vpsm4_encrypt(const unsigned char *in, unsigned char *out,
89                    const SM4_KEY *key);
90 void vpsm4_decrypt(const unsigned char *in, unsigned char *out,
91                    const SM4_KEY *key);
92 void vpsm4_cbc_encrypt(const unsigned char *in, unsigned char *out,
93                        size_t length, const SM4_KEY *key,
94                        unsigned char *ivec, const int enc);
95 void vpsm4_ecb_encrypt(const unsigned char *in, unsigned char *out,
96                        size_t length, const SM4_KEY *key,
97                        const int enc);
98 void vpsm4_ctr32_encrypt_blocks(const unsigned char *in, unsigned char *out,
99                                 size_t len, const void *key,
100                                 const unsigned char ivec[16]);
101 void vpsm4_xts_encrypt(const unsigned char *in, unsigned char *out,
102                        size_t len, const SM4_KEY *key1, const SM4_KEY *key2,
103                        const unsigned char ivec[16], const int enc);
104 void vpsm4_xts_encrypt_gb(const unsigned char *in, unsigned char *out,
105                           size_t len, const SM4_KEY *key1, const SM4_KEY *key2,
106                           const unsigned char ivec[16], const int enc);
107 # endif /* VPSM4_CAPABLE */
108 
109 # ifdef VPSM4_EX_CAPABLE
110 int vpsm4_ex_set_encrypt_key(const unsigned char *userKey, SM4_KEY *key);
111 int vpsm4_ex_set_decrypt_key(const unsigned char *userKey, SM4_KEY *key);
112 void vpsm4_ex_encrypt(const unsigned char *in, unsigned char *out,
113                       const SM4_KEY *key);
114 void vpsm4_ex_decrypt(const unsigned char *in, unsigned char *out,
115                       const SM4_KEY *key);
116 void vpsm4_ex_cbc_encrypt(const unsigned char *in, unsigned char *out,
117                           size_t length, const SM4_KEY *key,
118                           unsigned char *ivec, const int enc);
119 void vpsm4_ex_ecb_encrypt(const unsigned char *in, unsigned char *out,
120                           size_t length, const SM4_KEY *key,
121                           const int enc);
122 void vpsm4_ex_ctr32_encrypt_blocks(const unsigned char *in, unsigned char *out,
123                                    size_t len, const void *key,
124                                    const unsigned char ivec[16]);
125 void vpsm4_ex_xts_encrypt(const unsigned char *in, unsigned char *out,
126                           size_t len, const SM4_KEY *key1, const SM4_KEY *key2,
127                           const unsigned char ivec[16], const int enc);
128 void vpsm4_ex_xts_encrypt_gb(const unsigned char *in, unsigned char *out,
129                              size_t len, const SM4_KEY *key1,
130                              const SM4_KEY *key2, const unsigned char ivec[16],
131                              const int enc);
132 # endif /* VPSM4_EX_CAPABLE */
133 
134 #endif /* OSSL_SM4_PLATFORM_H */
135