Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tuckn/wshsmbconnector
The WSH (Windows Script Host) CLI that connects to SMB resources according to the schema defined in a JSON file.
https://github.com/tuckn/wshsmbconnector
cli jscript json schema smb windows wsf wsh
Last synced: about 1 month ago
JSON representation
The WSH (Windows Script Host) CLI that connects to SMB resources according to the schema defined in a JSON file.
- Host: GitHub
- URL: https://github.com/tuckn/wshsmbconnector
- Owner: tuckn
- License: mit
- Created: 2020-05-24T01:11:26.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-25T22:12:47.000Z (about 1 year ago)
- Last Synced: 2024-05-02T03:04:10.565Z (9 months ago)
- Topics: cli, jscript, json, schema, smb, windows, wsf, wsh
- Language: JavaScript
- Homepage: https://tuckn.net/docs/WshSmbConnector/
- Size: 386 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# WshSmbConnector
The WSH (Windows Script Host) CLI that connects to SMB resources according to the schema defined in a JSON file.
## Operating environment
Works on JScript in Windows.
## Installation
Download this ZIP and unzip or Use the following `git` command.
```console
D:\> git clone https://github.com/tuckn/WshSmbConnector.git
D:\> cd WshSmbConnector
```
Now suppose your directory structure looks like this.
```console
D:\WshSmbConnector\
├─ .wsh\
│ └─ settings.json
└─ dist\
├─ Run.wsf
└─ bundle.js
```
## Usage
### Write Schema JSON
The JSON default path to load is _%CD%\.wsh\\settings.json_.
See _.\\.wsh\\settings.json_ as example.
Write your connection schema in the JSON file, for example,
```json
{
"smbConnectorSchema": {
"tasks": {
"home": {
"comp": "11.22.33.44",
"share": "Public",
"user": "user1",
"pwd": "user p@ss"
},
"office": {
"comp": "SV12345",
"share": "IPC$",
"domain": "ID123456",
"user": "user1",
"pwd": "user p@ss"
}
}
}
}
```
You can also define variables into `components` object.
The defined variable can be used as `${valName}` in `tasks`.
```json
{
"smbConnectorSchema": {
"components": {
"myUser": "user1",
"myPass": null
},
"tasks": {
"home": {
"comp": "11.22.33.44",
"share": "Public",
"user": "${myUser}",
"pwd": "${myPass}"
},
"office": {
"comp": "SV12345",
"share": "IPC$",
"domain": "ID123456",
"user": "${myUser}",
"pwd": "${myPass}"
}
}
}
}
```
The values specified as `null` in `components` must be specified CLI arguments.
### Run with WSH
```console
> cscript .\dist\Run.wsf schemaConnect * "myPass:user p@ss"
```
```console
[2020-08-01T06:50:28] info taskName: "*"
[2020-08-01T06:50:28] info matched tasks: 2
[2020-08-01T06:50:28] info Start the function smbcn.connectSyncSurelyUsingLog
[2020-08-01T06:50:28] info Start the task: home
[2020-08-01T06:50:28] info Connecting to "11.22.33.44"
[2020-08-01T06:50:28] info shareName: "Public"
[2020-08-01T06:50:28] info domain: "", user: "user1"
[2020-08-01T06:50:28] info password: "****"
[2020-08-01T06:50:28] info throws: false
[2020-08-01T06:50:28] success Succeeded the connecting!
[2020-08-01T06:50:28] info Finished the function smbcn.connectSyncSurelyUsingLog
[2020-08-01T06:50:28] info Start the task: office
[2020-08-01T06:50:28] info Connecting to "SV12345"
[2020-08-01T06:50:28] info shareName: "IPC$"
[2020-08-01T06:50:28] info domain: "ID123456", user: "user1"
[2020-08-01T06:50:28] info password: "****"
[2020-08-01T06:50:28] info throws: false
[2020-08-01T06:50:28] success Succeeded the connecting!
[2020-08-01T06:50:28] info Finished the function smbcn.connectSyncSurelyUsingLog
```
Specify any tasks to run with property names.
```console
> cscript .\dist\Run.wsf schemaConnect "home" "myPass:user p@ss"
```
```console
[2020-08-01T06:50:28] info taskName: "home"
[2020-08-01T06:50:28] info matched tasks: 1
[2020-08-01T06:50:28] info Start the function smbcn.connectSyncSurelyUsingLog
[2020-08-01T06:50:28] info Start the task: home
[2020-08-01T06:50:28] info Connecting to "11.22.33.44"
[2020-08-01T06:50:28] info shareName: "Public"
[2020-08-01T06:50:28] info domain: "", user: "user1"
[2020-08-01T06:50:28] info password: "****"
[2020-08-01T06:50:28] info throws: false
[2020-08-01T06:50:28] success Succeeded the connecting!
[2020-08-01T06:50:28] info Finished the function smbcn.connectSyncSurelyUsingLog
```
Show the help.
```console
> cscript .\dist\Run.wsf schemaConnect --help
```
```console
Usage: schemaConnect [overwriteKey:val...] [options]
The command to connect a Windows to resources with the schema
Options:
-V, --version Output the version number
-D, --dir-path The path name where the schema JSON is located. or "cwd", "portable", "userProfile". Default: "cmd" is "%CD%\\.wsh"
-F, --file-name A JSON file name. (default: "settings.json")
-E, --encoding The JSON file encoding. (default: "utf-8")
-N, --prop-name A property name of the schema object. (default: "smbConnectorSchema")
-L, --logger /. e.g. "warn/popup". (default: "info/console")
-H, --has-result Show a result(net use) (default: false)
-R, --dry-run No execute. Outputs the string of command. (default: false)
-h, --help Output usage information
```
See [Wsh.ConfigStore](https://tuckn.net/docs/WshConfigStore/) for the options `--dir-path` and `--file-name`.
and see [Wsh.Logger](https://tuckn.net/docs/WshLogger/) for the options `--logger`.
## Installation as Module
(1) Create a directory of your WSH project.
```console
D:\> mkdir MyWshProject
D:\> cd MyWshProject
```
(2) Download this ZIP and unzip or Use the following `git` command.
```console
> git clone https://github.com/tuckn/WshSmbConnector.git ./WshModules/WshSmbConnector
or
> git submodule add https://github.com/tuckn/WshSmbConnector.git ./WshModules/WshSmbConnector
```
(3) Include _.\\WshSmbConnector\\dist\\bundle.js_ into your .wsf file.
For Example, if your file structure is
```console
D:\MyWshProject\
├─ Run.wsf
├─ MyScript.js
└─ WshModules\
└─ WshSmbConnector\
└─ dist\
└─ bundle.js
```
The content of the above _Run.wsf_ is
```xml
```
I recommend this WSH file (.wsf) encoding to be UTF-8 [BOM, CRLF].
### Together with another Apps
If you want to use it together with another Apps, install as following
```console
> git clone https://github.com/tuckn/WshBasicPackage.git ./WshModules/WshBasicPackage
> git clone https://github.com/tuckn/WshSmbConnector.git ./WshModules/WshSmbConnector
> git clone https://github.com/tuckn/WshDirBackUpper.git ./WshModules/WshDirBackUpper
or
> git submodule add https://github.com/tuckn/WshBasicPackage.git ./WshModules/WshBasicPackage
> git submodule add https://github.com/tuckn/WshSmbConnector.git ./WshModules/WshSmbConnector
> git submodule add https://github.com/tuckn/WshDirBackUpper.git ./WshModules/WshDirBackUpper
```
```xml
```
## Usage as Module
Now _.\\MyScript.js_ (JScript ) can use `Wsh.SmbConnector`.
Connecting and logging
```js
var smbcn = Wsh.SmbConnector; // Shorthand
var comp = '11.22.33.44';
var share = 'public';
var domain = 'PCNAME';
var user = 'UserId';
var pwd = 'My * P@ss><';
smbcn.connectSyncSurelyUsingLog(comp, share, domain, user, pwd, {
logger: 'warn/winEvent', // See https://github.com/tuckn/WshLogger
showsResult: true
});
```
Schema Connecting
```js
var smbcn = Wsh.SmbConnector; // Shorthand
var schema = {
smbConnectorSchema: {
components: {
myUser: 'user1',
myPass: null
},
tasks: {
home: {
comp: '11.22.33.44',
share: 'Public',
user: '${myUser}',
pwd: '${myPass}'
},
office: {
comp: 'SV12345',
share: 'IPC$',
domain: 'ID123456',
user: '${myUser}',
pwd: '${myPass}'
}
}
}
};
smbcn.connectSyncUsingSchema(schema, '*', {
logger: 'info/console',
overwrites: { myPass: 'user p@ss' },
isDryRun: true
});
```
### Dependency Modules
You can also use [tuckn/WshBasicPackage](https://github.com/tuckn/WshBasicPackage) functions in _.\\MyScript.js_ (JScript).
## Documentation
See all specifications [here](https://tuckn.net/docs/WshSmbConnector/) and also [WshBasicPackage](https://tuckn.net/docs/WshBasicPackage/).
## License
MIT
Copyright (c) 2020 [Tuckn](https://github.com/tuckn)