dn.go

package ldapserver

import (
	"bytes"
	"strconv"
	"strings"
	"unicode"
)

// DN represents a distinguished name.
// It is a sequence of relative distinguished names (RDNs).
// Note: The order of RDNs is reversed compared to the LDAP string representation.
type DN []RDN

// RDN represents a relative distinguished name.
// It is a sequence of (commonly only one) RDNAttribute's.
type RDN []RDNAttribute

// RDNAttribute represents an attribute in a relative distinguished name.
type RDNAttribute struct {
	Type  string
	Value string
}

// Returns the RFC4514-compliant string representation of the DN.
func (d DN) String() string {
	s := ""
	for i := len(d) - 1; i >= 0; i-- {
		if i < len(d)-1 {
			s += ","
		}
		s += d[i].String()
	}
	return s
}

// Returns true if the DN is equal to the other DN.
func (d DN) Equal(other DN) bool {
	if len(d) != len(other) {
		return false
	}
	for i, rdn := range d {
		if !rdn.Equal(other[i]) {
			return false
		}
	}
	return true
}

// Returns true if the DN is an immediate superior of the other DN.
func (d DN) IsParent(child DN) bool {
	if len(d)+1 != len(child) {
		return false
	}
	if len(d) == 0 {
		return true
	}
	for i, rdn := range child[:len(d)] {
		if !rdn.Equal(d[i]) {
			return false
		}
	}
	return true
}

// Returns true if the DN is an immediate subordinate of the other DN.
func (d DN) IsChild(other DN) bool {
	return other.IsParent(d)
}

// Returns true if the DN is a superior of the other DN.
func (d DN) IsSuperior(other DN) bool {
	if len(d) >= len(other) {
		return false
	}
	for i, rdn := range d {
		if !rdn.Equal(other[i]) {
			return false
		}
	}
	return true
}

// Returns true if the DN is a subordinate of the other DN.
func (d DN) IsSubordinate(other DN) bool {
	return other.IsSuperior(d)
}

// Returns true if the DN and other have the same parent.
func (d DN) IsSibling(other DN) bool {
	if len(d) != len(other) {
		return false
	}
	if len(d) == 0 {
		return true
	}
	for i, rdn := range d[:len(d)-1] {
		if !rdn.Equal(other[i]) {
			return false
		}
	}
	return true
}

// Returns the lowest common superior of the DN and other.
func (d DN) CommonSuperior(other DN) DN {
	if len(d) == 0 || len(other) == 0 {
		return nil
	}
	for i, rdn := range d {
		if i == len(other) || !rdn.Equal(other[i]) {
			return d[:i]
		}
	}
	return d
}

// Returns the DN with the specified RDNAttribute added to the end.
func (d DN) WithRDN(rdn RDN) DN {
	new := make(DN, len(d), len(d)+1)
	copy(new, d)
	return append(new, rdn)
}

// Returns the DN with the specified RDN attribute string and value added to the end.
func (d DN) WithRDNAttribute(atype string, value string) DN {
	return d.WithRDN(RDN{RDNAttribute{atype, value}})
}

// Returns the RFC4514-compliant string representation of the RDN.
func (r RDN) String() string {
	s := ""
	for i, attr := range r {
		if i > 0 {
			s += "+"
		}
		s += attr.String()
	}
	return s
}

// Returns true if the RDN is equal to the other RDN.
func (r RDN) Equal(other RDN) bool {
	if len(r) != len(other) {
		return false
	}
	for i, attr := range r {
		if attr.Type != other[i].Type || attr.Value != other[i].Value {
			return false
		}
	}
	return true
}

// Returns the RFC4514-compliant string representation of the RDNAttribute.
func (a RDNAttribute) String() string {
	if OID(a.Type).Validate() == nil {
		buf := make([]byte, 1, len(a.Value)*2+1)
		buf[0] = '#'
		for _, b := range BerEncodeOctetString(a.Value) {
			s := strconv.FormatUint(uint64(b), 16)
			if len(s) == 1 {
				s = "0" + s
			}
			buf = append(buf, strings.ToUpper(s)...)
		}
		return a.Type + "=" + string(buf)
	} else {
		buf := make([]byte, 0, len(a.Value))
		for i, b := range []byte(a.Value) {
			switch b {
			case ' ':
				if i == 0 || i == len(a.Value)-1 {
					buf = append(buf, '\\', b)
				} else {
					buf = append(buf, b)
				}
			case '#':
				if i == 0 {
					buf = append(buf, '\\', b)
				} else {
					buf = append(buf, b)
				}
			case '"', '+', ',', ';', '<', '>', '\\', '=':
				buf = append(buf, '\\', b)
			case '\x00':
				buf = append(buf, '\\', '0', '0')
			default:
				if unicode.IsPrint(rune(b)) {
					buf = append(buf, b)
				} else {
					s := strconv.FormatUint(uint64(b), 16)
					if len(s) == 1 {
						s = "0" + s
					}
					s = "\\" + s
					buf = append(buf, strings.ToUpper(s)...)
				}
			}
		}
		return a.Type + "=" + string(buf)
	}
}

