Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

smb1

package module

Go to main page

Versions in this module

v1

v1.0.1

Jul 21, 2026

v1.0.0

Jul 19, 2026

v0

v0.1.0

Jul 19, 2026

Changes in this version

+ const MaxReadSizeLimit

+ const PathSeparator

+ var ErrBadPattern = errors.New("syntax error in pattern")

+ var ErrPoolClosed = errors.New("connection pool is closed")

+ var ErrPoolExhausted = errors.New("connection pool exhausted")

+ var NORMALIZE_PATH = true

+ func FileAttributesToUnixMode(attrs uint32) os.FileMode

+ func FileTimeToTime(ft uint64) time.Time

+ func IsArchiveFile(attrs uint32) bool

+ func IsAuthError(err error) bool

+ func IsExistError(err error) bool

+ func IsHiddenFile(name string, attrs uint32) bool

+ func IsNetworkError(err error) bool

+ func IsNotFoundError(err error) bool

+ func IsPathSeparator(c uint8) bool

+ func IsPermissionError(err error) bool

+ func IsSystemFile(attrs uint32) bool

+ func IsTemporary(err error) bool

+ func IsTimeoutError(err error) bool

+ func Match(pattern, name string) (matched bool, err error)

+ func NormalizeShareName(shareName, serverAddr string) string

+ func TimeToFileTime(t time.Time) uint64

+ func ToUnixPath(path string) string

+ func ToWindowsPath(path string) string

+ func UnixModeToFileAttributes(mode os.FileMode) uint32

+ func ValidateShareName(name string) error

+ func WithLogger(ctx context.Context, logger Logger) context.Context

+ type AuthenticationError struct

+ Domain string

+ Reason string

+ User string

+ func (e *AuthenticationError) Error() string

+ type Client = Session

+ type ConnectionError struct

+ Err error

+ Op string

+ func (e *ConnectionError) Error() string

+ func (e *ConnectionError) Unwrap() error

+ type ConnectionPool struct

+ func NewConnectionPool(serverAddr string, dialer *Dialer, config *PoolConfig) *ConnectionPool

+ func (p *ConnectionPool) Close() error

+ func (p *ConnectionPool) Get(ctx context.Context) (*PooledSession, error)

+ func (p *ConnectionPool) Stats() PoolStats

+ type ContextError struct

+ Err error

+ func (e *ContextError) Error() string

+ func (e *ContextError) Timeout() bool

+ func (e *ContextError) Unwrap() error

+ type Dialer struct

+ Initiator Initiator

+ MaxCreditBalance uint16

+ Negotiator Negotiator

+ func (d *Dialer) Dial(tcpConn net.Conn) (*Session, error)

+ func (d *Dialer) DialContext(ctx context.Context, tcpConn net.Conn) (*Session, error)

+ type File struct

+ func (f *File) Chmod(mode os.FileMode) error

+ func (f *File) Close() error

+ func (f *File) Name() string

+ func (f *File) Read(b []byte) (n int, err error)

+ func (f *File) ReadAt(b []byte, off int64) (n int, err error)

+ func (f *File) ReadFrom(r io.Reader) (n int64, err error)

+ func (f *File) Readdir(n int) ([]os.FileInfo, error)

+ func (f *File) Readdirnames(n int) (names []string, err error)

+ func (f *File) Seek(offset int64, whence int) (int64, error)

+ func (f *File) Stat() (os.FileInfo, error)

+ func (f *File) Statfs() (FileFsInfo, error)

+ func (f *File) Sync() error

+ func (f *File) Truncate(size int64) error

+ func (f *File) Write(b []byte) (n int, err error)

+ func (f *File) WriteAt(b []byte, off int64) (n int, err error)

+ func (f *File) WriteString(s string) (n int, err error)

+ func (f *File) WriteTo(w io.Writer) (n int64, err error)

+ type FileFsInfo interface

+ AvailableBlockCount func() uint64

+ BlockSize func() uint64

+ FragmentSize func() uint64

+ FreeBlockCount func() uint64

+ TotalBlockCount func() uint64

+ type FileStat struct

+ AllocationSize int64

+ ChangeTime time.Time

+ CreationTime time.Time

+ EndOfFile int64

+ FileAttributes uint32

+ FileName string

+ LastAccessTime time.Time

+ LastWriteTime time.Time

+ func (fs *FileStat) IsDir() bool

+ func (fs *FileStat) ModTime() time.Time

+ func (fs *FileStat) Mode() os.FileMode

+ func (fs *FileStat) Name() string

+ func (fs *FileStat) Size() int64

+ func (fs *FileStat) Sys() interface{}

+ type Initiator interface

+ type InternalError struct

+ Message string

+ func (e *InternalError) Error() string

+ type InvalidResponseError struct

+ Message string

