wechaty-token

wechaty-token

Wechaty Token Based Authentication Manager

Install

npm install -g wechaty-token

CLI Usage

$ wechaty-token --help

wechaty-token <subcommand>
> Wechaty utility for discovering and generating tokens

where <subcommand> can be one of:

- generate - Generate a new Wechaty Token
- discover - Wechaty TOKEN Service Discovery

For more help, try running `wechaty-token <subcommand> --help`

Wechaty Token Discovery

$ wechaty-token discover --help

wechaty-token discover
> Wechaty TOKEN Service Discovery

ARGUMENTS:
  <str> - Wechaty Puppet Service TOKEN

FLAGS:
  --help, -h - show help

Example:

# Discover a valid token (in-service)
$ wechaty-token discover puppet_IN-SERVICE-TOKEN
{
  "host": "1.2.3.4",
  "port": 5678
}
$ echo $?
0

# Discover a unvalid token (out-of-service)
$ wechaty-token discover puppet_OUT-OF-SERVICE-TOKEN
NotFound
$ echo $?
1

Generate Wechaty Token

$ wechaty-token generate --help

wechaty-token generate
> Generate a new Wechaty Token

OPTIONS:
  --type, -t <str> - The type of the Wechaty Puppet Service [optional]

FLAGS:
  --help, -h - show help

Example:

# Generate a UUID token (`uuid` will be the default type)
$ wechaty-token generate
uuid_1fab726b-e3d3-40ce-8b7b-d3bd8c9fd280

# Generate token with type `foo`
$ wechaty-token generate --type foo
foo_1fab726b-e3d3-40ce-8b7b-d3bd8c9fd280

gRPC Resolver Usage

We now can use wechaty:///${TOKEN} as gRPC address for Wechaty Service Token Discovery.

The WechatyResolver is for resolve the above address and help gRPC to connect to the right host and port.

import { WechatyResolver } from 'wechaty-token'
WechatyResolver.setup()
// That's it! You can use `wechaty:///${TOKEN}` as gRPC address now!
// const routeguide = grpc.loadPackageDefinition(packageDefinition).routeguide;
// client = new routeguide.RouteGuide('wechaty:///${TOKEN}',
//                                     grpc.credentials.createInsecure());
// See: https://grpc.io/docs/languages/node/basics/

See:

• gRPC Name Resolution
• Wechaty Puppet Service Code

History

master v1.0 (Nov 28, 2021)

1. ES Module support
2. TypeScript 4.5
3. Wechaty Token Discovery output JSON.stringify format

v0.5 (Sep 8, 2021)

1. Wechaty Token format standard released: SNI_UUID
   1. SNI will be used as Server Indicator Name (SNI) when we are using TLS
   2. UUID is a standard UUID format (v4)
2. add wechatyToken.sni support.

v0.4 (Aug 15, 2021)

1. Use cockatiel to implement RetryPolicy
2. Use nock to implement HTTP unit testing
3. Implemented #1

v0.2 master (Aug 2, 2021)

1. wechaty-token CLI released
2. gRPC Resolver for Wechaty: Enabled xds like schema wechaty:///uuid_TOKEN for gRPC client

v0.0.1 (Aug 1, 2021)

Inited

Author

Huan LI (李卓桓), Google Developer Expert (Machine Learning), [e-mail]

Copyright & License

• Code & Docs © 2018-now Huan LI <[e-mail]>
• Code released under the Apache-2.0 License
• Docs released under Creative Commons