@crossauth/fastify 0.0.2

package/LICENSE

@@ -0,0 +1,203 @@
+
+                                 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 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 [yyyy] [name of copyright owner]
+
+   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/README.md

@@ -0,0 +1,12 @@
+Crossauth common
+================
+
+Copyright (c) 2024 Matthew Baker
+
+Crossauth is a cross platform package for authentication.
+It has a Typescript version and soon also a Python and
+Scala/Java version.  At the moment it is not ready for
+public use, though the Typescript version is ready to
+be used by authorized developers.
+
+This is the version for fastidfy (backend)

package/dist/fastifyadminclientendpoints.d.ts

@@ -0,0 +1,149 @@
+import { OAuthClient } from '@crossauth/common';
+import { FastifySessionServer, FastifySessionServerOptions, CsrfBodyType } from './fastifysession';
+import { OAuthClientStorage } from '@crossauth/backend';
+
+/**
+ * The `selectclient` and `admin/selectclient` endpoints have a customisable
+ * function for searching for a client.  This is the default
+ * @param searchTerm the search term passed in the query string
+ * @param clientStorage the client storage to search
+ * @param userid the user id to se3arch for, or null for clients not owned
+ *        by a user
+ * @returns An array of matching {@link @crossauth/common!OAuthClient} objects,
+ */
+export declare function defaultClientSearchFn(searchTerm: string, clientStorage: OAuthClientStorage, userid?: string | number | null): Promise<OAuthClient[]>;
+/**
+ * The query type for Fastify selectclient requests,
+ */
+export interface SelectClientQueryType {
+    userid?: string | number;
+    next?: string;
+    search?: string;
+    user?: string | number;
+    skip?: number;
+    take?: number;
+    haveNext?: boolean;
+    havePrevious?: boolean;
+}
+/**
+ * The query type for Fastify createclient requests,
+ */
+export interface CreateClientQueryType {
+    next?: string;
+    userid?: string | number;
+}
+/**
+ * The body type for Fastify selectclient requests,
+ */
+export interface CreateClientBodyType extends CsrfBodyType {
+    client_name: string;
+    confidential?: string;
+    userid?: string | number | null;
+    redirect_uris: string;
+    authorizationCode?: string;
+    authorizationCodeWithPKCE?: string;
+    clientCredentials?: string;
+    refreshToken?: string;
+    deviceCode?: string;
+    password?: string;
+    passwordMfa?: string;
+    oidcAuthorizationCode?: string;
+    next?: string;
+}
+/**
+ * The query type for Fastify updateclient requests,
+ */
+export interface UpdateClientQueryType {
+    next?: string;
+}
+/**
+ * The body type for Fastify updateclient requests,
+ */
+export interface UpdateClientBodyType extends CsrfBodyType {
+    client_name: string;
+    confidential?: string;
+    userid?: string | number | null;
+    redirect_uris: string;
+    authorizationCode?: string;
+    authorizationCodeWithPKCE?: string;
+    clientCredentials?: string;
+    refreshToken?: string;
+    deviceCode?: string;
+    password?: string;
+    passwordMfa?: string;
+    oidcAuthorizationCode?: string;
+    next?: string;
+    resetSecret?: string;
+}
+/**
+ * The param type for Fastify deleteclient requests,
+ */
+export interface DeleteClientParamType {
+    client_id: string;
+}
+/**
+ * The param type for Fastify updateclient requests,
+ */
+export interface UpdateClientParamType {
+    client_id: string;
+}
+/**
+ * The query type for Fastify deleteclient requests,
+ */
+export interface DeleteClientQueryType {
+    next?: string;
+}
+/**
+ * This class adds admin endpoints for manipulating OAuth clients.
+ *
+ * It is not intended to be instantiated directly.  It is created
+ * by {@link FastifySessionServer} if admin endpoints and oauth endpoints
+ * are enabled.
+ *
+ * For endpoints, see {@link FastifyAdminEndpoints}.
+ */
+export declare class FastifyAdminClientEndpoints {
+    private sessionServer;
+    private clientStorage;
+    private clientManager;
+    private adminPrefix;
+    private clientSearchFn;
+    private validFlows;
+    private selectClientPage;
+    private createClientPage;
+    private updateClientPage;
+    private deleteClientPage;
+    constructor(sessionServer: FastifySessionServer, options?: FastifySessionServerOptions);
+    /**
+     * Adds the `admin/selectclient` GET endpoint.
+     */
+    addSelectClientEndpoints(): void;
+    /**
+     * Adds the `admin/createclient` GET and POST endpoints.
+     */
+    addCreateClientEndpoints(): void;
+    /**
+     * Adds the `admin/updateclient` GET and POST endpoints.
+     */
+    addUpdateClientEndpoints(): void;
+    /**
+     * Adds the `admin/deleteclient` GET and POST endpoints.
+     */
+    addDeleteClientEndpoints(): void;
+    /**
+     * Adds the `admin/api/createclient` POST endpoint.
+     */
+    addApiCreateClientEndpoints(): void;
+    /**
+     * Adds the `admin/api/updateclient` POST endpoint.
+     */
+    addApiUpdateClientEndpoints(): void;
+    /**
+     * Adds the `admin/api/deleteclient` POST endpoint.
+     */
+    addApiDeleteClientEndpoints(): void;
+    private accessDeniedPage;
+    private createClient;
+    private updateClient;
+    private deleteClient;
+}

