car

Sep 1, 2023

Changes in this version

type BlockMetadata

+ SourceOffset uint64

Mar 7, 2023

Changes in this version

type Option

+ func WithTrustedCAR(t bool) Option

type Options

+ TrustedCAR bool

Feb 8, 2023

Changes in this version

type Option

+ func AllowDuplicatePuts(allow bool) Option

+ func UseWholeCIDs(enable bool) Option

+ func WriteAsCarV1(asCarV1 bool) Option

Oct 20, 2022

Changes in this version

+ type BlockMetadata struct

+ Offset uint64

+ Size uint64

type BlockReader

+ func (br *BlockReader) SkipNext() (*BlockMetadata, error)

Jul 6, 2022

Changes in this version

+ const DefaultMaxAllowedHeaderSize

+ const DefaultMaxAllowedSectionSize

type Option

+ func MaxAllowedHeaderSize(max uint64) Option

+ func MaxAllowedSectionSize(max uint64) Option

type Options

+ MaxAllowedHeaderSize uint64

+ MaxAllowedSectionSize uint64

type Reader

+ func (r *Reader) Inspect(validateBlockHash bool) (Stats, error)

+ type Stats struct

+ AvgBlockLength uint64

+ AvgCidLength uint64

+ BlockCount uint64

+ CodecCounts map[multicodec.Code]uint64

+ Header Header

+ IndexCodec multicodec.Code

+ MaxBlockLength uint64

+ MaxCidLength uint64

+ MhTypeCounts map[multicodec.Code]uint64

+ MinBlockLength uint64

+ MinCidLength uint64

+ Roots []cid.Cid

+ RootsPresent bool

+ Version uint64

Jun 30, 2022 GO-2022-0503

  GO-2022-0503: Denial of service via malformed CAR data in github.com/ipld/go-car and go-car/v2

May 31, 2022 GO-2022-0503

  GO-2022-0503: Denial of service via malformed CAR data in github.com/ipld/go-car and go-car/v2

Changes in this version

type Option

+ func WithTraversalPrototypeChooser(t traversal.LinkTargetNodePrototypeChooser) Option

type Options

+ TraversalPrototypeChooser traversal.LinkTargetNodePrototypeChooser

+ WriteAsCarV1 bool

Dec 11, 2021 GO-2022-0503

  GO-2022-0503: Denial of service via malformed CAR data in github.com/ipld/go-car and go-car/v2

Changes in this version

+ var ErrOffsetImpossible = fmt.Errorf("car-error-offsetimpossible")

+ var ErrSizeMismatch = fmt.Errorf("car-error-sizemismatch")

+ func TraverseToFile(ctx context.Context, ls *ipld.LinkSystem, root cid.Cid, selector ipld.Node, ...) error

+ func TraverseV1(ctx context.Context, ls *ipld.LinkSystem, root cid.Cid, selector ipld.Node, ...) (uint64, error)

type Option

+ func MaxTraversalLinks(MaxTraversalLinks uint64) Option

+ func WithoutIndex() Option

type Options

+ MaxTraversalLinks uint64

+ type Writer interface

+ func NewSelectiveWriter(ctx context.Context, ls *ipld.LinkSystem, root cid.Cid, selector ipld.Node, ...) (Writer, error)

Oct 1, 2021 GO-2022-0503

  GO-2022-0503: Denial of service via malformed CAR data in github.com/ipld/go-car and go-car/v2

Changes in this version

+ const DefaultMaxIndexCidSize

+ var ErrAlreadyV1 = errors.New("already a CARv1")

+ func ExtractV1File(srcPath, dstPath string) (err error)

+ func LoadIndex(idx index.Index, v1r io.Reader, opts ...Option) error

+ func ReplaceRootsInFile(path string, roots []cid.Cid) (err error)

type Characteristics

+ func (c *Characteristics) IsFullyIndexed() bool

+ func (c *Characteristics) SetFullyIndexed(b bool)

+ type ErrCidTooLarge struct

