server

Documentation

Index

• Constants
• type AddKeyRequest
  • func (p *AddKeyRequest) FromBody(c *gin.Context) (ok bool)
• type ErrorResponse
• type InfoResponse
• type MetadataResponse
• type RepoInfoResponse
• type RepoKeyListItem
• type RepoKeyListResponse
• type Server
  • func (s *Server) DeleteRepoKeyHandler(c *gin.Context)
  • func (s *Server) DeleteTreeHandler(c *gin.Context)
  • func (s *Server) FileHandler(c *gin.Context)
  • func (s *Server) GetInfoHandler(c *gin.Context)
  • func (s *Server) GetMetadataHandler(c *gin.Context)
  • func (s *Server) GetRepoInfoHandler(c *gin.Context)
  • func (s *Server) GetRepoKeyHandler(c *gin.Context)
  • func (s *Server) GetTreeHandler(c *gin.Context)
  • func (s *Server) MiddlewareRequireInfoFileVersion(version uint16) func(c *gin.Context)
  • func (s *Server) MiddlewareRequireReadWrite(c *gin.Context)
  • func (s *Server) MiddlewareRequireRepo(c *gin.Context)
  • func (s *Server) MiddlewareRequireUnlock(c *gin.Context)
  • func (s *Server) PostRepoKeyHandler(c *gin.Context)
  • func (s *Server) PostRepoSelectHandler(c *gin.Context)
  • func (s *Server) PostRepoUnlockHandler(dryRun bool) func(c *gin.Context)
  • func (s *Server) PostTreeHandler(c *gin.Context)
  • func (s *Server) Start(ctx context.Context, address, port string) error
• type TreeOperationResponse
• type UnlockKeyRequest
  • func (p *UnlockKeyRequest) FromBody(c *gin.Context) (ok bool)

Constants

const IdleTimeout = 20

Timeout (in seconds) for detecting idle connections (which are not closed but are hanging)

Types

type AddKeyRequest

type AddKeyRequest struct {
	Passphrase string `json:"passphrase" form:"passphrase"`
	GPGKeyId   string `json:"gpg" form:"gpg"`
}

func (*AddKeyRequest) FromBody

func (p *AddKeyRequest) FromBody(c *gin.Context) (ok bool)

FromBody adds data to the object from a request

type ErrorResponse

type ErrorResponse struct {
	Error string `json:"error"`
}

type InfoResponse

type InfoResponse struct {
	Name       string `json:"name"`
	AppVersion string `json:"version,omitempty"`
	BuildID    string `json:"buildId,omitempty"`
	BuildTime  string `json:"buildTime,omitempty"`
	CommitHash string `json:"commitHash,omitempty"`
	Runtime    string `json:"runtime,omitempty"`
	Info       string `json:"info,omitempty"`
	ReadOnly   bool   `json:"readOnly,omitempty"`
}

type MetadataResponse

type MetadataResponse struct {
	FileId   string     `json:"fileId"`
	Folder   string     `json:"folder"`
	Name     string     `json:"name"`
	Date     *time.Time `json:"date,omitempty"`
	MimeType string     `json:"mimeType,omitempty"`
	Size     int64      `json:"size,omitempty"`
}

type RepoInfoResponse

type RepoInfoResponse struct {
	Version   uint16 `json:"version"`
	FileCount int    `json:"files"`
}

type RepoKeyListItem

type RepoKeyListItem struct {
	KeyId string `json:"keyId"`
	Type  string `json:"type"`
	UID   string `json:"uid,omitempty"`
}

type RepoKeyListResponse

type RepoKeyListResponse struct {
	Keys []RepoKeyListItem `json:"keys"`
}

type Server

type Server struct {
	Store     fs.Fs
	Verbose   bool
	Repo      *repository.Repository
	Infofile  *infofile.InfoFile
	LogWriter io.Writer
	ReadOnly  bool
}

func (*Server) DeleteRepoKeyHandler

func (s *Server) DeleteRepoKeyHandler(c *gin.Context)

DeleteRepoKeyHandler is the handler for DELETE /api/repo/key/:keyId, which removes a key key

