rndc

README

rndc-go

bind9 服务使用的 rndc 协议的 go 版本客户端，仅支持协议版本1

Installation

go get github.com/ZXiangQAQ/rndc-go

Quickstart

import (
	"fmt"
	"github.com/ZXiangQAQ/rndc-go"
)

func main() {
	// 默认日志等级为 info
	rndc.SetLevelByString("error")

	// 创建 RnDC client
	client, err := rndc.NewRNDCClient("your bind9 server address", "algo", "secret")
	if err != nil {
            fmt.Printf("conn failed, err: %s\n", err.Error())
	}

	// 请求 RnDC 服务器, 并同步获取结果
	resp, err := client.Call("sync test123.com")
	if err != nil {
	    fmt.Printf("client call err: %s\n", err.Error())
	}

	// 获取 bind 返回的原生 response
	fmt.Printf("response: %s\n", resp)

	// 获取指令内容
	fmt.Printf("cmd: %s\n", resp.Data.Type)

	// 获取返回码, 类型是 string
	fmt.Printf("result: %s\n", resp.Data.Result)

	// 获取返回内容, 类型是 string
	fmt.Printf("text: %s\n", resp.Data.Text)

	// 获取错误, 类型是 string
	fmt.Printf("err: %s\n", resp.Data.Err)
}

Feature

• 目前使用硬编码进行序列化和反序列化，计划基于 tag 标签和 rndc 的编码规范，实现动态 Marshal 和 Unmarshal

Documentation

Index

• Constants
• func Critical(ctx context.Context, format string, v ...interface{})
• func Debug(ctx context.Context, format string, v ...interface{})
• func Error(ctx context.Context, format string, v ...interface{})
• func Info(ctx context.Context, format string, v ...interface{})
• func SetLevelByString(level string)
• func SetOutput(output io.Writer)
• func Warn(ctx context.Context, format string, v ...interface{})
• type AuthRequest
  • func (s *AuthRequest) Serialize() ([]byte, error)
• type AuthResponse
  • func (r *AuthResponse) DeSerialize(input []byte) error
  • func (r *AuthResponse) String() string
• type CmdRequest
  • func (s *CmdRequest) Serialize() ([]byte, error)
• type CmdResponse
  • func (r *CmdResponse) DeSerialize(input []byte) error
  • func (r *CmdResponse) String() string
• type CtrlRequest
  • func (c *CtrlRequest) Serialize() ([]byte, error)
• type CtrlResponse
  • func (r *CtrlResponse) DeSerialize(input []byte) error
  • func (r *CtrlResponse) String() string
• type DataRequest
  • func (s *DataRequest) Serialize() ([]byte, error)
• type DataResponse
  • func (r *DataResponse) DeSerialize(input []byte) error
  • func (r *DataResponse) String() string
• type Level
  • func StringToLevel(level string) Level
  • func (level Level) String() string
• type Logger
  • func NewLogger() *Logger
  • func (logger *Logger) Critical(ctx context.Context, format string, args ...interface{})
  • func (logger *Logger) Debug(ctx context.Context, format string, args ...interface{})
  • func (logger *Logger) Error(ctx context.Context, format string, args ...interface{})
  • func (logger *Logger) HideCallstack() *Logger
  • func (logger *Logger) Info(ctx context.Context, format string, args ...interface{})
  • func (logger *Logger) SetLevel(level Level)
  • func (logger *Logger) SetLevelByString(level string)
  • func (logger *Logger) SetOutput(output io.Writer) *Logger
  • func (logger *Logger) Warn(ctx context.Context, format string, args ...interface{})
  • func (logger *Logger) WithDepth(depth int) *Logger
• type RnDC
  • func NewRNDCClient(host, algo, secret string) (*RnDC, error)
  • func (c *RnDC) Call(cmd string) (*CmdResponse, error)
• type Serializable

Constants

const (
	ProtocolVersion = 1
)

Functions

func Critical

func Critical(ctx context.Context, format string, v ...interface{})

func Debug

func Debug(ctx context.Context, format string, v ...interface{})

func Error

func Error(ctx context.Context, format string, v ...interface{})

func Info

func Info(ctx context.Context, format string, v ...interface{})

func SetLevelByString

func SetLevelByString(level string)

func SetOutput

func SetOutput(output io.Writer)

func Warn

func Warn(ctx context.Context, format string, v ...interface{})

Types

type AuthRequest

type AuthRequest struct {
	Hash []byte `json:"hsha,omitempty"`
	Md5  []byte `json:"md5,omitempty"`
}

func (*AuthRequest) Serialize

