Node.js ligthweight module for generating and parsing shadosocks links with no dependencies.
npm install shadowsocks-link-generator
# Or
yarn add shadowsocks-link-generatorInitialize new intstance
const ssUrl = require('shadowsocks-link-generator')
// If use typescript or ESM
import ssUrl from 'shadowsocks-link-generator'Use .genSS() with shadowsocks parameters, what returns full ss link.
const myUrl = ssUrl.genSS({
server: '8.8.8.8',
server_port: 8388,
password: 'mypassword',
method: 'aes-256-cfb',
plugin: 'obfs-plugin',
plugin_param: '',
name: 'my server'
})
console.log(myUrl)
// ss://[email protected]:8388#my%20serverAlso use .genSSR() with shadowsocks parameters, what returns full ssr link.
const myUrl = ssUrl.genSSR({
server: "77.88.8.8",
server_port: 8388,
password: 'mysecretpassword123',
method: 'chacha20',
name: 'my server',
protocol: 'plain',
protocol_param: '',
obfs: 'http_simple',
obfs_param: 'someparams',
group: 'My server list' // Group is used in the shadowsocksR application
})
console.log(myUrl)
// ssr://NzcuODguOC44OjgzODg6cGxhaW46Y2hhY2hhMjA6YUhSMGNGOXphVzF3YkdVPTpteXNlY3JldHBhc3N3b3JkMTIzLz9vYmZzcGFyYW09YzI5dFpYQmhjbUZ0Y3c9PSZwcm90b3BhcmFtPSZyZW1hcmtzPWJYa2djMlZ5ZG1WeSZncm91cD1UWGtnYzJWeWRtVnlJR3hwYzNRPQ==For both links, you can use .parseSS() and .parseSSR() method, what returns an object with parameters.
const myUrl = 'ss://YWVzLTI1Ni1jZmI6bXlwYXNzd29yZA==@my_server_ip:8388#my%20server'
const myUrlParsed = ssUrl.parseSS(myUrl)
console.log(myUrlParsed)
/*{
method: 'aes-256-cfb',
password: 'mypassword',
server: 'my_server_ip',
server_port: '8388',
name: 'my server'
}*/const myUrl = 'ssr://NzcuODguOC44OjgzODg6cGxhaW46Y2hhY2hhMjA6YUhSMGNGOXphVzF3YkdVPTpteXNlY3JldHBhc3N3b3JkMTIzLz9vYmZzcGFyYW09YzI5dFpYQmhjbUZ0Y3c9PSZwcm90b3BhcmFtPSZyZW1hcmtzPWJYa2djMlZ5ZG1WeSZncm91cD1UWGtnYzJWeWRtVnlJR3hwYzNRPQ=='
const myUrlParsed = ssUrl.parseSSR(myUrl)
console.log(myUrlParsed)
/*
{
server: '77.88.8.8',
server_port: '8388',
protocol: 'plain',
method: 'chacha20',
obfs: 'http_simple',
password: 'mysecretpassword123',
name: 'my server',
obfs_param: 'someparams',
protocol_param: '',
group: 'My server list'
}
*/You can import configs type using typescript
import { SsConfig, SsrConfig } from 'shadowsocks-link-generator'name is used in shadowsocks mobile app
type SsConfig = {
server: string
server_port: number
password: string
method: string
name?: string
plugin?: string
plugin_param?: string
}
type SsrConfig = {
server: string
server_port: number
password: string
method: string
name?: string
protocol: string
protocol_param?: string
obfs: string
obfs_param?: string
group?: string
}