pv-node-smb2
TypeScript icon, indicating that this package has built-in type declarations

2.0.6 • Public • Published

SMB2 Client for Node.js

Node compatibility License PackagePhobia

Package Version Latest Commit

Introduction

This library calls the C libraries for libsmbclient to read and search through directories.

The original fork was unable to connect to newer servers, and rather than hacking about with the smb2 protocol, it is far easier to leverage the great work of the samba team, and use their libsmbclient library via NAPI bindings. This is much quicker than other wrappers that fork/exec smbclient, and the only OS pre-req (on Linux) is to install the libsmbclient-dev package.

Installation

npm install -S pv-node-smb2

API

Asynchronicity

No async calls supported yet; there's a skeleton for a read function, but much more work is still needed.

Sync calls

import {PvDirent,PvNodeSmb2} from 'pv-node-smb2'

const smb2Client = new PvNodeSmb2('workgroup', 'user', 'password')

const content = await smb2Client.readFileSync('smb://<host or IP>/Windows Path/goes/here/foo.txt')
console.log(content.toString('base64')

Connection management

Each instance of the PvNodeSmb2 class will have its own connection.

Contributors

References

The[MS-SMB2]: Server Message Block (SMB) Protocol Versions 2 and 3
Copyright (C) 2014 Microsoft
http://msdn.microsoft.com/en-us/library/cc246482.aspx

License

(The MIT License)

Copyright (c) 2013-2014 Benjamin Chelli <benjamin@chelli.net>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Package Sidebar

Install

npm i pv-node-smb2

Weekly Downloads

10

Version

2.0.6

License

MIT

Unpacked Size

147 kB

Total Files

16

Last publish

Collaborators

  • pontusvision