@yume-chan/adb 0.0.16 → 0.0.18

package/src/crypto.ts

@@ -1,4 +1,7 @@
-import { getBigUint64, setBigUint64 } from '@yume-chan/dataview-bigint-polyfill/esm/fallback.js';
+import {
+    getBigUint64,
+    setBigUint64,
+} from "@yume-chan/dataview-bigint-polyfill/esm/fallback.js";
 
 const BigInt0 = BigInt(0);
 const BigInt1 = BigInt(1);
@@ -12,7 +15,11 @@ const BigInt64 = BigInt(64);
  * Only supports Big-Endian, because that's what ADB uses.
  * @param byteOffset The place in the buffer at which the value should be retrieved.
  */
-export function getBigUint(dataView: DataView, byteOffset: number, length: number): bigint {
+export function getBigUint(
+    dataView: DataView,
+    byteOffset: number,
+    length: number
+): bigint {
     let result = BigInt0;
 
     // Currently `length` must be a multiplication of 8
@@ -34,7 +41,12 @@ export function getBigUint(dataView: DataView, byteOffset: number, length: numbe
  * @param littleEndian If `false` or `undefined`, a big-endian value should be written,
  * otherwise a little-endian value should be written.
  */
-export function setBigUint(dataView: DataView, byteOffset: number, value: bigint, littleEndian?: boolean) {
+export function setBigUint(
+    dataView: DataView,
+    byteOffset: number,
+    value: bigint,
+    littleEndian?: boolean
+) {
     const start = byteOffset;
 
     if (littleEndian) {
@@ -96,9 +108,9 @@ export function parsePrivateKey(key: Uint8Array): [n: bigint, d: bigint] {
 
 // Taken from https://stackoverflow.com/a/51562038
 // I can't understand, but it does work
-// Only used with numbers less than 2^32 so doesn't need BigInt
+// Only used with numbers smaller than 2^32 so doesn't need BigInt
 export function modInverse(a: number, m: number) {
-    a = (a % m + m) % m;
+    a = ((a % m) + m) % m;
     if (!a || m < 2) {
         return NaN; // invalid input
     }
@@ -115,26 +127,24 @@ export function modInverse(a: number, m: number) {
     // find the inverse
     let x = 1;
     let y = 0;
-    for (let i = s.length - 2; i >= 0; --i) {
+    for (let i = s.length - 2; i >= 0; i -= 1) {
         [x, y] = [y, x - y * Math.floor(s[i]!.a / s[i]!.b)];
     }
-    return (y % m + m) % m;
+    return ((y % m) + m) % m;
 }
 
 export function calculatePublicKeyLength() {
     return 4 + 4 + 2048 / 8 + 2048 / 8 + 4;
 }
 
-export function calculatePublicKey(
-    privateKey: Uint8Array
-): Uint8Array;
+export function calculatePublicKey(privateKey: Uint8Array): Uint8Array;
 export function calculatePublicKey(
     privateKey: Uint8Array,
-    output: Uint8Array,
+    output: Uint8Array
 ): number;
 export function calculatePublicKey(
     privateKey: Uint8Array,
-    output?: Uint8Array,
+    output?: Uint8Array
 ): Uint8Array | number {
     // Android has its own public key generation algorithm
     // See https://android.googlesource.com/platform/system/core.git/+/91784040db2b9273687f88d8b95f729d4a61ecc2/libcrypto_utils/android_pubkey.cpp#111
@@ -156,20 +166,24 @@ export function calculatePublicKey(
     // extract `n` from private key
     const [n] = parsePrivateKey(privateKey);
 
-    let outputType: 'Uint8Array' | 'number';
+    let outputType: "Uint8Array" | "number";
     const outputLength = calculatePublicKeyLength();
     if (!output) {
         output = new Uint8Array(outputLength);
-        outputType = 'Uint8Array';
+        outputType = "Uint8Array";
     } else {
         if (output.byteLength < outputLength) {
-            throw new Error('output buffer is too small');
+            throw new Error("output buffer is too small");
         }
 
-        outputType = 'number';
+        outputType = "number";
     }
 
-    const outputView = new DataView(output.buffer, output.byteOffset, output.byteLength);
+    const outputView = new DataView(
+        output.buffer,
+        output.byteOffset,
+        output.byteLength
+    );
     let outputOffset = 0;
 
     // modulusLengthInWords
@@ -179,7 +193,10 @@ export function calculatePublicKey(
     // Calculate `n0inv`
     // Don't know why need to multiple -1
     // Didn't exist in Android codebase
-    const n0inv = modInverse(Number(BigInt.asUintN(32, n) * BigInt(-1)), 2 ** 32);
+    const n0inv = modInverse(
+        Number(BigInt.asUintN(32, n) * BigInt(-1)),
+        2 ** 32
+    );
     outputView.setUint32(outputOffset, n0inv, true);
     outputOffset += 4;
 
@@ -188,14 +205,14 @@ export function calculatePublicKey(
     outputOffset += 256;
 
     // Calculate rr = (2^(rsa_size)) ^ 2 mod n
-    let rr = BigInt(2) ** BigInt(4096) % n;
+    const rr = BigInt(2) ** BigInt(4096) % n;
     outputOffset += setBigUint(outputView, outputOffset, rr, true);
 
     // exponent
     outputView.setUint32(outputOffset, 65537, true);
     outputOffset += 4;
 
-    if (outputType === 'Uint8Array') {
+    if (outputType === "Uint8Array") {
         return output;
     } else {
         return outputLength;
@@ -209,7 +226,11 @@ export function calculatePublicKey(
  *
  * See https://en.wikipedia.org/wiki/Modular_exponentiation#Implementation_in_Lua
  */
-export function powMod(base: bigint, exponent: bigint, modulus: bigint): bigint {
+export function powMod(
+    base: bigint,
+    exponent: bigint,
+    modulus: bigint
+): bigint {
     if (modulus === BigInt1) {
         return BigInt0;
     }
@@ -219,7 +240,7 @@ export function powMod(base: bigint, exponent: bigint, modulus: bigint): bigint
 
     while (exponent > BigInt0) {
         if (BigInt.asUintN(1, exponent) === BigInt1) {
-            r = r * base % modulus;
+            r = (r * base) % modulus;
         }
 
         exponent >>= BigInt1;
@@ -238,12 +259,22 @@ export const ASN1_OID = 0x06;
 
 // PKCS#1 SHA-1 hash digest info
 export const SHA1_DIGEST_INFO = new Uint8Array([
-    ASN1_SEQUENCE, 0x0d + SHA1_DIGEST_LENGTH,
-    ASN1_SEQUENCE, 0x09,
+    ASN1_SEQUENCE,
+    0x0d + SHA1_DIGEST_LENGTH,
+    ASN1_SEQUENCE,
+    0x09,
     // SHA-1 (1 3 14 3 2 26)
-    ASN1_OID, 0x05, 1 * 40 + 3, 14, 3, 2, 26,
-    ASN1_NULL, 0x00,
-    ASN1_OCTET_STRING, SHA1_DIGEST_LENGTH
+    ASN1_OID,
+    0x05,
+    1 * 40 + 3,
+    14,
+    3,
+    2,
+    26,
+    ASN1_NULL,
+    0x00,
+    ASN1_OCTET_STRING,
+    SHA1_DIGEST_LENGTH,
 ]);
 
 // SubtleCrypto.sign() will hash the given data and sign the hash
@@ -265,7 +296,8 @@ export function sign(privateKey: Uint8Array, data: Uint8Array): Uint8Array {
     padded[index] = 1;
     index += 1;
 
-    const fillLength = padded.length - SHA1_DIGEST_INFO.length - data.length - 1;
+    const fillLength =
+        padded.length - SHA1_DIGEST_INFO.length - data.length - 1;
     while (index < fillLength) {
         padded[index] = 0xff;
         index += 1;
@@ -282,11 +314,7 @@ export function sign(privateKey: Uint8Array, data: Uint8Array): Uint8Array {
     // Encryption
     // signature = padded ** d % n
     const view = new DataView(padded.buffer);
-    const signature = powMod(
-        getBigUint(view, 0, view.byteLength),
-        d,
-        n
-    );
+    const signature = powMod(getBigUint(view, 0, view.byteLength), d, n);
 
     // `padded` is not used anymore,
     // re-use the buffer to store the result

package/src/features.ts

@@ -1,7 +1,7 @@
 // The order follows
 // https://android.googlesource.com/platform/packages/modules/adb/+/79010dc6d5ca7490c493df800d4421730f5466ca/transport.cpp#1252
 export enum AdbFeatures {
-    ShellV2 = "shell_v2",
+    ShellV2 = 'shell_v2',
     Cmd = 'cmd',
     StatV2 = 'stat_v2',
     ListV2 = 'ls_v2',

package/src/index.ts

@@ -1,11 +1,9 @@
-
-export * from './adb.js';
-export * from './auth.js';
-export * from './backend.js';
-export * from './commands/index.js';
-export * from './crypto.js';
-export * from './features.js';
-export * from './packet.js';
-export * from './socket/index.js';
-export * from './stream/index.js';
-export * from './utils/index.js';
+export * from "./adb.js";
+export * from "./auth.js";
+export * from "./backend.js";
+export * from "./commands/index.js";
+export * from "./crypto.js";
+export * from "./features.js";
+export * from "./packet.js";
+export * from "./socket/index.js";
+export * from "./utils/index.js";

package/src/packet.ts

@@ -1,34 +1,32 @@
-import Struct from '@yume-chan/struct';
-import { TransformStream } from "./stream/index.js";
+import { TransformStream } from "@yume-chan/stream-extra";
+import Struct from "@yume-chan/struct";
 
 export enum AdbCommand {
-    Auth = 0x48545541,    // 'AUTH'
-    Close = 0x45534c43,   // 'CLSE'
+    Auth = 0x48545541, // 'AUTH'
+    Close = 0x45534c43, // 'CLSE'
     Connect = 0x4e584e43, // 'CNXN'
-    OK = 0x59414b4f,      // 'OKAY'
-    Open = 0x4e45504f,    // 'OPEN'
-    Write = 0x45545257,   // 'WRTE'
+    OK = 0x59414b4f, // 'OKAY'
+    Open = 0x4e45504f, // 'OPEN'
+    Write = 0x45545257, // 'WRTE'
 }
 
-export const AdbPacketHeader =
-    new Struct({ littleEndian: true })
-        .uint32('command')
-        .uint32('arg0')
-        .uint32('arg1')
-        .uint32('payloadLength')
-        .uint32('checksum')
-        .int32('magic');
+export const AdbPacketHeader = new Struct({ littleEndian: true })
+    .uint32("command")
+    .uint32("arg0")
+    .uint32("arg1")
+    .uint32("payloadLength")
+    .uint32("checksum")
+    .int32("magic");
 
-export type AdbPacketHeader = typeof AdbPacketHeader['TDeserializeResult'];
+export type AdbPacketHeader = typeof AdbPacketHeader["TDeserializeResult"];
 
-type AdbPacketHeaderInit = typeof AdbPacketHeader['TInit'];
+type AdbPacketHeaderInit = typeof AdbPacketHeader["TInit"];
 
-export const AdbPacket =
-    new Struct({ littleEndian: true })
-        .fields(AdbPacketHeader)
-        .uint8Array('payload', { lengthField: 'payloadLength' });
+export const AdbPacket = new Struct({ littleEndian: true })
+    .fields(AdbPacketHeader)
+    .uint8Array("payload", { lengthField: "payloadLength" });
 
-export type AdbPacket = typeof AdbPacket['TDeserializeResult'];
+export type AdbPacket = typeof AdbPacket["TDeserializeResult"];
 
 /**
  * `AdbPacketData` contains all the useful fields of `AdbPacket`.
@@ -40,29 +38,41 @@ export type AdbPacket = typeof AdbPacket['TDeserializeResult'];
  * however, `AdbPacketDispatcher` will transform `AdbPacketData` to `AdbPacketInit` for you,
  * so `AdbSocket#writable#write` only needs `AdbPacketData`.
  */
-export type AdbPacketData = Omit<typeof AdbPacket['TInit'], 'checksum' | 'magic'>;
+export type AdbPacketData = Omit<
+    typeof AdbPacket["TInit"],
+    "checksum" | "magic"
+>;
 
 // All fields except `magic`, which can be calculated in `AdbPacketSerializeStream`
-export type AdbPacketInit = Omit<typeof AdbPacket['TInit'], 'magic'>;
+export type AdbPacketInit = Omit<typeof AdbPacket["TInit"], "magic">;
 
 export function calculateChecksum(payload: Uint8Array): number;
 export function calculateChecksum(init: AdbPacketData): AdbPacketInit;
-export function calculateChecksum(payload: Uint8Array | AdbPacketData): number | AdbPacketInit {
+export function calculateChecksum(
+    payload: Uint8Array | AdbPacketData
+): number | AdbPacketInit {
     if (payload instanceof Uint8Array) {
         return payload.reduce((result, item) => result + item, 0);
     } else {
-        (payload as AdbPacketInit).checksum = calculateChecksum(payload.payload);
+        (payload as AdbPacketInit).checksum = calculateChecksum(
+            payload.payload
+        );
         return payload as AdbPacketInit;
     }
 }
 
-export class AdbPacketSerializeStream extends TransformStream<AdbPacketInit, Uint8Array>{
+export class AdbPacketSerializeStream extends TransformStream<
+    AdbPacketInit,
+    Uint8Array
+> {
     public constructor() {
         super({
-            transform: async (init, controller) => {
+            transform: (init, controller) => {
                 // This syntax is ugly, but I don't want to create a new object.
-                (init as unknown as AdbPacketHeaderInit).magic = init.command ^ 0xFFFFFFFF;
-                (init as unknown as AdbPacketHeaderInit).payloadLength = init.payload.byteLength;
+                (init as unknown as AdbPacketHeaderInit).magic =
+                    init.command ^ 0xffffffff;
+                (init as unknown as AdbPacketHeaderInit).payloadLength =
+                    init.payload.byteLength;
 
                 controller.enqueue(
                     AdbPacketHeader.serialize(

package/src/socket/dispatcher.ts

@@ -1,11 +1,22 @@
-import { AsyncOperationManager, PromiseResolver } from '@yume-chan/async';
-import type { RemoveEventListener } from '@yume-chan/event';
+import { AsyncOperationManager, PromiseResolver } from "@yume-chan/async";
+import { type RemoveEventListener } from "@yume-chan/event";
+import {
+    AbortController,
+    WritableStream,
+    type ReadableWritablePair,
+    type WritableStreamDefaultWriter,
+} from "@yume-chan/stream-extra";
 import { EMPTY_UINT8_ARRAY, type ValueOrPromise } from "@yume-chan/struct";
 
-import { AdbCommand, calculateChecksum, type AdbPacketData, type AdbPacketInit } from '../packet.js';
-import { AbortController, WritableStream, WritableStreamDefaultWriter, type ReadableWritablePair } from '../stream/index.js';
-import { decodeUtf8, encodeUtf8 } from '../utils/index.js';
-import { AdbSocket, AdbSocketController } from './socket.js';
+import {
+    AdbCommand,
+    calculateChecksum,
+    type AdbPacketData,
+    type AdbPacketInit,
+} from "../packet.js";
+import { decodeUtf8, encodeUtf8 } from "../utils/index.js";
+
+import { AdbSocketController, type AdbSocket } from "./socket.js";
 
 export interface AdbPacketDispatcherOptions {
     calculateChecksum: boolean;
@@ -19,7 +30,9 @@ export interface AdbPacketDispatcherOptions {
     maxPayloadSize: number;
 }
 
-export type AdbIncomingSocketHandler = (socket: AdbSocket) => ValueOrPromise<boolean>;
+export type AdbIncomingSocketHandler = (
+    socket: AdbSocket
+) => ValueOrPromise<boolean>;
 
 export interface Closeable {
     close(): ValueOrPromise<void>;
@@ -50,7 +63,9 @@ export class AdbPacketDispatcher implements Closeable {
 
     private _closed = false;
     private _disconnected = new PromiseResolver<void>();
-    public get disconnected() { return this._disconnected.promise; }
+    public get disconnected() {
+        return this._disconnected.promise;
+    }
 
     private _incomingSocketHandlers: Set<AdbIncomingSocketHandler> = new Set();
 
@@ -63,53 +78,68 @@ export class AdbPacketDispatcher implements Closeable {
         this.options = options;
 
         connection.readable
-            .pipeTo(new WritableStream({
-                write: async (packet) => {
-                    switch (packet.command) {
-                        case AdbCommand.OK:
-                            this.handleOk(packet);
-                            break;
-                        case AdbCommand.Close:
-                            await this.handleClose(packet);
-                            break;
-                        case AdbCommand.Write:
-                            if (this.sockets.has(packet.arg1)) {
-                                await this.sockets.get(packet.arg1)!.enqueue(packet.payload);
-                                await this.sendPacket(AdbCommand.OK, packet.arg1, packet.arg0);
+            .pipeTo(
+                new WritableStream({
+                    write: async (packet) => {
+                        switch (packet.command) {
+                            case AdbCommand.OK:
+                                this.handleOk(packet);
                                 break;
-                            }
-                            throw new Error(`Unknown local socket id: ${packet.arg1}`);
-                        case AdbCommand.Open:
-                            await this.handleOpen(packet);
-                            break;
-                        default:
-                            // Junk data may only appear in the authentication phase,
-                            // since the dispatcher only works after authentication,
-                            // all packets should have a valid command.
-                            // (although it's possible that Adb added new commands in the future)
-                            throw new Error(`Unknown command: ${packet.command.toString(16)}`);
-                    }
+                            case AdbCommand.Close:
+                                await this.handleClose(packet);
+                                break;
+                            case AdbCommand.Write:
+                                if (this.sockets.has(packet.arg1)) {
+                                    await this.sockets
+                                        .get(packet.arg1)!
+                                        .enqueue(packet.payload);
+                                    await this.sendPacket(
+                                        AdbCommand.OK,
+                                        packet.arg1,
+                                        packet.arg0
+                                    );
+                                    break;
+                                }
+                                throw new Error(
+                                    `Unknown local socket id: ${packet.arg1}`
+                                );
+                            case AdbCommand.Open:
+                                await this.handleOpen(packet);
+                                break;
+                            default:
+                                // Junk data may only appear in the authentication phase,
+                                // since the dispatcher only works after authentication,
+                                // all packets should have a valid command.
+                                // (although it's possible that Adb added new commands in the future)
+                                throw new Error(
+                                    `Unknown command: ${packet.command.toString(
+                                        16
+                                    )}`
+                                );
+                        }
+                    },
+                }),
+                {
+                    // There are multiple reasons for the pipe to stop,
+                    // (device disconnection, protocol error, or user abortion)
+                    // if the underlying streams are still open,
+                    // it's still possible to create another ADB connection.
+                    // So don't close `readable` here.
+                    preventCancel: true,
+                    signal: this._abortController.signal,
+                }
+            )
+            .then(
+                () => {
+                    this.dispose();
                 },
-            }), {
-                // There are multiple reasons for the pipe to stop,
-                // (device disconnection, protocol error, or user abortion)
-                // if the underlying streams are still open,
-                // it's still possible to create another ADB connection.
-                // So don't close `readable` here.
-                preventCancel: true,
-                signal: this._abortController.signal,
-            })
-            .then(() => {
-                this.dispose();
-            }, (e) => {
-                // https://github.com/MattiasBuelens/web-streams-polyfill/issues/115
-                // `e` is always `AbortError` (instead of what I give in `abortController.abort()`)
-                // so we can't check if `e` is a real error.
-                if (!this._closed) {
-                    this._disconnected.reject(e);
+                (e) => {
+                    if (!this._closed) {
+                        this._disconnected.reject(e);
+                    }
+                    this.dispose();
                 }
-                this.dispose();
-            });
+            );
 
         this._writer = connection.writable.getWriter();
     }
@@ -129,13 +159,18 @@ export class AdbPacketDispatcher implements Closeable {
 
         // Maybe the device is responding to a packet of last connection
         // Tell the device to close the socket
-        this.sendPacket(AdbCommand.Close, packet.arg1, packet.arg0);
+        void this.sendPacket(AdbCommand.Close, packet.arg1, packet.arg0);
     }
 
     private async handleClose(packet: AdbPacketData) {
         // If the socket is still pending
-        if (packet.arg0 === 0 &&
-            this.initializers.reject(packet.arg1, new Error('Socket open failed'))) {
+        if (
+            packet.arg0 === 0 &&
+            this.initializers.reject(
+                packet.arg1,
+                new Error("Socket open failed")
+            )
+        ) {
             // Device failed to create the socket
             // (unknown service string, failed to execute command, etc.)
             // it doesn't break the connection,
@@ -156,9 +191,13 @@ export class AdbPacketDispatcher implements Closeable {
         if (socket) {
             // The device want to close the socket
             if (!socket.closed) {
-                await this.sendPacket(AdbCommand.Close, packet.arg1, packet.arg0);
+                await this.sendPacket(
+                    AdbCommand.Close,
+                    packet.arg1,
+                    packet.arg0
+                );
             }
-            socket.dispose();
+            await socket.dispose();
             this.sockets.delete(packet.arg1);
             return;
         }
@@ -168,7 +207,14 @@ export class AdbPacketDispatcher implements Closeable {
         // the device may also respond with two `CLSE` packets.
     }
 
-    public addIncomingSocketHandler(handler: AdbIncomingSocketHandler): RemoveEventListener {
+    /**
+     * Add a handler for incoming socket.
+     * @param handler A function to call with new incoming sockets. It must return `true` if it accepts the socket.
+     * @returns A function to remove the handler.
+     */
+    public onIncomingSocket(
+        handler: AdbIncomingSocketHandler
+    ): RemoveEventListener {
         this._incomingSocketHandlers.add(handler);
         const remove = () => {
             this._incomingSocketHandlers.delete(handler);
@@ -178,7 +224,7 @@ export class AdbPacketDispatcher implements Closeable {
     }
 
     private async handleOpen(packet: AdbPacketData) {
-        // AsyncOperationManager doesn't support get and skip an ID
+        // `AsyncOperationManager` doesn't support skipping IDs
         // Use `add` + `resolve` to simulate this behavior
         const [localId] = this.initializers.add<number>();
         this.initializers.resolve(localId, undefined);
@@ -207,16 +253,11 @@ export class AdbPacketDispatcher implements Closeable {
 
     public async createSocket(serviceString: string): Promise<AdbSocket> {
         if (this.options.appendNullToServiceString) {
-            serviceString += '\0';
+            serviceString += "\0";
         }
 
         const [localId, initializer] = this.initializers.add<number>();
-        await this.sendPacket(
-            AdbCommand.Open,
-            localId,
-            0,
-            serviceString
-        );
+        await this.sendPacket(AdbCommand.Open, localId, 0, serviceString);
 
         // Fulfilled by `handleOk`
         const remoteId = await initializer;
@@ -243,27 +284,29 @@ export class AdbPacketDispatcher implements Closeable {
         packetOrCommand: AdbPacketInit | AdbCommand,
         arg0?: number,
         arg1?: number,
-        payload: string | Uint8Array = EMPTY_UINT8_ARRAY,
+        payload: string | Uint8Array = EMPTY_UINT8_ARRAY
     ): Promise<void> {
         let init: AdbPacketData;
         if (arg0 === undefined) {
             init = packetOrCommand as AdbPacketInit;
         } else {
-            if (typeof payload === 'string') {
+            if (typeof payload === "string") {
                 payload = encodeUtf8(payload);
             }
 
             init = {
                 command: packetOrCommand as AdbCommand,
-                arg0: arg0 as number,
+                arg0: arg0,
                 arg1: arg1 as number,
                 payload,
             };
         }
 
-        if (init.payload &&
-            init.payload.byteLength > this.options.maxPayloadSize) {
-            throw new Error('payload too large');
+        if (
+            init.payload &&
+            init.payload.byteLength > this.options.maxPayloadSize
+        ) {
+            throw new Error("payload too large");
         }
 
         if (this.options.calculateChecksum) {
@@ -279,10 +322,7 @@ export class AdbPacketDispatcher implements Closeable {
     public async close() {
         // Send `CLSE` packets for all sockets
         await Promise.all(
-            Array.from(
-                this.sockets.values(),
-                socket => socket.close(),
-            )
+            Array.from(this.sockets.values(), (socket) => socket.close())
         );
 
         // Stop receiving
@@ -297,7 +337,9 @@ export class AdbPacketDispatcher implements Closeable {
 
     private dispose() {
         for (const socket of this.sockets.values()) {
-            socket.dispose();
+            socket.dispose().catch((e) => {
+                void e;
+            });
         }
 
         this._disconnected.resolve();

package/src/socket/index.ts

@@ -1,2 +1,2 @@
-export * from './socket.js';
 export * from './dispatcher.js';
+export * from './socket.js';