func (s *AuthRequest) Serialize() ([]byte, error)

type AuthResponse

type AuthResponse struct {
	Hash []byte `json:"hsha,omitempty"`
	Md5  []byte `json:"md5,omitempty"`
}

func (*AuthResponse) DeSerialize

func (r *AuthResponse) DeSerialize(input []byte) error

func (*AuthResponse) String

func (r *AuthResponse) String() string

实现 String() 方法以自定义打印格式

type CmdRequest

type CmdRequest struct {
	Auth *AuthRequest `json:"_auth,omitempty"`
	Ctrl *CtrlRequest `json:"_ctrl"`
	Data *DataRequest `json:"_data"`
}

func (*CmdRequest) Serialize

func (s *CmdRequest) Serialize() ([]byte, error)

type CmdResponse

type CmdResponse struct {
	Auth *AuthResponse `json:"_auth"`
	Ctrl *CtrlResponse `json:"_ctrl"`
	Data *DataResponse `json:"_data"`
}

func (*CmdResponse) DeSerialize

func (r *CmdResponse) DeSerialize(input []byte) error

func (*CmdResponse) String

func (r *CmdResponse) String() string

实现 String() 方法以自定义打印格式

type CtrlRequest

type CtrlRequest struct {
	Ser   string `json:"_ser"`
	Tim   string `json:"_tim"`
	Exp   string `json:"_exp"`
	Nonce string `json:"_nonce,omitempty"`
}

func (*CtrlRequest) Serialize

func (c *CtrlRequest) Serialize() ([]byte, error)

type CtrlResponse

type CtrlResponse struct {
	Ser   string `json:"_ser"`
	Tim   string `json:"_tim"`
	Exp   string `json:"_exp"`
	Rpl   string `json:"_rpl"`
	Nonce string `json:"_nonce,omitempty"`
}

func (*CtrlResponse) DeSerialize

func (r *CtrlResponse) DeSerialize(input []byte) error

func (*CtrlResponse) String

func (r *CtrlResponse) String() string

实现 String() 方法以自定义打印格式

type DataRequest

type DataRequest struct {
	Type string `json:"type"`
}

func (*DataRequest) Serialize

func (s *DataRequest) Serialize() ([]byte, error)

type DataResponse

type DataResponse struct {
	Type   string `json:"type"`
	Result string `json:"result"`
	Err    string `json:"err"`
	Text   string `json:"text"`
}

func (*DataResponse) DeSerialize

func (r *DataResponse) DeSerialize(input []byte) error

func (*DataResponse) String

func (r *DataResponse) String() string

实现 String() 方法以自定义打印格式

type Level

type Level uint32

const (
	CriticalLevel Level = iota
	ErrorLevel
	WarnLevel
	InfoLevel
	DebugLevel
)

func StringToLevel

func StringToLevel(level string) Level

func (Level) String

func (level Level) String() string

type Logger

type Logger struct {
	Level Level
	// contains filtered or unexported fields
}

func NewLogger

func NewLogger() *Logger

func (*Logger) Critical

func (logger *Logger) Critical(ctx context.Context, format string, args ...interface{})

func (*Logger) Debug

func (logger *Logger) Debug(ctx context.Context, format string, args ...interface{})

func (*Logger) Error

func (logger *Logger) Error(ctx context.Context, format string, args ...interface{})

func (*Logger) HideCallstack

func (logger *Logger) HideCallstack() *Logger

func (*Logger) Info

func (logger *Logger) Info(ctx context.Context, format string, args ...interface{})

func (*Logger) SetLevel

func (logger *Logger) SetLevel(level Level)

func (*Logger) SetLevelByString

func (logger *Logger) SetLevelByString(level string)

func (*Logger) SetOutput

func (logger *Logger) SetOutput(output io.Writer) *Logger

func (*Logger) Warn

func (logger *Logger) Warn(ctx context.Context, format string, args ...interface{})

func (*Logger) WithDepth

func (logger *Logger) WithDepth(depth int) *Logger

type RnDC

type RnDC struct {
	// contains filtered or unexported fields
}

func NewRNDCClient

func NewRNDCClient(host, algo, secret string) (*RnDC, error)

NewRNDCClient create rndc client host - (ip, port) tuple algo - HMAC algorithm: one of md5, sha1, sha224, sha256, sha384, sha512

(with optional prefix 'hmac-')

secret - HMAC secret, base64 encoded

func (*RnDC) Call

func (c *RnDC) Call(cmd string) (*CmdResponse, error)

type Serializable

type Serializable interface {
	Serialize() ([]byte, error)
}