fanqiang 2.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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,78 @@
+# Tunnel Proxy Auto Deployment - `fanqiang`
+
+This project creates a command line tool that helps to automatically deploy a shadowsocks proxy on an AWS lightsail instance.
+
+## Prerequisites
+
+- Has **Nodejs** installed on local machine. See [download link][1] for more details.
+- Has an AWS access token. See [manage AWS access token][2] for more details.
+- Has an Aliyun access token if you want to use tunnel feature.
+
+[1]: https://nodejs.org/en/
+[2]: https://console.aws.amazon.com/iam/home#security_credential
+
+## Installation
+
+```
+npm install --global fanqiang
+```
+
+## Command Usage
+
+```
+# fanqiang <command> [options]
+
+Commands:
+  create   Create new tunnel proxy infrastructures
+  destroy  Destroy tunnel proxy infrastructures
+
+Options:
+  --region         AWS lightsail region for proxy deployment
+                                                 [string] [default: "us-east-1"]
+  --tunnel-region  Aliyun region for tunnel deployment
+                                                 [string] [default: "cn-shanghai"]
+  --help           Show help                                           [boolean]
+  --version        Show version number                                 [boolean]
+```
+
+## Setup Credentials for AWS Services
+
+You need to configure an AWS IAM user on the local machine before running any command listed above. So far, this tool
+supports reading AWS credentials from <code>Shared Credentials File</code>:
+
+- The shared credentials file on Linux, Unix, and macOS: ~/.aws/credentials
+- The shared credentials file on Windows: C:\Users\USER_NAME\.aws\credentials
+
+An example of credentials file:
+
+```
+[default]
+aws_access_key_id = <YOUR_ACCESS_KEY_ID>
+aws_secret_access_key = <YOUR_SECRET_ACCESS_KEY>
+```
+
+Refer to [AWS SDK documentation][3] for more details on how to set up an AWS credentials file.
+
+[3]: https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-shared.html
+
+## Setup Credentials for Aliyun Services
+
+You need to configure an Aliyun RAM user on a local machine if you want to use --tunnel-region option. So far, this tool
+supports reading credentials from <code>$HOME/.alibabacloud/credentials</code>:
+
+- The credentials file on Linux, Unix, and macOS: ~/.alibabacloud/credentials
+- The credentials file on Windows: C:\Users\USER_NAME\.alibabacloud\credentials
+
+An example of credentials file:
+
+```
+[default]
+enable = true
+type = access_key
+access_key_id = <YOUR_ACCESS_KEY_ID>
+access_key_secret = <YOUR_ACCESS_KEY_SECRET>
+```
+
+Refer to [Aliyun SDK documentation][4] for more details on how to set up an Aliyun credentials file.
+
+[4]: https://help.aliyun.com/document_detail/113296.html

package/bin/fanqiang.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=fanqiang.d.ts.map

package/bin/fanqiang.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fanqiang.d.ts","sourceRoot":"","sources":["fanqiang.ts"],"names":[],"mappings":""}

package/bin/fanqiang.js

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const yargs_1 = tslib_1.__importDefault(require("yargs"));
+const index_1 = tslib_1.__importDefault(require("../index"));
+async function main() {
+    await yargs_1.default(process.argv.slice(2))
+        .usage("Usage: $0 <command> [options]")
+        .options({
+        region: {
+            type: "string",
+            default: "us-east-1",
+            description: "AWS lightsail region for proxy deployment",
+        },
+        "tunnel-region": {
+            type: "string",
+            default: "cn-shanghai",
+            description: "Aliyun region for tunnel deployment",
+        },
+    })
+        .demandCommand(1)
+        .strict()
+        .command("create", "Create new tunnel proxy infrastructures", () => void 0, (args) => index_1.default.create(args.region, args["tunnel-region"]))
+        .command("destroy", "Destroy tunnel proxy infrastructures", () => void 0, index_1.default.destroy)
+        .help()
+        .version()
+        .showHelpOnFail(true).argv;
+}
+main().catch((error) => console.error(error));
+//# sourceMappingURL=fanqiang.js.map

package/bin/fanqiang.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fanqiang.js","sourceRoot":"","sources":["fanqiang.ts"],"names":[],"mappings":";;;;AAEA,0DAA0B;AAC1B,6DAAgC;AAEhC,KAAK,UAAU,IAAI;IACjB,MAAM,eAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC/B,KAAK,CAAC,+BAA+B,CAAC;SACtC,OAAO,CAAC;QACP,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,WAAW;YACpB,WAAW,EAAE,2CAA2C;SACzD;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;YACtB,WAAW,EAAE,qCAAqC;SACnD;KACF,CAAC;SACD,aAAa,CAAC,CAAC,CAAC;SAChB,MAAM,EAAE;SACR,OAAO,CACN,QAAQ,EACR,yCAAyC,EACzC,GAAG,EAAE,CAAC,KAAK,CAAC,EACZ,CAAC,IAAI,EAAE,EAAE,CAAC,eAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAC9D;SACA,OAAO,CAAC,SAAS,EAAE,sCAAsC,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,eAAQ,CAAC,OAAO,CAAC;SAC1F,IAAI,EAAE;SACN,OAAO,EAAE;SACT,cAAc,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;AAC/B,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC"}

