パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v2.2.0

base32

Dart用のBase32エンコーダーとデコーダー。主にワンタイムパスワードのシークレットに使用されます。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
18.1万
いいね数
29
Pub ポイント
160

パッケージをインストール

flutter pub add base32

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

Base32アルゴリズムを使用してデータをエンコードおよびデコードするためのDartパッケージで、ワンタイムパスワード(OTP)シークレットを安全に処理することを目的としています。RFC 4648で定義された標準Base32エンコーディングをサポートしており、プラットフォーム間での互換性を確保しています。軽量かつ効率的なため、バイナリデータの安全で人間が読みやすい表現が必要なアプリケーションに最適です。Android、iOS、Web、macOS、Windows、Linuxなど、すべての主要プラットフォームでスムーズに動作します。

用途

  • OTP シークレットの生成
  • セキュアなデータエンコーディング
  • クロスプラットフォームトークン処理
  • テキスト保存のためのバイナリデータのエンコード
  • Google Authenticator などの OTP アプリとの相互運用性

主な機能

  • RFC 4648準拠
  • エンコードとデコードの両方をサポートしています
  • 軽量で高速
  • クロスプラットフォーム互換性
  • OTP インテグレーション用のシンプルな API

適している対象

  • 二要素認証アプリ
  • セキュアな資格情報の保存
  • Base32が必要なモバイルおよびウェブアプリケーション
  • OTPプロトコルを使用する開発者
  • 標準化されたテキストベースのエンコーディングを必要とするアプリケーション

注意事項

  • 一般的な暗号化には適していません
  • シークレットのセキュリティを手動で処理する必要があります
  • Base32のみに制限され、他のエンコーディングはなし
  • 不正な入力に対する組み込みのエラーリカバリなし
  • 追加のセキュリティ対策と併用するのが最適です

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Dart

dart-base32

Simple base32 encode/decode following RFC4648. Can handle base32 for OTP secrets also.

Features:

Getting Started

Pubspec

pub.dev: (you can use 'any' instead of a version if you just want the latest always)

dependencies:
  base32: 2.1.3
import 'package:base32/base32.dart';

Start encoding/decoding ...

// Encode a hex string to base32
base32.encodeHexString('48656c6c6f21deadbeef'); // -> 'JBSWY3DPEHPK3PXP'

// base32 decoding to original string.
base32.decodeAsHexString("JBSWY3DPEHPK3PXP"); // -> '48656c6c6f21deadbeef'

API

base32.encode(List<int> byteList, {Encoding encoding = Encoding.standardRFC4648})

Generate and return a RFC4648 base32 string from a list of bytes.

  • byteList - (List<int>) A list of bytes representing your input.

Returns String representation of the encoded base32.

base32.encodeHexString(String hex, {Encoding encoding = Encoding.standardRFC4648})

Generate and return a RFC4648 base32 string from a hex string.

  • hexString - (String) A string of hex values intended to be converted to bytes and encoded.

Returns String representation of the encoded base32

Example: Encode a hex string.

base32.encodeHexString('48656c6c6f21deadbeef'); // -> 'JBSWY3DPEHPK3PXP'
base32.encodeString(String base32str, {Encoding encoding = Encoding.standardRFC4648})

Generate and return a RFC4648 base32 string from a plain string.

  • base32str - (String) A string intended to be converted to bytes and encoded.

Returns String representation of the encoded base32

Example: Encode a hex string.

base32.encodeString('foobar'); // -> 'MZXW6YTBOI======'
base32.decode(String base32, {Encoding encoding = Encoding.standardRFC4648})

Decodes a base32 string back to its original byte values.

  • base32 - (String) The base32 string you wish to decode.

Returns Uint8List of the decoded data.

Example: Decode a base32 string, then output it in hex format

import "package:convert/convert.dart"
var decoded = base32.decode("JBSWY3DPEHPK3PXP");
var decodedHex = hex.encode(decoded); // -> '48656c6c6f21deadbeef'
base32.decodeAsHexString(String base32, {Encoding encoding = Encoding.standardRFC4648})

Decodes a base32 string back to its original byte values in hex string format.

  • base32 - (String) The base32 string you wish to decode.

Returns String of the decoded data.

Example: Decode a base32 string to a hex string.

import "package:convert/convert.dart"
var decoded = base32.decodeAsHexString("JBSWY3DPEHPK3PXP"); // -> '48656c6c6f21deadbeef'
base32.decodeAsString(String base32, {Encoding encoding = Encoding.standardRFC4648})

Decodes a base32 string back to its original byte values.

  • base32 - (String) The base32 string you wish to decode.

Returns String of the decoded data.

Example: Decode a base32 string to a string.

var decoded = base32.decodeAsString("MZXW6YTBOI======"); // -> 'foobar'
enum Encoding

This is a list of supported variants and their different encodings.

  • StandardRFC4648 - the default standard encoding
    • ABCDEFGHIJKLMNOPQRSTUVWXYZ234567
    • Padded with =
  • base32Hex
    • 0123456789ABCDEFGHIJKLMNOPQRSTUV
    • Padded with =
  • crockford
    • 0123456789ABCDEFGHJKMNPQRSTVWXYZ
    • Not Padded
  • z-base-32
    • ybndrfg8ejkmcpqxot1uwisza345h769
    • Not Padded
  • geohash
    • 0123456789bcdefghjkmnpqrstuvwxyz
    • Padded with =
  • NonStandardRFC4648 - Same as StandardRFC4648, but lowercase, not supported by the spec.
    • abcdefghijklmnopqrstuvwxyz234567
    • Padded with =

Testing

dart test/base32_test.dart

Changelog

See CHANGELOG.md

カテゴリー

ソースリポジトリ

このパッケージを使用しているプロジェクト