Merge pull request #6665 from TakayukiMatsuo/jp6472

Update Japanese API comments
pull/6673/head
Hideki Miyazaki 2023-08-04 14:37:33 +09:00 committed by GitHub
commit ae90a9b2c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 66 additions and 65 deletions

View File

@ -1,6 +1,6 @@
/*!
\ingroup RSA
\brief RSAKEY使XMALLOCXFREEXREALLOCwc_rsa_blindingWC_RSASETRNGRNG
\ingroup RSA
\brief RsaKey使XMALLOCXFREEXREALLOCwc_rsa_blindingWC_RSASETRNGRNG
\return 0 使RSA
\return BAD_FUNC_ARGS RSANULL
\param key RSAKEY
@ -20,12 +20,12 @@
int wc_InitRsaKey(RsaKey* key, void* heap);
/*!
\ingroup RSA
\brief RSAKEYIDLENDEVID使使XMALLOCXFREEXREALLOCwc_rsa_blindingWC_RSASETRNGRNG
\ingroup RSA
\brief RsaKeyIDLENDEVID使使XMALLOCXFREEXREALLOCwc_rsa_blindingWC_RSASETRNGRNG
\return 0 使RSA
\return BAD_FUNC_ARGS RSANULL
\return BUFFER_E LENRSA_MAX_ID_LEN
\param key RSAKEY
\param key RsaKey
\param id
\param len
\param heap 使RSA使使
@ -55,11 +55,11 @@ int wc_InitRsaKey_Id(RsaKey* key, unsigned char* id, int len,
void* heap, int devId);
/*!
\ingroup RSA
\ingroup RSA
\brief RNGWC_RSA_BLINDING
\return 0
\return BAD_FUNC_ARGS RSARNGNULL
\param key RSAKEY
\param key RsaKey
_Example_
\code
ret = wc_InitRsaKey(&key, NULL);
@ -75,8 +75,8 @@ int wc_InitRsaKey_Id(RsaKey* key, unsigned char* id, int len,
int wc_RsaSetRNG(RsaKey* key, WC_RNG* rng);
/*!
\ingroup RSA
\brief MP_Clear使RSAKEY
\ingroup RSA
\brief MP_Clear使RsaKey
\return 0
_Example_
\code
@ -91,7 +91,7 @@ int wc_RsaSetRNG(RsaKey* key, WC_RNG* rng);
int wc_FreeRsaKey(RsaKey* key);
/*!
\ingroup RSA
\ingroup RSA
\brief INounlen
\return Success 0outlenOUT
\return BAD_FUNC_ARG
@ -113,7 +113,7 @@ int wc_FreeRsaKey(RsaKey* key);
\param inLen
\param out
\param outLen
\param key 使RSAKEY
\param key 使RsaKey
_Example_
\code
RsaKey pub;
@ -138,7 +138,7 @@ int wc_RsaPublicEncrypt(const byte* in, word32 inLen, byte* out,
word32 outLen, RsaKey* key, WC_RNG* rng);
/*!
\ingroup RSA
\ingroup RSA
\brief WC_RSAPrivateCrypt
\return Success
\return RSA_PAD_E RSAUNPAD
@ -155,7 +155,7 @@ int wc_RsaPrivateDecryptInline(byte* in, word32 inLen, byte** out,
RsaKey* key);
/*!
\ingroup RSA
\ingroup RSA
\brief RSA
\return Success
\return MEMORY_E -125
@ -183,7 +183,7 @@ int wc_RsaPrivateDecrypt(const byte* in, word32 inLen, byte* out,
word32 outLen, RsaKey* key);
/*!
\ingroup RSA
\ingroup RSA
\brief
\return RSA_BUFFER_E: -131RSA
\param in
@ -209,7 +209,7 @@ int wc_RsaSSL_Sign(const byte* in, word32 inLen, byte* out,
word32 outLen, RsaKey* key, WC_RNG* rng);
/*!
\ingroup RSA
\ingroup RSA
\brief RSA使使
\return >0
\return <0
@ -240,7 +240,7 @@ int wc_RsaSSL_VerifyInline(byte* in, word32 inLen, byte** out,
RsaKey* key);
/*!
\ingroup RSA
\ingroup RSA
\brief 使
\return Success
\return MEMORY_E
@ -266,7 +266,7 @@ int wc_RsaSSL_Verify(const byte* in, word32 inLen, byte* out,
word32 outLen, RsaKey* key);
/*!
\ingroup RSA
\ingroup RSA
\brief
\return RSA_BUFFER_E: -131RSA
\param in
@ -310,14 +310,15 @@ int wc_RsaPSS_Sign(const byte* in, word32 inLen, byte* out,
RsaKey* key, WC_RNG* rng);
/*!
\ingroup RSA
\brief wc_rsa_blindingWC_RSASETRNGRNG
\return Success
\ingroup RSA
\brief WC_RSA_BLINDINGwc_RsaSetRNGRNG
\return Success
\return MEMORY_E
\param in
\param inLen
\param out
\param outLen
\return MP_EXPTMOD_E - fastmath使FP_MAX_BITS2(4096-bit使FP_MAX_BITS8192)
\param in
\param inLen
\param out
\param outLen
\param hash
\param mgf
_Example_
@ -356,8 +357,8 @@ int wc_RsaPSS_Verify(byte* in, word32 inLen, byte* out,
RsaKey* key);
/*!
\ingroup RSA
\brief RSA使wc_rsa_blindingWC_RSASETRNGRNG
\ingroup RSA
\brief RSA使WC_RSA_BLINDINGWC_RSASETRNGRNG
\return >0
\return <0
\param in
@ -406,8 +407,8 @@ int wc_RsaPSS_VerifyInline(byte* in, word32 inLen, byte** out,
enum wc_HashType hash, int mgf,
RsaKey* key);
/*!
\ingroup RSA
\brief RSA-PSSwc_rsa_blindingWC_RSASETRNGRNG
\ingroup RSA
\brief RSA-PSSWC_RSA_BLINDINGWC_RSASETRNGRNG
\return the PSS
\return MEMORY_E
\param in
@ -468,8 +469,8 @@ int wc_RsaPSS_VerifyCheck(byte* in, word32 inLen,
enum wc_HashType hash, int mgf,
RsaKey* key);
/*!
\ingroup RSA
\brief RSA-PSSwc_rsa_blindingWC_RSASETRNGRNG
\ingroup RSA
\brief RSA-PSSWC_RSA_BLINDINGWC_RSASETRNGRNG
\return the PSS
\return MEMORY_E
\param in
@ -531,8 +532,8 @@ int wc_RsaPSS_VerifyCheck_ex(byte* in, word32 inLen,
RsaKey* key);
/*!
\ingroup RSA
\brief RSA-PSSwc_rsa_blindingWC_RSASETRNGRNG
\ingroup RSA
\brief RSA-PSSWC_RSA_BLINDINGWC_RSASETRNGRNG
\return the PSS
\param in
\param inLen
@ -589,8 +590,8 @@ int wc_RsaPSS_VerifyCheckInline(byte* in, word32 inLen, byte** out,
enum wc_HashType hash, int mgf,
RsaKey* key);
/*!
\ingroup RSA
\brief RSA-PSSwc_rsa_blindingWC_RSASETRNGRNG
\ingroup RSA
\brief RSA-PSSWC_RSA_BLINDINGWC_RSASETRNGRNG
\return the PSS
\param in
\param inLen
@ -649,8 +650,8 @@ int wc_RsaPSS_VerifyCheckInline_ex(byte* in, word32 inLen, byte** out,
RsaKey* key);
/*!
\ingroup RSA
\brief PSSwc_rsa_blindingWC_RSASETRNGRNG
\ingroup RSA
\brief PSSWC_RSA_BLINDINGWC_RSASETRNGRNG
\return BAD_PADDING_E PSSNULLINSIGINSZBAD_FUNC_ARG
\return MEMORY_E
\param in
@ -702,7 +703,7 @@ int wc_RsaPSS_CheckPadding(const byte* in, word32 inLen, byte* sig,
word32 sigSz,
enum wc_HashType hashType);
/*!
\ingroup RSA
\ingroup RSA
\brief PSS
\return BAD_PADDING_E PSSNULLINSIGINSZBAD_FUNC_ARG
\return MEMORY_E
@ -755,7 +756,7 @@ int wc_RsaPSS_CheckPadding(const byte* in, word32 inLen, byte* sig,
int wc_RsaPSS_CheckPadding_ex(const byte* in, word32 inLen, byte* sig,
word32 sigSz, enum wc_HashType hashType, int saltLen, int bits);
/*!
\ingroup RSA
\ingroup RSA
\brief
\return Success
_Example_
@ -769,7 +770,7 @@ int wc_RsaPSS_CheckPadding_ex(const byte* in, word32 inLen, byte* sig,
int wc_RsaEncryptSize(RsaKey* key);
/*!
\ingroup RSA
\ingroup RSA
\brief DerRSAResakeyIDX
\return 0 DER
\return ASN_PARSE_E ASN.1
@ -797,8 +798,8 @@ int wc_RsaPrivateKeyDecode(const byte* input, word32* inOutIdx,
RsaKey* key, word32 inSz);
/*!
\ingroup RSA
\brief DerRSAResakeyIDX
\ingroup RSA
\brief DerRSARsaKeyIDX
\return 0 DER
\return ASN_PARSE_E ASN.1
\return ASN_OBJECT_ID_E ASN.1IDRSA
@ -807,7 +808,7 @@ int wc_RsaPrivateKeyDecode(const byte* input, word32* inOutIdx,
\return ASN_RSA_KEY_E RSA
\param input DERRSA
\param inOutIdx 0InoutIDX
\param key RSAKEY
\param key RsaKey
_Example_
\code
RsaKey pub;
@ -827,9 +828,9 @@ int wc_RsaPublicKeyDecode(const byte* input, word32* inOutIdx,
RsaKey* key, word32 inSz);
/*!
\ingroup RSA
\brief neRSARSAKEY/使
\return 0 RSAKEY
\ingroup RSA
\brief neRSARsaKey/使
\return 0 RsaKey
\return BAD_FUNC_ARG NULL
\return MP_INIT_E MP_INT使
\return ASN_GETINT_E RSAne
@ -856,12 +857,12 @@ int wc_RsaPublicKeyDecodeRaw(const byte* n, word32 nSz,
const byte* e, word32 eSz, RsaKey* key);
/*!
\ingroup RSA
\ingroup RSA
\brief RSAKEYDER
\return 0
\return BAD_FUNC_ARG NULL - >RSA_PRIVATEINLEN
\return MEMORY_E
\param key RSAKEY
\param key RsaKey
\param output
_Example_
\code
@ -888,7 +889,7 @@ int wc_RsaPublicKeyDecodeRaw(const byte* n, word32 nSz,
int wc_RsaKeyToDer(RsaKey* key, byte* output, word32 inLen);
/*!
\ingroup RSA
\ingroup RSA
\brief 使RSA
\return size
\return RSA_BUFFER_E RSA
@ -896,7 +897,7 @@ int wc_RsaKeyToDer(RsaKey* key, byte* output, word32 inLen);
\param inLen
\param out MSG
\param outLen MSG
\param key RSA
\param key RsaKey
\param rng WC_RNG
\param type 使WC_RSA_OAEP_PADWC_RSA_PKCSV15_PAD
\param hash 使hash.h
@ -925,7 +926,7 @@ int wc_RsaPublicEncrypt_ex(const byte* in, word32 inLen, byte* out,
enum wc_HashType hash, int mgf, byte* label, word32 labelSz);
/*!
\ingroup RSA
\ingroup RSA
\brief RSA使
\return size
\return MEMORY_E MallocMalloc
@ -934,7 +935,7 @@ int wc_RsaPublicEncrypt_ex(const byte* in, word32 inLen, byte* out,
\param inLen
\param out MSG
\param outLen MSG
\param key RSA
\param key RsaKey
\param type 使WC_RSA_OAEP_PADWC_RSA_PKCSV15_PAD
\param hash 使hash.h
\param mgf 使
@ -968,7 +969,7 @@ int wc_RsaPrivateDecrypt_ex(const byte* in, word32 inLen,
enum wc_HashType hash, int mgf, byte* label, word32 labelSz);
/*!
\ingroup RSA
\ingroup RSA
\brief RSA使ININ
\return size
\return MEMORY_E: MallocMalloc
@ -978,7 +979,7 @@ int wc_RsaPrivateDecrypt_ex(const byte* in, word32 inLen,
\param in
\param inLen
\param out "in"
\param key RSA
\param key RsaKey
\param type 使WC_RSA_OAEP_PADWC_RSA_PKCSV15_PAD
\param hash 使hash.h
\param mgf 使
@ -1013,8 +1014,8 @@ int wc_RsaPrivateDecryptInline_ex(byte* in, word32 inLen,
int mgf, byte* label, word32 labelSz);
/*!
\ingroup RSA
\brief RSA使ENRSAKEY
\ingroup RSA
\brief RSA使RsaKeyEN
\return 0
\return BAD_FUNC_ARG: NULL
\return RSA_BUFFER_E: en
@ -1046,13 +1047,13 @@ int wc_RsaFlattenPublicKey(RsaKey* key, byte* e, word32* eSz, byte* n,
word32* nSz);
/*!
\ingroup RSA
\ingroup RSA
\brief RSADER
\return >0
\return BAD_FUNC_ARG NULL
\return MEMORY_E
\return <0
\param key RSA
\param key RsaKey
\param output NULL
_Example_
\code
@ -1074,13 +1075,13 @@ int wc_RsaFlattenPublicKey(RsaKey* key, byte* e, word32* eSz, byte* n,
int wc_RsaKeyToPublicDer(RsaKey* key, byte* output, word32 inLen);
/*!
\ingroup RSA
\ingroup RSA
\brief RSADERwith_header0seq + n + eASN.1 Der
\return >0
\return BAD_FUNC_ARG NULL
\return MEMORY_E
\return <0
\param key RSA
\param key RsaKey
\param output NULL
_Example_
\code
@ -1103,12 +1104,12 @@ int wc_RsaKeyToPublicDer_ex(RsaKey* key, byte* output, word32 inLen,
int with_header);
/*!
\ingroup RSA
\brief RSAeRSAKEY/使E使65537RSA_MIN_SIZERSA_MAX_SIZEwolfssl_key_gen - 使./configure使-enable-keygen
\ingroup RSA
\brief RSAeRsaKey/使E使65537RSA_MIN_SIZERSA_MAX_SIZEwolfssl_key_gen - 使./configure使-enable-keygen
\return 0 RSA
\return BAD_FUNC_ARG NULLe
\return RNG_FAILURE_E RNG使
\return MP_INIT_E
\return MP_INIT_E
\return MP_READ_E RSA使RSA使
\return MP_CMP_E RSA使
\return MP_INVMOD_E RSA使
@ -1143,7 +1144,7 @@ int wc_RsaKeyToPublicDer_ex(RsaKey* key, byte* output, word32 inLen,
int wc_MakeRsaKey(RsaKey* key, int size, long e, WC_RNG* rng);
/*!
\ingroup RSA
\ingroup RSA
\brief RSARSANBRSAEXPTMODwc_rsa_nonblock
\return 0
\return BAD_FUNC_ARG NBNULL
@ -1179,11 +1180,11 @@ int wc_MakeRsaKey(RsaKey* key, int size, long e, WC_RNG* rng);
int wc_RsaSetNonBlock(RsaKey* key, RsaNb* nb);
/*!
\ingroup RSA
\ingroup RSA
\brief CPUTFM.cexptModnbinst使wc_rsa_nonblock_time
\return 0
\return BAD_FUNC_ARG NULLWC_RSASETNONBLOCK - > NBNULL
\param key RSA
\param key RsaKey
\param maxBlockUs
_Example_
\code