package/bin/fanqiang.ts

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+
+import yargs from "yargs";
+import handlers from "../index";
+
+async function main(): Promise<void> {
+  await yargs(process.argv.slice(2))
+    .usage("Usage: $0 <command> [options]")
+    .options({
+      region: {
+        type: "string",
+        default: "us-east-1",
+        description: "AWS lightsail region for proxy deployment",
+      },
+      "tunnel-region": {
+        type: "string",
+        default: "cn-shanghai",
+        description: "Aliyun region for tunnel deployment",
+      },
+    })
+    .demandCommand(1)
+    .strict()
+    .command(
+      "create",
+      "Create new tunnel proxy infrastructures",
+      () => void 0,
+      (args) => handlers.create(args.region, args["tunnel-region"])
+    )
+    .command("destroy", "Destroy tunnel proxy infrastructures", () => void 0, handlers.destroy)
+    .help()
+    .version()
+    .showHelpOnFail(true).argv;
+}
+
+main().catch((error) => console.error(error));

package/index.d.ts

@@ -0,0 +1,3 @@
+import * as handlers from "./lib/handlers";
+export default handlers;
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAC;AAE3C,eAAe,QAAQ,CAAC"}

package/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const handlers = tslib_1.__importStar(require("./lib/handlers"));
+exports.default = handlers;
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AAAA,iEAA2C;AAE3C,kBAAe,QAAQ,CAAC"}

package/index.ts

@@ -0,0 +1,3 @@
+import * as handlers from "./lib/handlers";
+
+export default handlers;

package/lib/core/AwsS3CloudStorage.d.ts

@@ -0,0 +1,6 @@
+import { Bucket, CloudStorage } from "../domain/CloudStorage";
+export declare class AwsS3CloudStorage implements CloudStorage {
+    getBucket(region: string): Promise<Bucket>;
+    destroy(region: string, bucket: string): Promise<void>;
+}
+//# sourceMappingURL=AwsS3CloudStorage.d.ts.map

package/lib/core/AwsS3CloudStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AwsS3CloudStorage.d.ts","sourceRoot":"","sources":["AwsS3CloudStorage.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE9D,qBAAa,iBAAkB,YAAW,YAAY;IAC9C,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IA+B1C,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAoB7D"}

package/lib/core/AwsS3CloudStorage.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AwsS3CloudStorage = void 0;
+const client_s3_1 = require("@aws-sdk/client-s3");
+const langUtils_1 = require("./langUtils");
+class AwsS3CloudStorage {
+    async getBucket(region) {
+        const bucket = `fanqiang${Date.now()}`;
+        await runWithClient(region, async (client) => {
+            try {
+                await client.send(new client_s3_1.GetBucketLocationCommand({ Bucket: bucket }));
+            }
+            catch (e) {
+                if (e.name !== "NoSuchBucket") {
+                    throw e;
+                }
+                await client.send(new client_s3_1.CreateBucketCommand({ Bucket: bucket, ACL: "public-read" }));
+            }
+        });
+        return {
+            name: bucket,
+            save: async (objectKey, content) => {
+                await runWithClient(region, (client) => client.send(new client_s3_1.PutObjectCommand({
+                    Bucket: bucket,
+                    Key: objectKey,
+                    Body: content,
+                    ACL: "public-read",
+                })));
+                return `http://${bucket}.s3.amazonaws.com/${objectKey}`;
+            },
+        };
+    }
+    async destroy(region, bucket) {
+        await runWithClient(region, (client) => langUtils_1.invokeIgnoreError(async () => {
+            const keys = await listObjectKeys(bucket, client);
+            if (keys.length) {
+                await client.send(new client_s3_1.DeleteObjectsCommand({
+                    Bucket: bucket,
+                    Delete: { Objects: keys.map((k) => ({ Key: k })) },
+                }));
+            }
+            await client.send(new client_s3_1.DeleteBucketCommand({ Bucket: bucket }));
+        }, "NoSuchBucket", "Bucket does not exists: " + bucket));
+    }
+}
+exports.AwsS3CloudStorage = AwsS3CloudStorage;
+async function runWithClient(region, executeFunc) {
+    const client = new client_s3_1.S3Client({ region });
+    try {
+        return await executeFunc(client);
+    }
+    finally {
+        client.destroy();
+    }
+}
+async function listObjectKeys(Bucket, client) {
+    var _a;
+    let response;
+    const params = { Bucket };
+    const objectKeys = [];
+    do {
+        response = await client.send(new client_s3_1.ListObjectsV2Command(params));
+        if (response.KeyCount) {
+            objectKeys.push(...langUtils_1.nonNullArray((_a = response.Contents) === null || _a === void 0 ? void 0 : _a.map((c) => c.Key)));
+        }
+        params.ContinuationToken = response.NextContinuationToken;
+    } while (response.IsTruncated);
+    return objectKeys;
+}
+//# sourceMappingURL=AwsS3CloudStorage.js.map