README
¶
gosign
Go HTTP signing library for Joyent's Triton and Manta.
Installation
Use go-get to install gosign
go get github.com/joyent/gosign
Documentation
Documentation can be found on godoc.
Contributing
Report bugs and request features using GitHub Issues, or contribute code via a GitHub Pull Request. Changes will be code reviewed before merging. In the near future, automated tests will be run, but in the meantime please go fmt, go lint, and test all contributions.
Developing
This library assumes a Go development environment setup based on How to Write Go Code. Your GOPATH environment variable should be pointed at your workspace directory.
You can now use go get github.com/joyent/gosign to install the repository to the correct location, but if you are intending on contributing back a change you may want to consider cloning the repository via git yourself. This way you can have a single source tree for all Joyent Go projects with each repo having two remotes -- your own fork on GitHub and the upstream origin.
For example if your GOPATH is ~/src/joyent/go and you're working on multiple repos then that directory tree might look like:
~/src/joyent/go/
|_ pkg/
|_ src/
|_ github.com
|_ joyent
|_ gocommon
|_ gomanta
|_ gosdc
|_ gosign
Recommended Setup
$ mkdir -p ${GOPATH}/src/github.com/joyent
$ cd ${GOPATH}/src/github.com/joyent
$ git clone [email protected]:<yourname>/gosign.git
$ cd gosign
$ git remote add upstream [email protected]:joyent/gosign.git
$ git remote -v
origin [email protected]:<yourname>/gosign.git (fetch)
origin [email protected]:<yourname>/gosign.git (push)
upstream [email protected]:joyent/gosign.git (fetch)
upstream [email protected]:joyent/gosign.git (push)
Run Tests
cd ${GOPATH}/src/github.com/joyent/gosign
go test ./...
Build the Library
cd ${GOPATH}/src/github.com/joyent/gosign
go build ./...
Documentation
¶
Overview ¶
* The sign package enables Go programs to create signed requests for * the Joyent Public Cloud and Joyent Manta services. * * The sign package is structured as follow: * * - gosign/auth. This package deals with the authorization and signature of requests. * * Copyright (c) 2016 Joyent Inc. * Written by Daniele Stroppa <[email protected]> * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/.
Source Files
Directories