README
¶
visage
Visage is a library that allows services to share file content over the web. It can be integrated directly with existing programs or run as a standalone package.
Integration
The visage package can be used to add the ability to share files based on
arbitrary credentials. Application authors can implement a type that satisfies
the FileSystem interface (or use the provided Directory type, for local
file system access) and then selectively allow access.
Standalone
The standalone binary included in this repository serves as a proof-of-concept implementation. It provides a simple web interface that allows one or more administrators to create shares and assign share ownership to others, who can themselves share individual files or directories with third parties as they please.
This is not an official Google product.
Documentation
¶
Overview ¶
Package visage allows programs to expose files publicly with access control.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
ErrNoAccess = errors.New("access denied")
)
Functions ¶
Types ¶
type FileSystem ¶
type FileSystem interface {
// String is a unique, descriptive identifier for this file system.
String() string
// Open the named file for reading.
Open(path string) (io.ReadCloser, error)
// Create should return a writer for the given path. It is left to specific
// implementations whether they want to allow users to overwrite existing files,
// or to return an error, or to implement something more sophisticated such as
// versioning.
Create(path string) (io.WriteCloser, error)
// Stat should behave as os.Stat. If the underlying file system implements
// symlinks, Stat should follow them and treat them as directories.
Stat(path string) (os.FileInfo, error)
// ReadDir should return all the entries in a given directory.
ReadDir(path string) ([]os.FileInfo, error)
}
FileSystem specifies the abstraction that backends must satisfy.
func NewDirectory ¶
func NewDirectory(path string) FileSystem
NewDirectory creates a FileSystem that serves files with the given path at the root.
func NewEncryptedDirectory ¶
func NewEncryptedDirectory(path string, recipients []*openpgp.Entity, signer *openpgp.Entity) FileSystem
NewEncryptedDirectory returns a FileSystem that serves files from the given root. Files are encrypted on disk, and optionally signed. Files are automatically decrypted when read.
type Share ¶
type Share struct {
// contains filtered or unexported fields
}
func (*Share) AddFileSystem ¶
func (s *Share) AddFileSystem(fs FileSystem) error
func (*Share) FileSystem ¶
func (s *Share) FileSystem(fs string) (FileSystem, error)
func (*Share) FileSystems ¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
bin
|
|
|
visage
Visage is a very simple implementation of the visage library with the bad web UI.
|
Visage is a very simple implementation of the visage library with the bad web UI. |
|
oauth2
|
|
|
github
Package github provides OKs and tokens for GitHub authentication.
|
Package github provides OKs and tokens for GitHub authentication. |
|
google
Package google provides OKs and tokens for Google Single-Sign On.
|
Package google provides OKs and tokens for Google Single-Sign On. |
|
Package token implements a token-based OK.
|
Package token implements a token-based OK. |
|
Package web implements a simple web UI for visage.
|
Package web implements a simple web UI for visage. |