+ CurrentSize uint64

+ MaxSize uint64

+ func (e *ErrCidTooLarge) Error() string

+ type Option func(*Options)

+ func MaxIndexCidSize(s uint64) Option

+ func StoreIdentityCIDs(b bool) Option

+ func UseIndexCodec(c multicodec.Code) Option

+ type Options struct

+ BlockstoreAllowDuplicatePuts bool

+ BlockstoreUseWholeCIDs bool

+ DataPadding uint64

+ IndexCodec multicodec.Code

+ IndexPadding uint64

+ MaxIndexCidSize uint64

+ StoreIdentityCIDs bool

+ ZeroLengthSectionAsEOF bool

+ func ApplyOptions(opt ...Option) Options

Aug 10, 2021 GO-2022-0503

  GO-2022-0503: Denial of service via malformed CAR data in github.com/ipld/go-car and go-car/v2

Changes in this version

+ const CharacteristicsSize

+ const HeaderSize

+ const PragmaSize

+ var Pragma = []byte

+ func AttachIndex(path string, idx index.Index, offset uint64) error

+ func GenerateIndex(v1r io.Reader, opts ...ReadOption) (index.Index, error)

+ func GenerateIndexFromFile(path string) (index.Index, error)

+ func ReadOrGenerateIndex(rs io.ReadSeeker, opts ...ReadOption) (index.Index, error)

+ func ReadVersion(r io.Reader) (uint64, error)

+ func WrapV1(src io.ReadSeeker, dst io.Writer) error

+ func WrapV1File(srcPath, dstPath string) error

+ type BlockReader struct

+ Roots []cid.Cid

+ Version uint64

+ func NewBlockReader(r io.Reader, opts ...ReadOption) (*BlockReader, error)

+ func (br *BlockReader) Next() (blocks.Block, error)

+ type Characteristics struct

+ Hi uint64

+ Lo uint64

+ func (c *Characteristics) ReadFrom(r io.Reader) (int64, error)

+ func (c Characteristics) WriteTo(w io.Writer) (n int64, err error)

+ type Header struct

+ Characteristics Characteristics

+ DataOffset uint64

+ DataSize uint64

+ IndexOffset uint64

+ func NewHeader(dataSize uint64) Header

+ func (h *Header) ReadFrom(r io.Reader) (int64, error)

+ func (h Header) HasIndex() bool

+ func (h Header) WithDataPadding(padding uint64) Header

+ func (h Header) WithDataSize(size uint64) Header

+ func (h Header) WithIndexPadding(padding uint64) Header

+ func (h Header) WriteTo(w io.Writer) (n int64, err error)

+ type ReadOption func(*ReadOptions)

+ func ZeroLengthSectionAsEOF(enable bool) ReadOption

+ type ReadOptions struct

+ BlockstoreUseWholeCIDs bool

+ ZeroLengthSectionAsEOF bool

+ type ReadWriteOption interface

+ type Reader struct

+ Header Header

+ Version uint64

+ func NewReader(r io.ReaderAt, opts ...ReadOption) (*Reader, error)

+ func OpenReader(path string, opts ...ReadOption) (*Reader, error)

+ func (r *Reader) Close() error

+ func (r *Reader) DataReader() SectionReader

+ func (r *Reader) IndexReader() io.Reader

+ func (r *Reader) Roots() ([]cid.Cid, error)

+ type SectionReader interface

+ type WriteOption func(*WriteOptions)

+ func UseDataPadding(p uint64) WriteOption

+ func UseIndexPadding(p uint64) WriteOption

+ type WriteOptions struct

+ BlockstoreAllowDuplicatePuts bool

+ DataPadding uint64

+ IndexPadding uint64

Aug 6, 2021 GO-2022-0503

  GO-2022-0503: Denial of service via malformed CAR data in github.com/ipld/go-car and go-car/v2

Aug 5, 2021 GO-2022-0503

  GO-2022-0503: Denial of service via malformed CAR data in github.com/ipld/go-car and go-car/v2