+ func (e *InvalidResponseError) Error() string

+ type Logger = logging.Logger

+ func LoggerFromContext(ctx context.Context) Logger

+ type NTLMInitiator struct

+ Domain string

+ Hash []byte

+ Password string

+ TargetSPN string

+ User string

+ Workstation string

+ type Negotiator struct

+ ClientGuid [16]byte

+ RequireMessageSigning bool

+ SpecifiedDialect uint16

+ type PoolConfig struct

+ HealthCheck func(*Session) (bool, error)

+ IdleTimeout time.Duration

+ MaxActive int

+ MaxIdle int

+ WaitTimeout time.Duration

+ func DefaultPoolConfig() *PoolConfig

+ type PoolStats struct

+ Active int

+ Closed bool

+ Idle int

+ type PooledSession struct

+ func (ps *PooledSession) Close() error

+ func (ps *PooledSession) ListSharenames() ([]string, error)

+ func (ps *PooledSession) Logoff() error

+ func (ps *PooledSession) Mount(sharename string) (*Share, error)

+ func (ps *PooledSession) ReallyClose() error

+ func (ps *PooledSession) Session() *Session

+ func (ps *PooledSession) WithContext(ctx context.Context) *Session

+ type RemoteFile = File

+ type RemoteFileStat = FileStat

+ type RemoteFileSystem = Share

+ type ResponseError struct

+ Code uint32

+ func (e *ResponseError) Error() string

+ type SMBError struct

+ Command uint8

+ Message string

+ Status uint32

+ func (e *SMBError) Error() string

+ func (e *SMBError) Unwrap() error

+ type ServerCapabilities struct

+ DomainName string

+ EffectivePipelineDepth int

+ MaxBufferSize uint32

+ MaxMpxCount uint16

+ ServerName string

+ SupportsPipelining bool

+ func (c ServerCapabilities) String() string

+ type ServerTime struct

+ ReceivedAt time.Time

+ Time time.Time

+ TimeZoneOffsetMinutes int16

+ type Session struct

+ func (c *Session) ListSharenames() ([]string, error)

+ func (c *Session) Logoff() error

+ func (c *Session) Mount(sharename string) (*Share, error)

+ func (c *Session) WithContext(ctx context.Context) *Session

+ func (s *Session) Capabilities() ServerCapabilities

+ func (s *Session) ServerTime() ServerTime

+ type Share struct

+ func (fs *Share) Chmod(name string, mode os.FileMode) error

+ func (fs *Share) Chtimes(name string, atime time.Time, mtime time.Time) error

+ func (fs *Share) CopyFile(src, dst string) error

+ func (fs *Share) CopyFrom(localPath, remotePath string) error

+ func (fs *Share) CopyTo(remotePath, localPath string) error

+ func (fs *Share) Create(name string) (*File, error)

+ func (fs *Share) Exists(name string) (bool, error)

+ func (fs *Share) Glob(pattern string) (matches []string, err error)

+ func (fs *Share) IsDir(name string) (bool, error)

+ func (fs *Share) Lstat(name string) (os.FileInfo, error)

+ func (fs *Share) Mkdir(name string, perm os.FileMode) error

+ func (fs *Share) MkdirAll(path string, perm os.FileMode) error

+ func (fs *Share) Open(name string) (*File, error)

+ func (fs *Share) OpenFile(name string, flag int, perm os.FileMode) (*File, error)

+ func (fs *Share) ReadDir(dirname string) ([]os.FileInfo, error)

+ func (fs *Share) ReadFile(filename string) ([]byte, error)

+ func (fs *Share) Readdir(dirname string, n int) ([]os.FileInfo, error)

+ func (fs *Share) Readlink(name string) (string, error)

+ func (fs *Share) Remove(name string) error

+ func (fs *Share) RemoveAll(path string) error

+ func (fs *Share) Rename(oldpath, newpath string) error

+ func (fs *Share) Stat(name string) (os.FileInfo, error)

+ func (fs *Share) Statfs(name string) (FileFsInfo, error)

+ func (fs *Share) Symlink(target, linkpath string) error

+ func (fs *Share) Truncate(name string, size int64) error

+ func (fs *Share) Umount() error

+ func (fs *Share) VolumeInfo() (*VolumeInfo, error)

+ func (fs *Share) Walk(root string, walkFn filepath.WalkFunc) error

+ func (fs *Share) WithContext(ctx context.Context) *Share

+ func (fs *Share) WriteFile(filename string, data []byte, perm os.FileMode) error

+ func (s *Share) DirFS(dirname string) fs.FS

+ type TransportError struct

+ Err error

+ func (e *TransportError) Error() string

+ func (e *TransportError) Unwrap() error

+ type VolumeInfo struct

+ CreationTime time.Time

+ Label string

+ SerialNumber uint32