// Parses a RFC4514 string representation into a DN.
func ParseDN(s string) (DN, error) {
	var dn DN
	for _, rdn := range splitRDNs(s) {
		var r RDN
		for _, attr := range splitAttrs(rdn) {
			parts := splitAttr(attr)
			value, err := DecodeRDNAttributeValue(parts[1])
			if err != nil {
				return nil, err
			}
			r = append(r, RDNAttribute{Type: parts[0], Value: value})
		}
		dn = append(dn, r)
	}
	return dn, nil
}

// Parses a RFC4514 string representation into a DN.
// Panics if there is an error, useful for compile-time initialization.
func MustParseDN(s string) DN {
	dn, err := ParseDN(s)
	if err != nil {
		panic(err)
	}
	return dn
}

// Split a DN string into its RDNs, taking into account escaped commas and reversing the order.
func splitRDNs(s string) []string {
	if s == "" {
		return nil
	}
	a := make([]string, 0, 1)
	start := 0
	for i := 0; i < len(s); i++ {
		if s[i] == ',' {
			// Handle escaped comma
			slash_index := i - 1
			for slash_index >= 0 {
				if s[slash_index] != '\\' {
					break
				}
				slash_index--
			}
			if (i-slash_index)%2 == 1 {
				a = append(a, s[start:i])
				start = i + 1
			}
		}
	}
	a = append(a, s[start:])
	// Reverse the order
	for i, j := 0, len(a)-1; i < j; i, j = i+1, j-1 {
		a[i], a[j] = a[j], a[i]
	}
	return a
}

// Split an RDN string into its attributes, taking into account escaped plus signs.
func splitAttrs(s string) []string {
	if s == "" {
		return nil
	}
	a := make([]string, 0, 1)
	start := 0
	for i := 0; i < len(s); i++ {
		if s[i] == '+' {
			// Handle escaped plus
			slash_index := i - 1
			for slash_index >= 0 {
				if s[slash_index] != '\\' {
					break
				}
				slash_index--
			}
			if (i-slash_index)%2 == 1 {
				a = append(a, s[start:i])
				start = i + 1
			}
		}
	}
	a = append(a, s[start:])
	return a
}

// Split an attribute string into its type and value.
func splitAttr(s string) []string {
	return strings.SplitN(s, "=", 2)
}

// Decode an RFC4514 RDN attribute value string.
func DecodeRDNAttributeValue(s string) (string, error) {
	if len(s) == 0 {
		return s, nil
	}
	if s[0] == '#' {
		buf := make([]byte, 0, len(s)/2)
		for i := 1; i < len(s); i += 2 {
			b := (s[i]-'0')<<4 + (s[i+1] - '0')
			buf = append(buf, b)
		}
		s, err := BerReadElement(bytes.NewReader(buf))
		if err != nil {
			return "", err
		}
		if s.Type != BerTypeOctetString {
			return "", ErrWrongElementType.WithInfo("RDNAttribute type", s.Type)
		}
		return BerGetOctetString(s.Data), nil
	}
	buf := make([]byte, 0, len(s))
	for i := 0; i < len(s); i++ {
		b := s[i]
		if b == '\\' {
			if i+1 < len(s) {
				b2 := s[i+1]
				switch b2 {
				case '"', '+', ',', ';', '<', '>', ' ', '\\', '=', '#':
					buf = append(buf, b2)
					i++
				default:
					if i+2 < len(s) {
						bi, err := strconv.ParseUint(s[i+1:i+3], 16, 8)
						if err == nil {
							buf = append(buf, byte(bi))
							i += 2
						} else {
							buf = append(buf, b)
						}
					} else {
						buf = append(buf, b)
					}
				}
			}
		} else {
			buf = append(buf, b)
		}
	}
	return string(buf), nil
}