kafka-ts 0.0.1-beta → 0.0.1-beta.1

package/src/api/api-versions.ts

@@ -1,5 +1,5 @@
-import { createApi } from "../utils/api.js";
-import { KafkaTSApiError } from "../utils/error.js";
+import { createApi } from '../utils/api.js';
+import { KafkaTSApiError } from '../utils/error.js';
 
 export const API_VERSIONS = createApi({
     apiKey: 18,

package/src/api/create-topics.ts

@@ -1,5 +1,5 @@
-import { createApi } from "../utils/api";
-import { KafkaTSApiError } from "../utils/error";
+import { createApi } from '../utils/api';
+import { KafkaTSApiError } from '../utils/error';
 
 export const CREATE_TOPICS = createApi({
     apiKey: 19,

package/src/api/delete-topics.ts

@@ -1,5 +1,5 @@
-import { createApi } from "../utils/api";
-import { KafkaTSApiError } from "../utils/error";
+import { createApi } from '../utils/api';
+import { KafkaTSApiError } from '../utils/error';
 
 export const DELETE_TOPICS = createApi({
     apiKey: 20,

package/src/api/fetch.ts

@@ -1,6 +1,6 @@
-import { createApi } from "../utils/api";
-import { Decoder } from "../utils/decoder";
-import { KafkaTSApiError } from "../utils/error";
+import { createApi } from '../utils/api';
+import { Decoder } from '../utils/decoder';
+import { KafkaTSApiError } from '../utils/error';
 
 export const enum IsolationLevel {
     READ_UNCOMMITTED = 0,

package/src/api/find-coordinator.ts

@@ -1,5 +1,5 @@
-import { createApi } from "../utils/api";
-import { KafkaTSApiError } from "../utils/error";
+import { createApi } from '../utils/api';
+import { KafkaTSApiError } from '../utils/error';
 
 export const KEY_TYPE = {
     GROUP: 0,

package/src/api/heartbeat.ts

@@ -1,5 +1,5 @@
-import { createApi } from "../utils/api";
-import { KafkaTSApiError } from "../utils/error";
+import { createApi } from '../utils/api';
+import { KafkaTSApiError } from '../utils/error';
 
 export const HEARTBEAT = createApi({
     apiKey: 12,

package/src/api/index.ts

@@ -1,21 +1,21 @@
-import { Api } from "../utils/api";
-import { API_VERSIONS } from "./api-versions";
-import { CREATE_TOPICS } from "./create-topics";
-import { DELETE_TOPICS } from "./delete-topics";
-import { FETCH } from "./fetch";
-import { FIND_COORDINATOR } from "./find-coordinator";
-import { HEARTBEAT } from "./heartbeat";
-import { INIT_PRODUCER_ID } from "./init-producer-id";
-import { JOIN_GROUP } from "./join-group";
-import { LEAVE_GROUP } from "./leave-group";
-import { LIST_OFFSETS } from "./list-offsets";
-import { METADATA } from "./metadata";
-import { OFFSET_COMMIT } from "./offset-commit";
-import { OFFSET_FETCH } from "./offset-fetch";
-import { PRODUCE } from "./produce";
-import { SASL_AUTHENTICATE } from "./sasl-authenticate";
-import { SASL_HANDSHAKE } from "./sasl-handshake";
-import { SYNC_GROUP } from "./sync-group";
+import { Api } from '../utils/api';
+import { API_VERSIONS } from './api-versions';
+import { CREATE_TOPICS } from './create-topics';
+import { DELETE_TOPICS } from './delete-topics';
+import { FETCH } from './fetch';
+import { FIND_COORDINATOR } from './find-coordinator';
+import { HEARTBEAT } from './heartbeat';
+import { INIT_PRODUCER_ID } from './init-producer-id';
+import { JOIN_GROUP } from './join-group';
+import { LEAVE_GROUP } from './leave-group';
+import { LIST_OFFSETS } from './list-offsets';
+import { METADATA } from './metadata';
+import { OFFSET_COMMIT } from './offset-commit';
+import { OFFSET_FETCH } from './offset-fetch';
+import { PRODUCE } from './produce';
+import { SASL_AUTHENTICATE } from './sasl-authenticate';
+import { SASL_HANDSHAKE } from './sasl-handshake';
+import { SYNC_GROUP } from './sync-group';
 
 export const API = {
     API_VERSIONS,

package/src/api/init-producer-id.ts

@@ -1,5 +1,5 @@
-import { createApi } from "../utils/api";
-import { KafkaTSApiError } from "../utils/error";
+import { createApi } from '../utils/api';
+import { KafkaTSApiError } from '../utils/error';
 
 export const INIT_PRODUCER_ID = createApi({
     apiKey: 22,

package/src/api/join-group.ts

@@ -1,6 +1,6 @@
-import { createApi } from "../utils/api";
-import { Encoder } from "../utils/encoder";
-import { KafkaTSApiError } from "../utils/error";
+import { createApi } from '../utils/api';
+import { Encoder } from '../utils/encoder';
+import { KafkaTSApiError } from '../utils/error';
 
 export const JOIN_GROUP = createApi({
     apiKey: 11,

package/src/api/leave-group.ts

@@ -1,5 +1,5 @@
-import { createApi } from "../utils/api";
-import { KafkaTSApiError } from "../utils/error";
+import { createApi } from '../utils/api';
+import { KafkaTSApiError } from '../utils/error';
 
 export const LEAVE_GROUP = createApi({
     apiKey: 13,

package/src/api/list-offsets.ts

@@ -1,6 +1,6 @@
-import { createApi } from "../utils/api";
-import { KafkaTSApiError } from "../utils/error";
-import { IsolationLevel } from "./fetch";
+import { createApi } from '../utils/api';
+import { KafkaTSApiError } from '../utils/error';
+import { IsolationLevel } from './fetch';
 
 export const LIST_OFFSETS = createApi({
     apiKey: 2,

package/src/api/metadata.ts

@@ -1,7 +1,7 @@
-import { createApi } from "../utils/api";
-import { KafkaTSApiError } from "../utils/error";
+import { createApi } from '../utils/api';
+import { KafkaTSApiError } from '../utils/error';
 
-export type Metadata = ReturnType<(typeof METADATA)["response"]>;
+export type Metadata = ReturnType<(typeof METADATA)['response']>;
 
 export const METADATA = createApi({
     apiKey: 3,

package/src/api/offset-commit.ts

@@ -1,5 +1,5 @@
-import { createApi } from "../utils/api";
-import { KafkaTSApiError } from "../utils/error";
+import { createApi } from '../utils/api';
+import { KafkaTSApiError } from '../utils/error';
 
 export const OFFSET_COMMIT = createApi({
     apiKey: 8,

package/src/api/offset-fetch.ts

@@ -1,5 +1,5 @@
-import { createApi } from "../utils/api";
-import { KafkaTSApiError } from "../utils/error";
+import { createApi } from '../utils/api';
+import { KafkaTSApiError } from '../utils/error';
 
 export const OFFSET_FETCH = createApi({
     apiKey: 9,

package/src/api/produce.ts

@@ -1,6 +1,6 @@
-import { createApi } from "../utils/api.js";
-import { Encoder } from "../utils/encoder.js";
-import { KafkaTSApiError } from "../utils/error.js";
+import { createApi } from '../utils/api.js';
+import { Encoder } from '../utils/encoder.js';
+import { KafkaTSApiError } from '../utils/error.js';
 
 export const PRODUCE = createApi({
     apiKey: 0,

package/src/api/sasl-authenticate.ts

@@ -1,5 +1,5 @@
-import { createApi } from "../utils/api";
-import { KafkaTSApiError } from "../utils/error";
+import { createApi } from '../utils/api';
+import { KafkaTSApiError } from '../utils/error';
 
 export const SASL_AUTHENTICATE = createApi({
     apiKey: 36,

package/src/api/sasl-handshake.ts

@@ -1,5 +1,5 @@
-import { createApi } from "../utils/api";
-import { KafkaTSApiError } from "../utils/error";
+import { createApi } from '../utils/api';
+import { KafkaTSApiError } from '../utils/error';
 
 export const SASL_HANDSHAKE = createApi({
     apiKey: 17,

package/src/api/sync-group.ts

@@ -1,5 +1,5 @@
-import { createApi } from "../utils/api";
-import { KafkaTSApiError } from "../utils/error";
+import { createApi } from '../utils/api';
+import { KafkaTSApiError } from '../utils/error';
 
 export type Assignment = { [topic: string]: number[] };
 

package/src/auth/index.ts

@@ -0,0 +1,2 @@
+export { saslPlain } from './plain';
+export { saslScramSha256, saslScramSha512 } from './scram';

package/src/auth/plain.ts

@@ -0,0 +1,10 @@
+import { API } from "../api";
+import { SASLProvider } from "../broker";
+
+export const saslPlain = ({ username, password }: { username: string; password: string }): SASLProvider => ({
+    mechanism: 'PLAIN',
+    authenticate: async ({ sendRequest }) => {
+        const authBytes = [null, username, password].join('\u0000');
+        await sendRequest(API.SASL_AUTHENTICATE, { authBytes: Buffer.from(authBytes) });
+    },
+});

package/src/auth/scram.ts

@@ -0,0 +1,52 @@
+import { API } from '../api';
+import { SASLProvider } from '../broker';
+import { base64Decode, base64Encode, generateNonce, hash, hmac, saltPassword, xor } from '../utils/crypto';
+import { KafkaTSError } from '../utils/error';
+
+const saslScram =
+    ({ mechanism, keyLength, digest }: { mechanism: string; keyLength: number; digest: string }) =>
+    ({ username, password }: { username: string; password: string }): SASLProvider => ({
+        mechanism,
+        authenticate: async ({ sendRequest }) => {
+            const nonce = generateNonce();
+            const firstMessage = `n=${username},r=${nonce}`;
+
+            const { authBytes } = await sendRequest(API.SASL_AUTHENTICATE, {
+                authBytes: Buffer.from(`n,,${firstMessage}`),
+            });
+            if (!authBytes) {
+                throw new KafkaTSError('No auth response');
+            }
+
+            const response = Object.fromEntries(
+                authBytes
+                    .toString()
+                    .split(',')
+                    .map((pair) => pair.split('=')),
+            ) as { r: string; s: string; i: string };
+
+            const rnonce = response.r;
+            if (!rnonce.startsWith(nonce)) {
+                throw new KafkaTSError('Invalid nonce');
+            }
+            const iterations = parseInt(response.i);
+            const salt = base64Decode(response.s);
+
+            const saltedPassword = await saltPassword(password, salt, iterations, keyLength, digest);
+            const clientKey = hmac(saltedPassword, 'Client Key', digest);
+            const clientKeyHash = hash(clientKey, digest);
+
+            let finalMessage = `c=${base64Encode('n,,')},r=${rnonce}`;
+
+            const fullMessage = `${firstMessage},${authBytes.toString()},${finalMessage}`;
+            const clientSignature = hmac(clientKeyHash, fullMessage, digest);
+            const clientProof = base64Encode(xor(clientKey, clientSignature));
+
+            finalMessage += `,p=${clientProof}`;
+
+            await sendRequest(API.SASL_AUTHENTICATE, { authBytes: Buffer.from(finalMessage) });
+        },
+    });
+
+export const saslScramSha256 = saslScram({ mechanism: 'SCRAM-SHA-256', keyLength: 32, digest: 'sha256' });
+export const saslScramSha512 = saslScram({ mechanism: 'SCRAM-SHA-512', keyLength: 64, digest: 'sha512' });

package/src/broker.ts

@@ -1,16 +1,19 @@
-import { TcpSocketConnectOpts } from "net";
-import { TLSSocketOptions } from "tls";
-import { API } from "./api";
-import { Connection, SendRequest } from "./connection";
-import { KafkaTSError } from "./utils/error";
-import { memo } from "./utils/memo";
+import { TcpSocketConnectOpts } from 'net';
+import { TLSSocketOptions } from 'tls';
+import { API } from './api';
+import { Connection, SendRequest } from './connection';
+import { KafkaTSError } from './utils/error';
+import { memo } from './utils/memo';
 
-export type SASLOptions = { mechanism: "PLAIN"; username: string; password: string };
+export type SASLProvider = {
+    mechanism: string;
+    authenticate: (context: { sendRequest: SendRequest }) => Promise<void>;
+};
 
 type BrokerOptions = {
     clientId: string | null;
     options: TcpSocketConnectOpts;
-    sasl: SASLOptions | null;
+    sasl: SASLProvider | null;
     ssl: TLSSocketOptions | null;
 };
 
@@ -64,11 +67,6 @@ export class Broker {
     }
 
     private async saslAuthenticate() {
-        if (this.options.sasl?.mechanism !== "PLAIN") {
-            return;
-        }
-        const { username, password } = this.options.sasl;
-        const authBytes = [null, username, password].join("\u0000");
-        await this.sendRequest(API.SASL_AUTHENTICATE, { authBytes: Buffer.from(authBytes) });
+        await this.options.sasl?.authenticate({ sendRequest: this.sendRequest });
     }
 }

package/src/client.ts

@@ -1,14 +1,14 @@
-import { TcpSocketConnectOpts } from "net";
-import { TLSSocketOptions } from "tls";
-import { SASLOptions } from "./broker";
-import { Cluster } from "./cluster";
-import { Consumer, ConsumerOptions } from "./consumer/consumer";
-import { Producer, ProducerOptions } from "./producer/producer";
+import { TcpSocketConnectOpts } from 'net';
+import { TLSSocketOptions } from 'tls';
+import { SASLProvider } from './broker';
+import { Cluster } from './cluster';
+import { Consumer, ConsumerOptions } from './consumer/consumer';
+import { Producer, ProducerOptions } from './producer/producer';
 
 type ClientOptions = {
     clientId?: string | null;
     bootstrapServers: TcpSocketConnectOpts[];
-    sasl?: SASLOptions | null;
+    sasl?: SASLProvider | null;
     ssl?: TLSSocketOptions | null;
 };