# Functions
No description provided by the author
No description provided by the author
No description provided by the author
ChunkWalk will step through the chunks returned by the ChunkScanner and call the provided ChunkReadFunc f for each.
DecodeEnd will decode an EndChunk.
DecodeHeader will decode a Header chunk.
GetBsrFileName formats a session recording id into the BSR filename format.
NewBaseChunk creates a BaseChunk.
NewChannelId generates an id for a channel recording.
NewChunkDecoder creates a ChunkDecoder that can decode the data read from the given io.Reader.
NewChunkEncoder creates a ChunkEncoder.
NewChunkScanner creates a ChunkScanner.
NewEnd creates an EndChunk.
NewHeader creates a HeaderChunk.
NewSession creates a Session container for a given session id.
NewTimestamp creates a Timestamp.
OpenSession retrieves a BSR from storage using the sessionRecordingId and initializes it for reading.
ReadMagic attempts to read the magic string from the given io.Reader.
RegisterChunkType registers a DecodeChunkFunc for the given Protocol and ChunkType.
RegisterSummaryAllocFunc registers a SummaryAllocFunc for the given Protocol.
TestRegisterSummaryAllocFunc registers "TEST" as a protocol for all container types The channel summary will include the following:
BaseChannelSummary{Id: "TEST_CHANNEL_ID", ConnectionRecordingId: "TEST_CONNECTION_RECORDING_ID"}
The connection summary will include the following:
BaseConnectionSummary{Id: "TEST_CONNECTION_ID", ChannelCount: 1}
The session summary will include the following:
BaseSessionSummary{Id: "TEST_SESSION_ID", ConnectionCount: 1}.
No description provided by the author
No description provided by the author
Validate retrieves a BSR from storage using the sessionRecordingId and validates the BSR.
ValidByteSource checks if a given ByteSource is valid.
ValidChunkType checks ifa given ChunkType is valid.
ValidCompression checks if a given Compression is valid.
ValidDirection checks if a given Direction is valid.
ValidEncryption checks if a given Encryption is valid.
ValidProtocol checks if a given Protocol is valid.
WithKeys is used to provide optional kms.Keys.
WithSha256Sum is used to provide a hex encoded SHA256SUM.
WithSupportsMultiplex is used indicate that a protocol supports multiplexing and therefore a BSR can contain Channels.
# Constants
Valid container types.
ChannelIdPrefix is the prefix for the channel recording id.
Chunk Types.
Chunk Types.
ByteDirections.
Valid container types.
Supported compression methods.
Directions.
Magic is the magic string / magic number / file signature used to identify a BSR data file.
MaxChunkDataLength sets an upper bound on BSR chunk lengths Default to 64MB, as this is the limit for protobufs, which back our chunks TODO: Should this be configurable as an option?.
Supported compression methods.
Supported encryption methods.
Directions.
ByteDirections.
Valid container types.
ByteDirections.
Directions.
# Variables
ErrAlreadyRegistered is an error with registering functions.
ErrBsrKeyPersistenceFailure indicates a failure in persisting BSR encryption keys.
ErrChecksum indicates that a checksum did not match.
ErrChunkDecode indicates an error when decoding a chunk.
ErrEndChunkNotEmpty indicates a malformed END chunk.
ErrInvalidMagic is used when a binary bsr file is missing the magic string.
ErrInvalidParameter represents an invalid parameter error.
ErrNotSupported represents an operation that is not supported for a particular protocol.
ErrSignatureVerification indicates a failure in verifying a signature.
ErrSummaryUnavailable indicates a BSR summary is unavailable.
ErrTimestampDecode indicates an error decoding a timestamp.
ErrUnknown represents an unknown error.
# Structs
BaseChannelSummary encapsulates data for a channel, including its id, channel type, start/end time using a monotonic clock, and the bytes up/ down seen on this channel.
BaseChunk contains the common fields of all chunk types.
BaseConnectionSummary encapsulates data for a connection, including its connection id, channel count, start/end time using a monotonic clock, and the aggregate bytes up/ down of its channels.
BaseSessionSummary encapsulates data for a session, including its session id, connection count, and start/end time using a monotonic clock.
BaseSummary contains the common fields of all summary types.
Channel is a container in a bsr for a specific channel in a session container.
ChannelRecordingMeta contains metadata about a channel in a BSR.
ChunkDecoder is used to decode the data read from an io.Reader into Chunks.
ChunkEncoder will encode a chunk and write it to the writer.
ChunkScanner can be used to read a Chunk at a time.
Connection is a container in a bsr for a specific connection in a session container.
ConnectionRecordingMeta contains metadata about a connection in a BSR.
ContainerValidation contains the results from validating a container in a bsr.
DynamicHost contains information about the dynamic host for this session.
DynamicHostCatalog contains information about the dynamic host catalog for this session.
EndChunk identifies the end of the chunks in a BSR data file.
FileChecksumValidation is a validation report on a file's checksum value.
HeaderChunk is the first chunk in a BSR data file.
Scope contains information about the scope of a Boundary domain object.
Session is the top level container in a bsr that contains the files for a recorded session.
SessionMeta contains metadata about a session in a BSR.
SessionRecordingMeta contains metadata about a session in a BSR.
StaticCredentialStore represents a static credential store used for this session.
StaticHost contains information about the static host for this session.
StaticHostCatalog contains information about the static host catalog for this session.
StaticJsonCredential represents a static json credential used for this session.
StaticSshPrivateKeyCredential represents a Static Ssh private key credential used for this session.
StaticUsernamePasswordCredential represents a Static username password credential used for this session.
No description provided by the author
Target contains information about the target for this session.
User contains information about user who initiated this session.
Validation provides the results from validating a bsr.
VaultCredentialStore represents a Vault credential store used for this session.
VaultGenericLibrary contains information about the Vault library used for this session.
VaultSshCertificateLibrary contains information about a Vault Ssh Cert library for this session.
Worker contains information about the worker used to record this session.
# Interfaces
ChannelSummary contains statistics for a channel container.
Chunk is a section of a bsr data file.
ConnectionSummary contains statistics for a connection container.
SessionSummary contains statistics for a session container.
Summary contains statistics for a container.
# Type aliases
ByteSource identifies whether bytes are flowing from the user to target (client) or target to user (server).
ChunkReadFunc is a function that can be used by ChunkWalk to process a Chunk.
ChunkType identifies the type of a chunk.
Compression is used to identify the compression used for the data in chunks.
ContainerChecksumValidation is a map where the key is a file name and the value contains a validation report on whether or not the file matches its expected checksum.
ContainerType defines the type of container.
DecodeChunkFunc is a function that given a BaseChunk and the data portion of a chunk, will decode the data into a Chunk.
Direction identifies the directionality of the data captured in the chunk.
Encryption is used to identify the encryption used for the data in chunks.
Option - how Options are passed as arguments.
Protocol identifies the protocol of the data captured in a chunk.
SummaryAllocFunc is a function that returns a summary type.
Timestamp is a time.Time that can be marshaled/unmarshaled to/from a bsr data file.