parse

Documentation

Overview

Package parse builds parse trees for crypt(3) hashes.

Supported schemes:

• DES: <value>(<value>)*
• DES Extended (BSDi): _<value>(<value>)*
• MCF/PHC: $<id>$fragment($<fragment>)* Where:
• <fragment> is (<group>|<param>=<value>|<value>)
• <group> is <param>=<value>,<param>=<value>(,<param>=<value>)*

Index

• type FragmentNode
• type GroupNode
  • func (g *GroupNode) End() Pos
  • func (g *GroupNode) Pos() Pos
  • func (g *GroupNode) String() string
  • func (g *GroupNode) Type() NodeType
• type Node
• type NodeType
  • func (t NodeType) String() string
• type Pos
• type PrefixNode
  • func (p *PrefixNode) End() Pos
  • func (p *PrefixNode) Pos() Pos
  • func (p *PrefixNode) String() string
  • func (p *PrefixNode) Type() NodeType
• type SyntaxError
  • func (e *SyntaxError) Error() string
• type Tree
  • func Parse(hash string) (*Tree, error)
• type ValueNode
  • func (v *ValueNode) End() Pos
  • func (v *ValueNode) Pos() Pos
  • func (v *ValueNode) String() string
  • func (v *ValueNode) Type() NodeType

Types

type FragmentNode

type FragmentNode interface {
	Node
	// contains filtered or unexported methods
}

FragmentNode represents a fragment separated by '$'.

type GroupNode

type GroupNode struct {
	Values []*ValueNode // len(Values) > 0
}

GroupNode represents a comma-separated list of values.

func (*GroupNode) End

func (g *GroupNode) End() Pos

func (*GroupNode) Pos

func (g *GroupNode) Pos() Pos

func (*GroupNode) String

func (g *GroupNode) String() string

func (*GroupNode) Type

func (g *GroupNode) Type() NodeType

type Node

type Node interface {
	Type() NodeType
	String() string
	Pos() Pos // position of first byte belonging to the node
	End() Pos // position of first byte immediately after the node
	// contains filtered or unexported methods
}

Node is an element in the parse tree. The interface contains an unexported method so that only types local to this package can satisfy it.

type NodeType

type NodeType int

NodeType identifies the type of a parse tree node.

const (
	NodePrefix NodeType = iota
	NodeGroup
	NodeValue
)

func (NodeType) String

func (t NodeType) String() string

type Pos

type Pos int

Pos represents a byte position in the original input text.

type PrefixNode

type PrefixNode struct {
	Text string
	// contains filtered or unexported fields
}

PrefixNode holds a hash prefix, like '_', '$id$' or '$id,'.

func (*PrefixNode) End

func (p *PrefixNode) End() Pos

func (*PrefixNode) Pos

func (p *PrefixNode) Pos() Pos

func (*PrefixNode) String

func (p *PrefixNode) String() string

func (*PrefixNode) Type

func (p *PrefixNode) Type() NodeType

type SyntaxError

type SyntaxError struct {
	Offset int    // byte offset in input where error was detected
	Msg    string // description of error
}

SyntaxError suggests that the hash is invalid.

func (*SyntaxError) Error

func (e *SyntaxError) Error() string

type Tree

type Tree struct {
	Prefix    *PrefixNode
	Fragments []FragmentNode
}

Tree is the representation of a single parsed hash.

func Parse

func Parse(hash string) (*Tree, error)

Parse parses the hash string and returns the corresponding syntax tree.

type ValueNode

type ValueNode struct {
	Value string
	// contains filtered or unexported fields
}

ValueNode holds a single value.

func (*ValueNode) End

func (v *ValueNode) End() Pos

func (*ValueNode) Pos

func (v *ValueNode) Pos() Pos

func (*ValueNode) String

func (v *ValueNode) String() string

func (*ValueNode) Type

func (v *ValueNode) Type() NodeType