@@ -1742,7 +1742,14 @@ crypto_one_time(Cipher, Key, IV, Data, FlagOrOptions) ->
17421742 {}).
17431743
17441744% %%----------------------------------------------------------------
1745- -doc (#{equiv => crypto_one_time_aead / 7 }).
1745+ -doc """
1746+ Do a complete encrypt with an AEAD cipher of the full text
1747+ with the default tag length.
1748+
1749+ Equivalent to
1750+ `crypto_one_time_aead(Cipher, Key, IV, InText, AAD, TagLength, true)`
1751+ where `TagLength` is the default tag length for the given `Cipher`.
1752+ """ .
17461753-doc (#{group => <<" Cipher API" >>,
17471754 since => <<" OTP 22.0" >>}).
17481755-spec crypto_one_time_aead (Cipher , Key , IV , InText , AAD , EncFlag :: true ) ->
@@ -1772,6 +1779,13 @@ length is wanted, the `crypto_one_time_aead/6` form may be used.
17721779For decryption, set the `EncryptFlag` to `false` and put the tag to be checked
17731780in the argument `TagOrTagLength`.
17741781
1782+ > #### Warning {: .warning }
1783+ >
1784+ > The length of the tag at decryption is not checked by the function. It is the
1785+ > caller's responsibility to ensure that the length of the tag matches the
1786+ > length of the tag used when the data was encrypted. Otherwise the decryption
1787+ > may succeed if the given tag only matches the start of the proper tag.
1788+
17751789Additional Authentication Data (AAD) is plaintext data that will not be
17761790encrypted, but will be covered by authenticity protection. It should be provided
17771791through the `AAD` argument, but can be an empty binary as well (`<<>>`) if not
0 commit comments