Skip to content

Commit 8e0f0d6

Browse files
cconloncconlon
authored
Merge pull request #5914 from kojo1/ja
add Doxygen cmac.h, quic.h
2 parents 9ce79c4 + 5ff8bec commit 8e0f0d6

2 files changed

Lines changed: 761 additions & 0 deletions

File tree

‎doc/dox_comments/header_files-ja/cmac.h‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
/*!
2+
\ingroup CMAC
3+
\brief Cmac 構造体をデフォルトで初期化する
4+
\return 成功したら 0 を返す
5+
\param cmac Cmac 構造体へのポインタ
6+
\param キー キー ポインタ
7+
\param keySz キー ポインタのサイズ (16、24、または 32)
8+
\param type 常に WC_CMAC_AES = 1
9+
\param 未使用 使用されていません。互換性に関する将来の潜在的な使用のために存在します
10+
11+
_例_
12+
\code
13+
Cmac cmac[1];
14+
ret = wc_InitCmac(cmac、キー、keySz、WC_CMAC_AES、NULL);
15+
もし (ret == 0) {
16+
ret = wc_CmacUpdate(cmac、in、inSz);
17+
}
18+
もし (ret == 0) {
19+
ret = wc_CmacFinal(cmac, out, outSz);
20+
}
21+
\endcode
22+
23+
\sa wc_InitCmac_ex
24+
\sa wc_CmacUpdate
25+
\sa wc_CmacFinal
26+
*/
27+
int wc_InitCmac(Cmac* cmac,
28+
const byte* キー、word32 keySz、
29+
int型、void*未使用);
30+
31+
/*!
32+
\ingroup CMAC
33+
\brief Cmac 構造体をデフォルトで初期化する
34+
\return 成功したら 0 を返す
35+
\param cmac Cmac 構造体へのポインタ
36+
\param キー キー ポインタ
37+
\param keySz キー ポインタのサイズ (16、24、または 32)
38+
\param type 常に WC_CMAC_AES = 1
39+
\param 未使用 使用されていません。互換性に関する将来の潜在的な使用のために存在します
40+
\param heap 動的割り当てに使用されるヒープ ヒントへのポインター。 通常、スタティック メモリ オプションで使用されます。 NULL にすることができます。
41+
\param devId 非同期ハードウェアで使用する ID。 非同期ハードウェアを使用していない場合は、INVALID_DEVID に設定します。
42+
43+
_例_
44+
\code
45+
Cmac cmac[1];
46+
ret = wc_InitCmac_ex(cmac、キー、keySz、WC_CMAC_AES、NULL、NULL、INVALID_DEVID);
47+
もし (ret == 0) {
48+
ret = wc_CmacUpdate(cmac、in、inSz);
49+
}
50+
もし (ret == 0) {
51+
ret = wc_CmacFinal(cmac, out, &outSz);
52+
}
53+
\endcode
54+
55+
\sa wc_InitCmac_ex
56+
\sa wc_CmacUpdate
57+
\sa wc_CmacFinal
58+
*/
59+
int wc_InitCmac_ex(Cmac* cmac,
60+
const byte* キー、word32 keySz、
61+
int 型、void* 未使用、void* ヒープ、int devId);
62+
63+
/*!
64+
\ingroup CMAC
65+
\brief 暗号ベースのメッセージ認証コード入力データを追加
66+
\return 成功したら 0 を返す
67+
\param cmac Cmac 構造体へのポインタ
68+
\param in 処理する入力データの
69+
\param inSz 入力データのサイズ
70+
71+
_例_
72+
\code
73+
ret = wc_CmacUpdate(cmac、in、inSz);
74+
\endcode
75+
76+
\sa wc_InitCmac
77+
\sa wc_CmacFinal
78+
*/
79+
int wc_CmacUpdate(Cmac* cmac,
80+
const byte* in, word32 inSz);
81+
82+
/*!
83+
\ingroup CMAC
84+
\brief 暗号ベースのメッセージ認証コードを使用して最終結果を生成する
85+
\return 成功したら 0 を返す
86+
\param cmac Cmac 構造体へのポインタ
87+
\param out 結果を返すポインタ
88+
\param outSz 出力のポインタサイズ (in/out)
89+
90+
_例_
91+
\code
92+
ret = wc_CmacFinal(cmac, out, &outSz);
93+
\endcode
94+
95+
\sa wc_InitCmac
96+
\sa wc_CmacFinal
97+
*/
98+
int wc_CmacFinal(Cmac* cmac,
99+
byte* out, word32* outSz);
100+
101+
/*!
102+
\ingroup CMAC
103+
\brief CMAC を生成するためのシングル ショット関数
104+
\return 成功したら 0 を返す
105+
\param out 結果を返すポインタ
106+
\param outSz 出力のポインタサイズ (in/out)
107+
\param in 処理する入力データのポインタ
108+
\param inSz 入力データのサイズ
109+
\param キー キー ポインタ
110+
\param keySz キー ポインタのサイズ (16、24、または 32)
111+
112+
_例_
113+
\code
114+
ret = wc_AesCmacGenerate(mac, &macSz, msg, msgSz, key, keySz);
115+
\endcode
116+
117+
\sa wc_AesCmacVerify
118+
*/
119+
int wc_AesCmacGenerate(byte* out, word32* outSz,
120+
const byte* in、word32 inSz、
121+
const byte* key, word32 keySz);
122+
123+
/*!
124+
\ingroup CMAC
125+
\brief CMAC を検証するためのシングル ショット機能
126+
\return 成功したら 0 を返す
127+
\param 結果を返すチェック ポインタ
128+
\param checkSz チェックアウト バッファのサイズ
129+
\param in 処理する入力データのポインタ
130+
\param inSz 入力データのサイズ
131+
\param キー キー ポインタ
132+
\param keySz キー ポインタのサイズ (16、24、または 32)
133+
134+
_例_
135+
\code
136+
ret = wc_AesCmacVerify(mac, macSz, msg, msgSz, key, keySz);
137+
\endcode
138+
139+
\sa wc_AesCmacGenerate
140+
*/
141+
int wc_AesCmacVerify(const byte* check, word32 checkSz,
142+
const byte* in、word32 inSz、
143+
const byte* key, word32 keySz);
144+
145+
146+
/*!
147+
\ingroup CMAC
148+
\brief ハードウェアがシングル ショットを必要とし、更新をメモリにキャッシュする必要がある場合にのみ、WOLFSSL_HASH_KEEP で使用されます
149+
\return 成功したら 0 を返す
150+
処理する入力データの \param
151+
\param inSz 入力データのサイズ
152+
153+
_例_
154+
\code
155+
ret = wc_CMAC_Grow(cmac、in、inSz)
156+
\endcode
157+
*/
158+
int wc_CMAC_Grow(Cmac* cmac, const byte* in, int inSz);

0 commit comments

Comments
 (0)