steady

package module

v0.0.0-...-0dcfdb9 Latest Latest Go to latest Published: Sep 20, 2018 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/pylls/steady

Links

Open Source Insights

README ¶

Steady: A simple end-to-end secure logging system

A golang implementation of a proof-of-concept Steady relay and simple echo collector. For the corresponding Steady device please see the C implementation.

Brief instructions to run

go get github.com/pylls/steady
run steady-relay
run steady-make-device
copy test.device to the device folder of the C implementation
build and run the C demo device
run steady-echo-collector to read from the relay

Paper

https://eprint.iacr.org/2018/737

License

Apache 2.0

Documentation ¶

Index ¶

Constants
func AuditPath(m int, data [][]byte) [][]byte
func CheckPayloadHash(payload []byte, policy Policy, bh BlockHeader) bool
func DecodeBlockPayload(payload, pub, pk []byte, policy Policy, bh BlockHeader) (events [][]byte, IV []byte, err error)
func EncodePolicy(p Policy) []byte
func MakeEncodedBlock(index, lenPrev, time uint64, encrypt, compress bool, policy Policy, ...) ([]byte, error)
func MerkleTreeHash(data [][]byte) (root []byte)
func RootFromAuditPath(l []byte, index, size int, path [][]byte) (r []byte)
type BlockHeader
- func DecodeBlockHeader(encoded []byte, policy Policy) (b BlockHeader, err error)
type Policy
- func DecodePolicy(b []byte) (Policy, error)
- func MakePolicy(sk, vk, pub []byte, timeout, space, time uint64) Policy

Constants ¶

View Source

const (
	SetupFilename       = "%s.device"
	DeviceStateFilename = "%s.state"
	CollectorFilename   = "%s.collector"

	WireVersion        = 0x42
	WireIdentifierSize = 32

	// commands
	WireCmdStatus = 0x0
	WireCmdSetup  = 0x1
	WireCmdRead   = 0x2
	WireCmdWrite  = 0x3

	WireTrue    = 0x1
	WireFalse   = 0x0
	WireMore    = 0xA
	WireAuthErr = 0xF

	WirePolicySize      = WireIdentifierSize + lc.VericationKeySize + lc.PublicKeySize + 3*8 + lc.SignatureSize
	WireBlockHeaderSize = 4*8 + 3*lc.HashOutputLen + lc.SignatureSize
	WireAuthSize        = lc.HashOutputLen

	MaxBlockSize = 104857600 // 100 MiB
)

View Source

const (
	// LeafPrefix is the domain separation prefix for leaf hashes.
	LeafPrefix = 0x00

	// NodePrefix is the domain separation prefix for internal block nodes.
	NodePrefix = 0x01
)

View Source

const IVsize = 32

IVsize is the number of bytes of the random IV per block.

Variables ¶

This section is empty.

Functions ¶

func AuditPath ¶

func AuditPath(m int, data [][]byte) [][]byte

AuditPath as in RFC6962

func CheckPayloadHash ¶

func CheckPayloadHash(payload []byte, policy Policy, bh BlockHeader) bool

func DecodeBlockPayload ¶

func DecodeBlockPayload(payload, pub, pk []byte, policy Policy, bh BlockHeader) (events [][]byte,
	IV []byte, err error)

func EncodePolicy ¶

func EncodePolicy(p Policy) []byte

func MakeEncodedBlock ¶

func MakeEncodedBlock(index, lenPrev, time uint64,
	encrypt, compress bool,
	policy Policy, events [][]byte, sk []byte) ([]byte, error)

func MerkleTreeHash ¶

func MerkleTreeHash(data [][]byte) (root []byte)

MerkleTreeHash as in RFC6962

func RootFromAuditPath ¶

func RootFromAuditPath(l []byte, index, size int, path [][]byte) (r []byte)

RootFromAuditPath computes the expected root from an audit path

Types ¶

type BlockHeader ¶

type BlockHeader struct {
	Index, LenCur, LenPrev, Time                 uint64
	PayloadHash, HeaderHash, RootHash, Signature []byte
	Encrypted, Compressed                        bool
}

func DecodeBlockHeader ¶

func DecodeBlockHeader(encoded []byte, policy Policy) (b BlockHeader, err error)

type Policy ¶

type Policy struct {
	ID, Signature, Vk, Pub []byte
	Timeout, Space, Time   uint64
}

func DecodePolicy ¶

func DecodePolicy(b []byte) (Policy, error)

func MakePolicy ¶

func MakePolicy(sk, vk, pub []byte,
	timeout, space, time uint64) Policy

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
steady-benchmark-wrapper
steady-echo-collector
steady-make-device
steady-relay
steady-stdin-device
steady-syslog-recv
steady-syslog-send
collector
device * Stub for a Steady device in Go, only used to make the device config, * please see the C implementation of the device for now.	* Stub for a Steady device in Go, only used to make the device config, * please see the C implementation of the device for now.
lc

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL