@forwardimpact/librpc 0.1.77

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Dick Olsson
+
+   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.

package/auth.js

@@ -0,0 +1,269 @@
+import crypto from "crypto";
+import grpc from "@grpc/grpc-js";
+
+/**
+ * HMAC-based authenticator for service-to-service authentication
+ * Uses HMAC-SHA256 to generate and verify time-limited tokens
+ */
+export class HmacAuth {
+  #secret;
+  #tokenLifetimeMs;
+
+  /**
+   * Creates a new HMAC authenticator instance
+   * @param {string} secret - Shared secret key for HMAC generation (minimum 32 characters)
+   * @param {number} tokenLifetimeSeconds - Token lifetime in seconds (default: 60)
+   * @throws {Error} When secret is too short or invalid
+   */
+  constructor(secret, tokenLifetimeSeconds = 60) {
+    if (!secret || typeof secret !== "string") {
+      throw new Error("Secret must be a non-empty string");
+    }
+    if (secret.length < 32) {
+      throw new Error("Secret must be at least 32 characters long");
+    }
+    if (tokenLifetimeSeconds <= 0) {
+      throw new Error("Token lifetime must be positive");
+    }
+
+    this.#secret = secret;
+    this.#tokenLifetimeMs = tokenLifetimeSeconds * 1000;
+  }
+
+  /**
+   * Generates an HMAC token for the specified service
+   * @param {string} serviceId - Identifier of the service requesting authentication
+   * @returns {string} Base64 encoded HMAC token
+   * @throws {Error} When serviceId is invalid
+   */
+  generateToken(serviceId) {
+    if (!serviceId || typeof serviceId !== "string") {
+      throw new Error("Service ID must be a non-empty string");
+    }
+
+    const timestamp = Date.now();
+    const payload = `${serviceId}:${timestamp}`;
+    const signature = crypto
+      .createHmac("sha256", this.#secret)
+      .update(payload)
+      .digest("hex");
+
+    const token = `${payload}:${signature}`;
+    return Buffer.from(token).toString("base64");
+  }
+
+  /**
+   * Verifies an HMAC token and extracts service information
+   * @param {string} token - Base64 encoded HMAC token to verify
+   * @returns {object} Verification result containing serviceId and isValid
+   * @throws {Error} When token format is invalid
+   */
+  verifyToken(token) {
+    if (!token || typeof token !== "string") {
+      return {
+        isValid: false,
+        serviceId: null,
+        error: "Token must be a non-empty string",
+      };
+    }
+
+    try {
+      // Decode base64 token
+      const decoded = Buffer.from(token, "base64").toString("utf8");
+      const parts = decoded.split(":");
+
+      if (parts.length !== 3) {
+        return {
+          isValid: false,
+          serviceId: null,
+          error: "Invalid token format",
+        };
+      }
+
+      const [serviceId, timestampStr, providedSignature] = parts;
+      const timestamp = parseInt(timestampStr, 10);
+
+      if (isNaN(timestamp)) {
+        return {
+          isValid: false,
+          serviceId: null,
+          error: "Invalid timestamp in token",
+        };
+      }
+
+      // Check token expiration
+      const now = Date.now();
+      if (now - timestamp > this.#tokenLifetimeMs) {
+        return {
+          isValid: false,
+          serviceId: null,
+          error: "Token has expired",
+        };
+      }
+
+      // Verify HMAC signature
+      const payload = `${serviceId}:${timestamp}`;
+      const expectedSignature = crypto
+        .createHmac("sha256", this.#secret)
+        .update(payload)
+        .digest("hex");
+
+      if (providedSignature !== expectedSignature) {
+        return {
+          isValid: false,
+          serviceId: null,
+          error: "Invalid token signature",
+        };
+      }
+
+      return {
+        isValid: true,
+        serviceId,
+        error: null,
+      };
+    } catch (error) {
+      return {
+        isValid: false,
+        serviceId: null,
+        error: `Token verification failed: ${error.message}`,
+      };
+    }
+  }
+
+  /**
+   * Gets the configured token lifetime in seconds
+   * @returns {number} Token lifetime in seconds
+   */
+  getTokenLifetime() {
+    return this.#tokenLifetimeMs / 1000;
+  }
+}
+
+/**
+ * gRPC interceptor for HMAC-based service authentication
+ * Handles automatic token attachment for outgoing requests and validation for incoming requests
+ */
+export class Interceptor {
+  #authenticator;
+  #serviceId;
+
+  /**
+   * Creates a new authentication interceptor
+   * @param {HmacAuth} authenticator - HMAC authenticator instance
+   * @param {string} serviceId - Identifier of the current service
+   * @throws {Error} When parameters are invalid
+   */
+  constructor(authenticator, serviceId) {
+    if (!authenticator) {
+      throw new Error("Authenticator is required");
+    }
+    if (!serviceId || typeof serviceId !== "string") {
+      throw new Error("Service ID must be a non-empty string");
+    }
+
+    this.#authenticator = authenticator;
+    this.#serviceId = serviceId;
+  }
+
+  /**
+   * Creates a client interceptor that adds authentication tokens to outgoing requests
+   * @returns {Function} gRPC client interceptor function
+   */
+  createClientInterceptor() {
+    return (options, nextCall) => {
+      return new grpc.InterceptingCall(nextCall(options), {
+        start: (metadata, listener, next) => {
+          // Generate and add auth token to metadata
+          try {
+            const token = this.#authenticator.generateToken(this.#serviceId);
+            metadata.set("authorization", `Bearer ${token}`);
+          } catch (error) {
+            console.error("Failed to generate auth token:", error);
+          }
+          next(metadata, listener);
+        },
+      });
+    };
+  }
+
+  /**
+   * Creates a server interceptor that validates authentication tokens from incoming requests
+   * @returns {Function} gRPC server interceptor function
+   */
+  createServerInterceptor() {
+    return (call, metadata) => {
+      // Extract and verify auth token from metadata
+      const authHeader = metadata.get("authorization")[0];
+
+      if (!authHeader) {
+        throw {
+          code: grpc.status.UNAUTHENTICATED,
+          message: "Missing authentication token",
+        };
+      }
+
+      // Extract token from "Bearer <token>" format
+      const tokenMatch = authHeader.match(/^Bearer\s+(.+)$/);
+      if (!tokenMatch) {
+        throw {
+          code: grpc.status.UNAUTHENTICATED,
+          message: "Invalid authentication header format",
+        };
+      }
+
+      const token = tokenMatch[1];
+      const verification = this.#authenticator.verifyToken(token);
+
+      if (!verification.isValid) {
+        throw {
+          code: grpc.status.UNAUTHENTICATED,
+          message: `Authentication failed: ${verification.error}`,
+        };
+      }
+
+      // Add service ID to call context for potential use by handlers
+      call.serviceId = verification.serviceId;
+    };
+  }
+
+  /**
+   * Validates an incoming gRPC call's authentication
+   * This is a helper method for manual authentication validation
+   * @param {object} call - gRPC call object
+   * @returns {object} Verification result with isValid, serviceId, and error properties
+   */
+  validateCall(call) {
+    try {
+      const metadata = call.metadata;
+      const authHeaders = metadata.get("authorization");
+
+      if (!authHeaders || authHeaders.length === 0) {
+        return {
+          isValid: false,
+          serviceId: null,
+          error: "Missing authentication token",
+        };
+      }
+
+      const authHeader = authHeaders[0];
+      const tokenMatch = authHeader.match(/^Bearer\s+(.+)$/);
+
+      if (!tokenMatch) {
+        return {
+          isValid: false,
+          serviceId: null,
+          error: "Invalid authentication header format",
+        };
+      }
+
+      const token = tokenMatch[1];
+      return this.#authenticator.verifyToken(token);
+    } catch (error) {
+      return {
+        isValid: false,
+        serviceId: null,
+        error: `Authentication validation failed: ${error.message}`,
+      };
+    }
+  }
+}

package/base.js

@@ -0,0 +1,126 @@
+import grpc from "@grpc/grpc-js";
+
+import { createObserver } from "@forwardimpact/libtelemetry";
+
+import { Interceptor, HmacAuth } from "./auth.js";
+import { definitions } from "./generated/definitions/exports.js";
+
+/**
+ * Capitalize first letter of a string
+ * @param {string} str - String to capitalize
+ * @returns {string} Capitalized string
+ */
+export function capitalizeFirstLetter(str) {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}
+
+/**
+ * Default grpc factory that creates gRPC dependencies
+ * @returns {object} Object containing grpc
+ */
+export function createGrpc() {
+  return { grpc };
+}
+
+/**
+ * Default auth factory that creates authentication interceptor
+ * @param {string} serviceName - Name of the service for the interceptor
+ * @returns {Interceptor} Configured interceptor instance
+ */
+export function createAuth(serviceName) {
+  const secret = process.env.SERVICE_SECRET;
+  if (!secret) {
+    throw new Error(
+      `SERVICE_SECRET environment variable is required for service ${serviceName}`,
+    );
+  }
+  return new Interceptor(new HmacAuth(secret), serviceName);
+}
+
+export { createObserver } from "@forwardimpact/libtelemetry";
+
+/**
+ * Base class for both Server and Client with shared gRPC functionality
+ */
+export class Rpc {
+  #grpc;
+  #auth;
+  #observer;
+
+  /**
+   * Creates a new Rpc instance
+   * @param {object} config - Configuration object
+   * @param {object} [logger] - Optional logger instance
+   * @param {import("@forwardimpact/libtelemetry").Tracer} [tracer] - Optional tracer for distributed tracing
+   * @param {(serviceName: string, logger: object, tracer: object) => object} observerFn - Observer factory
+   * @param {() => {grpc: object}} grpcFn - gRPC factory
+   * @param {(serviceName: string) => object} authFn - Auth factory
+   */
+  constructor(
+    config,
+    logger = null,
+    tracer = null,
+    observerFn = createObserver,
+    grpcFn = createGrpc,
+    authFn = createAuth,
+  ) {
+    if (!config) throw new Error("config is required");
+    if (typeof observerFn !== "function")
+      throw new Error("observerFn must be a function");
+    if (typeof grpcFn !== "function")
+      throw new Error("createGrpc must be a function");
+    if (typeof authFn !== "function")
+      throw new Error("createAuth must be a function");
+
+    this.config = config;
+
+    // Initialize gRPC dependencies
+    const { grpc } = grpcFn();
+    this.#grpc = grpc;
+
+    // Setup authentication
+    this.#auth = authFn(this.config.name);
+
+    // Create observer with logger and tracer
+    this.#observer = observerFn(this.config.name, logger, tracer);
+  }
+
+  /**
+   * Returns the gRPC instance
+   * @returns {object} gRPC instance
+   */
+  grpc = () => this.#grpc;
+
+  /**
+   * Returns the auth instance
+   * @returns {object} Auth instance
+   */
+  auth = () => this.#auth;
+
+  /**
+   * Returns the observer instance
+   * @returns {object} Observer instance
+   */
+  observer = () => this.#observer;
+
+  /**
+   * Returns the tracer instance
+   * @returns {object} Tracer instance
+   */
+  tracer = () => this.#observer.tracer();
+
+  /**
+   * Get pre-compiled service definition
+   * @param {string} serviceName - Service name (e.g., "Agent", "Vector")
+   * @returns {object} Pre-compiled service definition
+   */
+  getServiceDefinition(serviceName) {
+    const definition = definitions[serviceName.toLowerCase()];
+    if (!definition) {
+      throw new Error(
+        `Service definition for ${serviceName} not found. Available: ${Object.keys(definitions).join(", ")}`,
+      );
+    }
+    return definition;
+  }
+}