package/dist/fastifyadminendpoints.d.ts

@@ -0,0 +1,126 @@
+import { FastifySessionServer, FastifySessionServerOptions, CsrfBodyType, SignupBodyType } from './fastifysession';
+
+export interface AdminCreateUserBodyType extends SignupBodyType {
+}
+export interface UserParamType {
+    id: string | number;
+}
+/**
+ * Body parameters for the admin update user endpoint
+ */
+export interface AdminUpdateUserBodyType {
+    username: string;
+    [key: string]: any;
+}
+/**
+ * Body parameters for the admin change password endpoint
+ */
+export interface AdminChangePasswordBodyType extends CsrfBodyType {
+    oldPassword: string;
+    newPassword: string;
+    repeatPassword?: string;
+    next?: string;
+    required?: boolean;
+}
+/**
+ * URL parameters for the admin delete user endpoint
+ */
+export interface AdminDeleteUserParamType {
+    id: string | number;
+}
+export interface DeleteUserQueryType {
+    next?: string;
+}
+/**
+ * This class adds admin endpoints to the Fastidfy session server
+ *
+ * This clas is not intended to be created directly.  It is created by
+ * {@link FastifySessionServer} if admin endpoints are enabled.
+ *
+ * **Endpoints that can be activated**
+ *
+ * All page POST methods are passed user, csrfToken, errorCode, errorCodeName, errorMessage, errorMessages, urlPrefix,
+ * errorMessages is an array, errorMessage is a single value or concatenation of errorMessages.
+ *
+ * All JSON responses have ok, errorMessage, errorMEssages, errorCode, errorCodeName, other than OAuth endpoints.
+ *
+ * | METHOD | ENDPOINT                   | PATH PARAMS | GET/BODY PARAMS                                                      | VARIABLES PASSED/RESPONSE JSON                                                                         | FILE                     |
+ * | ------ | -------------------------- | ----------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------ |
+ * | GET    | /admin/createuser          |             | next                                                                 | next, allowedFactor2                                                                                   | adminCreateUserPage      |
+ * | POST   | /admin/createuser          |             | next, persist, username, password, repeat_password, factor2, user_*  | message, next, username, factor2, allowedFactor2                                                       | adminCreateUserPage      |
+ * | POST   | /admin/api/createuser      |             | next, persist, username, password, repeat_password, factor2, user_*  | message, next, username, factor2, allowedFactor2                                                       | adminCreateUserPage      |
+ * | GET    | /admin/selectuser          |             | next, search, skip, take, haveNext, havePrevious                     | next, search, skip, take, haveNext, havePrevious                                                       | adminSelectUserPage      |
+ * | GET    | /admin/changepassword      | id          | next, required                                                       | next, required, user                                                                                   | adminChangePasswordPage  |
+ * | POST   | /admin//changepassword     | id          | next, required, old_password, new_password, repeat_password          | next, required, user, message                                                                          | adminChangePasswordPage  |
+ * | POST   | /admin//api/changepassword | id          | old_password, new_password, repeat_password                          |                                                                                                        |                          |
+ * | GET    | /admin/updateuser          | id          |                                                                      | user, allowedFactor2, enableOAuthClientManagement                                                      | updatePasswordPage       |
+ * | POST   | /admin/updateuser          | id          | user_*, factor2, status                                              | message, user_*, allowedFactor2, enableOAuthClientManagement                                           | updatePasswordPage       |
+ * | POST   | /admin/api/updateuser      |             | user_*                                                               | emailVerificationRequired                                                                              |                          |
+ * | GET    | /admin/deleteuser          | id          | next                                                                 | next, isAdmin, user                                                                                    | deleteUserPAge           |
+ * | POST   | /admin/deleteuser          | id          | next                                                                 | message, next isAdmin, userid                                                                          | deleteUserPAge           |
+ * | POST   | /admin/api/deleteuser      | id          |                                                                      |                                                                                                        |                          |
+ * | GET    | /selectclient              |             | next, search, skip, take, haveNext, havePrevious, userid             | next, search, skip, take, haveNext, havePrevious, user, clients, isAdmin                               | selectClient             |
+ * | GET    | /createclient              |             | next, userid                                                         | next, validFLows, flowNames, user, isAdmin                                                             | createClientPage         |
+ * | POST   | /createclient              |             | next, client_name, confidential, redirect_uris, (flows), userid        | message, client, next, validFLows, flowNames, user, isAdmin                                            | createClientPage         |
+ * | POST   | /api/createclient          |             | client_name, confidential, redirect_uris, (flows), userid              | client                                                                                                 |                          |
+ * | GET    | /updateclient              | client_id    | next                                                                 | next, validFLows, flowNames, selectedFlows, redirect_uris, client_id, client_name, user, isAdmin          | updateClientPage         |
+ * | POST   | /updateclient              | client_id    | next, client_name, confidential, redirect_uris, (flows), resetSecret   | message, next, validFLows, flowNames, selectedFlows, redirect_uris, client_id, client_name, user, isAdmin | updateClientPage         |
+ * | POST   | /api/updateclient          | client_id    | client_name, confidential, redirect_uris, (flows), resetSecret         | client, newSecret                                                                                      |                          |
+ * | GET    | /deleteclient              | client_id    | next, backUrl                                                        | next, backUrl, client                                                                                  | deleteClientPage         |
+ * | POST   | /deleteclient              | client_id    | next                                                                 | message, next, client_id                                                                                | deleteClientPage         |
+ * | POST   | /api/deleteclient          | client_id    |                                                                      |                                                                                                        |                          |
+ *
+*/
+export declare class FastifyAdminEndpoints {
+    private sessionServer;
+    private adminPrefix;
+    private userSearchFn;
+    private enableOAuthClientManagement;
+    private adminCreateUserPage;
+    private adminSelectUserPage;
+    private adminUpdateUserPage;
+    private adminChangePasswordPage;
+    private deleteUserPage;
+    constructor(sessionServer: FastifySessionServer, options?: FastifySessionServerOptions);
+    /**
+     * Adds the `admin/createuser` GET and POST endpoints.
+     */
+    addCreateUserEndpoints(): void;
+    /**
+     * Adds the `admin/api/createuser` POST endpoint.
+     */
+    addApiCreateUserEndpoints(): void;
+    /**
+     * Adds the `admin/selectuser` GET and endpoint.
+     */
+    addSelectUserEndpoints(): void;
+    /**
+     * Adds the `admin/updateuser` GET and POST endpoints.
+     */
+    addUpdateUserEndpoints(): void;
+    /**
+     * Adds the `admin/deleteuser` GET and POST endpoints.
+     */
+    addDeleteUserEndpoints(): void;
+    /**
+     * Adds the `admin/api/updateuser` POST endpoint.
+     */
+    addApiUpdateUserEndpoints(): void;
+    /**
+     * Adds the `admin/changepassword` GET and POST endpoints.
+     */
+    addChangePasswordEndpoints(): void;
+    /**
+     * Adds the `admin/api/changepassword` POST endpoint.
+     */
+    addApiChangePasswordEndpoints(): void;
+    /**
+     * Adds the `admin/api/deleteuser` POST endpoint.
+     */
+    addApiDeleteUserEndpoints(): void;
+    private createUser;
+    private accessDeniedPage;
+    private updateUser;
+    private changePassword;
+    private deleteUser;
+}

