Skip to content

Commit d1794d1

Browse files
committed
chore(release): finalized v0.1.0
1 parent 935076e commit d1794d1

2 files changed

Lines changed: 22 additions & 22 deletions

File tree

CHANGELOG.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
## 0.1.0
22

3-
Initial release of M-Security a native Rust cryptographic SDK for Flutter.
3+
Initial release of M-Security, a native Rust cryptographic SDK for Flutter.
44

55
### Authenticated Encryption (AEAD)
66

7-
- **AES-256-GCM** Industry-standard authenticated encryption with 32-byte keys, 12-byte auto-generated nonces, and 16-byte authentication tags.
8-
- **ChaCha20-Poly1305** High-performance alternative optimized for mobile processors lacking dedicated AES hardware.
7+
- **AES-256-GCM.** Industry-standard authenticated encryption with 32-byte keys, 12-byte auto-generated nonces, and 16-byte authentication tags.
8+
- **ChaCha20-Poly1305.** High-performance alternative optimized for mobile processors lacking dedicated AES hardware.
99
- Unified `CipherHandle` interface for both ciphers (create, encrypt, decrypt, generate key).
1010
- Output format: `nonce || ciphertext || tag`.
1111

1212
### Hashing
1313

14-
- **BLAKE3** Ultra-fast integrity verification with one-shot and streaming APIs via `HasherHandle`.
15-
- **SHA-3-256 (Keccak)** NIST-standard hashing with one-shot and streaming APIs.
16-
- **Argon2id** PHC-winning password hashing with Mobile (64 MiB) and Desktop (256 MiB) presets, automatic salt generation, and PHC string output.
14+
- **BLAKE3.** Ultra-fast integrity verification with one-shot and streaming APIs via `HasherHandle`.
15+
- **SHA-3-256 (Keccak).** NIST-standard hashing with one-shot and streaming APIs.
16+
- **Argon2id.** PHC-winning password hashing with Mobile (64 MiB) and Desktop (256 MiB) presets, automatic salt generation, and PHC string output.
1717

1818
### Key Derivation (KDF)
1919

20-
- **HKDF-SHA256** RFC 5869-compliant key derivation with `derive`, `extract`, and `expand` operations. Output range: 1-8160 bytes.
20+
- **HKDF-SHA256.** RFC 5869-compliant key derivation with `derive`, `extract`, and `expand` operations. Output range: 1-8160 bytes.
2121

2222
### Security
2323

24-
- All key material held in Rust behind opaque `#[frb(opaque)]` handles raw keys never cross the FFI boundary.
24+
- All key material held in Rust behind opaque `#[frb(opaque)]` handles; raw keys never cross the FFI boundary.
2525
- Secure memory management with `ZeroizeOnDrop` on all key-holding structs.
26-
- `clippy::unwrap_used = "deny"` — no unwrap in FFI-visible code.
27-
- `panic = "abort"` in release profile — no undefined behavior from panics crossing FFI.
28-
- Nonces generated internally via `OsRng` callers never handle nonces.
26+
- `clippy::unwrap_used = "deny"`, preventing unwrap in FFI-visible code.
27+
- `panic = "abort"` in release profile, preventing undefined behavior from panics crossing FFI.
28+
- Nonces generated internally via `OsRng`; callers never handle nonces.
2929

3030
### Platform Support
3131

RELEASE_GUIDE.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ This document describes how to create a new release of M-Security after merging
66

77
M-Security follows [Semantic Versioning](https://semver.org/) (SemVer):
88

9-
- **MAJOR** (`X.0.0`) Breaking API changes (e.g., removing a function, changing a return type).
10-
- **MINOR** (`0.X.0`) New features, backward-compatible (e.g., adding a new cipher or hash algorithm).
11-
- **PATCH** (`0.0.X`) Bug fixes and patches, backward-compatible (e.g., fixing edge case in encryption).
9+
- **MAJOR** (`X.0.0`): Breaking API changes (e.g., removing a function, changing a return type).
10+
- **MINOR** (`0.X.0`): New features, backward-compatible (e.g., adding a new cipher or hash algorithm).
11+
- **PATCH** (`0.0.X`): Bug fixes and patches, backward-compatible (e.g., fixing edge case in encryption).
1212

1313
For pre-release versions, append a suffix: `0.2.0-dev.1`, `1.0.0-beta.1`.
1414

@@ -70,12 +70,12 @@ Move the `## Unreleased` section content under a new version header with the cur
7070
```
7171

7272
Follow [Keep a Changelog](https://keepachangelog.com/) format with these categories:
73-
- **Added** New features
74-
- **Changed** Changes to existing functionality
75-
- **Deprecated** Features that will be removed in future versions
76-
- **Removed** Removed features
77-
- **Fixed** Bug fixes
78-
- **Security** Vulnerability fixes
73+
- **Added**: New features
74+
- **Changed**: Changes to existing functionality
75+
- **Deprecated**: Features that will be removed in future versions
76+
- **Removed**: Removed features
77+
- **Fixed**: Bug fixes
78+
- **Security**: Vulnerability fixes
7979

8080
### 4. Run All Checks
8181

@@ -147,15 +147,15 @@ Or via the GitHub web UI:
147147
> **First-time setup**: Ensure you are authenticated with `dart pub login` and that the package publisher is configured on pub.dev. See [Verified Publishers](https://dart.dev/tools/pub/verified-publishers).
148148

149149
```bash
150-
# Dry run first review what will be published
150+
# Dry run first: review what will be published
151151
dart pub publish --dry-run
152152
153153
# If everything looks good, publish
154154
dart pub publish
155155
```
156156

157157
**Important notes:**
158-
- Publishing is **permanent** — you cannot unpublish a version (only retract within 7 days).
158+
- Publishing is **permanent**. You cannot unpublish a version (only retract within 7 days).
159159
- Ensure `lib/src/rust/` generated files are included (they are needed by consumers).
160160
- The `.pubignore` or `.gitignore` controls which files are excluded from the published package.
161161
- Verify the package size is under 100 MB (gzip) / 256 MB (uncompressed).

0 commit comments

Comments
 (0)