Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change all "Remark" notes to use the [!NOTE] blockquotes. #126

Merged
merged 2 commits into from
May 27, 2024
Merged

Change all "Remark" notes to use the [!NOTE] blockquotes. #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8231a6
Changed all "Remark" notes to use the [!NOTE] format.
TropicolX May 23, 2024
3af4a5e
Undo update to pubspec.lock
TropicolX May 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions lib/src/webcrypto/webcrypto.aesctr.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,11 +168,11 @@ abstract class AesCtrSecretKey {
/// {@endtemplate}
///
/// {@template AesCtrSecretKey-compatibility-notes}
/// **Remark** Firefox does not implement counter rollover for AES-CTR
/// correctly. Picking a sufficiently large [length] and using a [counter]
/// that isn't filled with `0xff` will likely avoid counter rollovers.
/// See [bug 1803105](https://bugzilla.mozilla.org/show_bug.cgi?id=1803105)
/// for details.
/// > [!NOTE]
/// > Firefox does not implement counter rollover for AES-CTR correctly.
/// Picking a sufficiently large `length` and using a `counter` that isn't
/// filled with 0xff will likely avoid counter rollovers.
/// See [bug 1803105](https://bugzilla.mozilla.org/show_bug.cgi?id=1803105) for details.
/// {@endtemplate}
///
/// [1]: https://csrc.nist.gov/publications/detail/sp/800-38a/final
Expand Down
5 changes: 3 additions & 2 deletions lib/src/webcrypto/webcrypto.aesgcm.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,8 @@ abstract class AesGcmSecretKey {
/// {@endtemplate}
///
/// {@template AesGcmSecretKey-remark:no-stream-api}
/// **Remark** this package does not offer a streaming API for
/// > [!NOTE]
/// > This package does not offer a streaming API for
/// encryption / decryption using AES-GCM, because reading deciphered
/// plaintext prior to complete verification of the tag breaks the
/// authenticity assurances. Specifically, until the entire message is
Expand All @@ -221,7 +222,7 @@ abstract class AesGcmSecretKey {

// TODO: Document this method, notice that [data] must be concatenation of
// ciphertext and authentication tag.
// TODO: Document what happens if the authenticity validation fails? Some Exception?
// TODO: Document what happens if the authenticity validation fails? Some Exception?
Future<Uint8List> decryptBytes(
List<int> data,
List<int> iv, {
Expand Down
3 changes: 2 additions & 1 deletion lib/src/webcrypto/webcrypto.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ abstract class KeyPair<S, T> {

/// Elliptic curves supported by ECDSA and ECDH.
///
/// **Remark**, additional values may be added to this enum in the future.
/// > [!NOTE]
/// > Additional values may be added to this enum in the future.
enum EllipticCurve {
p256,
p384,
Expand Down
Loading