package/dist/fastifyapikey.d.ts

@@ -0,0 +1,42 @@
+import { FastifyInstance } from 'fastify';
+import { Server, IncomingMessage, ServerResponse } from 'http';
+import { UserStorage, KeyStorage, ApiKeyManagerOptions } from '@crossauth/backend';
+
+/**
+ * Options for {@link FastifyApiKeyServer }.
+ *
+ * See {@link FastifyApiKeyServer } constructor for description of parameters
+ */
+export interface FastifyApiKeyServerOptions extends ApiKeyManagerOptions {
+    /** You can pass your own fastify instance or omit this, in which case
+     *  Crossauth will create one */
+    app?: FastifyInstance<Server, IncomingMessage, ServerResponse>;
+}
+/**
+ * This class adds API key functionality to the Fatify server.
+ *
+ * You shouldn't have to instantiate this directly.  It is created
+ * when instantiating {@link FastifyServer} if enabling API key support-
+ *
+ * API keys are bearer tokens than have to be manually created for a user.
+ * They can be used in place of username/password login and session cookies.
+ *
+ * This class adds a `preHandler` hook that sets the `user` field in the
+ * Fastify request.  It also sets `scopes` in the request object if there
+ * is a `scope` field in the JSON object in the `data` field in in the API
+ * record in key storage.
+ */
+export declare class FastifyApiKeyServer {
+    private app;
+    private userStorage;
+    private apiKeyManager;
+    /**
+     * Constructor
+     *
+     * @param app the Fastify app instance
+     * @param userStorage the user storage with user accounts
+     * @param keyStorage the storage for finding API keys
+     * @param options See {@link FastifyApiKeyServerOptions}
+     */
+    constructor(app: FastifyInstance<Server, IncomingMessage, ServerResponse>, userStorage: UserStorage, keyStorage: KeyStorage, options?: FastifyApiKeyServerOptions);
+}