Skip to content

docs: move AES-CTR importRawKey example to a separate file #397

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

Open
KSAGlory wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: move AES-CTR importRawKey example to a separate file #397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 45 additions & 0 deletions example/webcrypto/aes_ctr/import_raw_key.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// ignore_for_file: avoid_print

// #region example
import 'dart:convert' show utf8;
import 'dart:typed_data' show Uint8List;

import 'package:webcrypto/webcrypto.dart';

Future<void> main() async {
final rawKey = Uint8List(16);
fillRandomBytes(rawKey);

// Import key from raw bytes
final k = await AesCtrSecretKey.importRawKey(rawKey);

// Use a unique counter for each message.
final ctr = Uint8List(16); // always 16 bytes
fillRandomBytes(ctr);

// Length of the counter, the N'th right most bits of ctr are incremented
// for each block, the left most 128 - N bits are used as static nonce.
final N = 64;

// Encrypt a message
final c = await k.encryptBytes(utf8.encode('hello world'), ctr, N);

// Decrypt message (requires the same counter ctr and length N)
print(utf8.decode(await k.decryptBytes(c, ctr, N))); // hello world
}

// #endregion
27 changes: 1 addition & 26 deletions lib/src/webcrypto/webcrypto.aesctr.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,33 +42,8 @@ final class AesCtrSecretKey {
/// {@macro AES:no-support-for-AES-192}
///
/// **Example**
/// ```dart
/// import 'dart:convert' show utf8;
/// import 'dart:typed_data' show Uint8List;
/// import 'package:webcrypto/webcrypto.dart';
///
/// Future<void> main() async {
/// final rawKey = Uint8List(16);
/// fillRandomBytes(rawKey);
///
/// // Import key from raw bytes
/// final k = await AesCtrSecretKey.importRawKey(rawKey);
///
/// // Use a unique counter for each message.
/// final ctr = Uint8List(16); // always 16 bytes
/// fillRandomBytes(ctr);
///
/// // Length of the counter, the N'th right most bits of ctr are incremented
/// // for each block, the left most 128 - N bits are used as static nonce.
/// final N = 64;
///
/// // Encrypt a message
/// final c = await k.encryptBytes(utf8.encode('hello world'), ctr, N);
///
/// // Decrypt message (requires the same counter ctr and length N)
/// print(utf8.decode(await k.decryptBytes(c, ctr, N))); // hello world
/// }
/// ```
/// {@example /example/webcrypto/aes_ctr/import_raw_key.dart#example}
static Future<AesCtrSecretKey> importRawKey(List<int> keyData) async {
final impl = await webCryptImpl.aesCtrSecretKey.importRawKey(keyData);
return AesCtrSecretKey._(impl);
Expand Down
Loading