func (*Server) DeleteTreeHandler

func (s *Server) DeleteTreeHandler(c *gin.Context)

DeleteTreeHandler is the handler for DELETE /api/tree/:path, which removes an object The :path value must be an exact object, or must end with "/*" to remove a folder

func (*Server) FileHandler

func (s *Server) FileHandler(c *gin.Context)

FileHandler is the handler for GET /file/:fileId, which returns a (decrypted) file

func (*Server) GetInfoHandler

func (s *Server) GetInfoHandler(c *gin.Context)

GetInfoHandler is the handler for GET /api/info, which returns the info for the app

func (*Server) GetMetadataHandler

func (s *Server) GetMetadataHandler(c *gin.Context)

GetMetadataHandler is the handler for GET /api/metadata/:file, which returns the metadata for a file

func (*Server) GetRepoInfoHandler

func (s *Server) GetRepoInfoHandler(c *gin.Context)

GetInfoHandler is the handler for GET /api/repo/info, which returns info about the repository

func (*Server) GetRepoKeyHandler

func (s *Server) GetRepoKeyHandler(c *gin.Context)

GetRepoKeyHandler is the handler for GET /api/repo/key, which returns the list of keys allowed to unlock this repository

func (*Server) GetTreeHandler

func (s *Server) GetTreeHandler(c *gin.Context)

GetTreeHandler is the handler for GET /api/tree/:path, which returns the contents of a path

func (*Server) MiddlewareRequireInfoFileVersion

func (s *Server) MiddlewareRequireInfoFileVersion(version uint16) func(c *gin.Context)

MiddlewareRequireInfoFileVersion requires a minimum version of the info file to continue

func (*Server) MiddlewareRequireReadWrite

func (s *Server) MiddlewareRequireReadWrite(c *gin.Context)

MiddlewareRequireReadWrite disables a route that would edit the repository if we're operating in read-only mode

func (*Server) MiddlewareRequireRepo

func (s *Server) MiddlewareRequireRepo(c *gin.Context)

MiddlewareRequireRepo requires a repository to be selected (even if not unlocked)

func (*Server) MiddlewareRequireUnlock

func (s *Server) MiddlewareRequireUnlock(c *gin.Context)

MiddlewareRequireUnlock requires the repository to be unlocked before processing

func (*Server) PostRepoKeyHandler

func (s *Server) PostRepoKeyHandler(c *gin.Context)

PostRepoKeyHandler is the handler for POST /api/repo/key, which adds a new key

func (*Server) PostRepoSelectHandler

func (s *Server) PostRepoSelectHandler(c *gin.Context)

PostRepoSelectHandler is the handler for POST /api/repo/select, which selects a repository

func (*Server) PostRepoUnlockHandler

func (s *Server) PostRepoUnlockHandler(dryRun bool) func(c *gin.Context)

PostRepoUnlockHandler is the handler for POST /api/repo/unlock, which unlocks a repository The same handler is also used by POST /api/repo/keytest, which tests a key and returns its ID (essentially performing a "dry run" for the unlock operation)

func (*Server) PostTreeHandler

func (s *Server) PostTreeHandler(c *gin.Context)

PostTreeHandler is the handler for POST /api/tree/:path, which adds documents to the repository The path argument is the destination folder (just like the "-d" argument in the "prvt add" command) The post body can contain either one of: - One or more files transmitted in the request body, in the "file" field(s) - The path to a file or folder in the local filesystem, in the "localpath" field(s)

func (*Server) Start

func (s *Server) Start(ctx context.Context, address, port string) error

type TreeOperationResponse

type TreeOperationResponse struct {
	Path   string `json:"path"`
	Status string `json:"status"`
	FileId string `json:"fileId"`
	Error  string `json:"error,omitempty"`
}

type UnlockKeyRequest

type UnlockKeyRequest struct {
	Type       string `json:"type" form:"type"`
	Passphrase string `json:"passphrase" form:"passphrase"`
}

func (*UnlockKeyRequest) FromBody

func (p *UnlockKeyRequest) FromBody(c *gin.Context) (ok bool)

FromBody adds data to the object from a request