diff --git a/README.md b/README.md index b49ff6e..a9a7790 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # Go `netconf` client library -WARNING: This is still pre-1.0 and the API may still change however this library is being use at scale in production with good results. - [![Go Reference](https://pkg.go.dev/badge/github.com/nemith/netconf.svg)](https://pkg.go.dev/github.com/nemith/netconf) [![Report Card](https://goreportcard.com/badge/github.com/nemith/netconf)](https://goreportcard.com/report/github.com/nemith/netconf) [![stability-unstable](https://img.shields.io/badge/stability-unstable-yellow.svg)](https://github.com/emersion/stability-badges#unstable) @@ -10,8 +8,9 @@ WARNING: This is still pre-1.0 and the API may still change however this library This library is used to create client applications for connecting to network devices via NETCONF. -Like Go itself, only the latest two Go versions are tested and supported (Go 1.22 or Go 1.21). +Like Go itself, only the latest two Go versions are tested and supported (Go 1.24 or Go 1.23). +NOTICE: The API is pretty stable but not finalized yet. So changes may happen before a 1.0 release. Check for API changes when you upgrade. ## RFC Support @@ -45,11 +44,11 @@ See [TODO.md](TODO.md) for a list of what is left to implement these features. ### Differences from [`github.com/juniper/go-netconf/netconf`](https://pkg.go.dev/github.com/Juniper/go-netconf) -* **Much cleaner, idomatic API, less dumb** I, @nemith, was the original creator of the netconf package and it was my very first Go project and it shows. There are number of questionable API design, code, and a lot of odd un tested bugs. Really this rewrite was created to fix this. -* **No impled vendor ownership** Moving the project out of the `Juniper` organization allowes better control over the project, less implied support (or lack there of), and hopefully more contributions. -* **Transports are implemented in their own packages.** This means if you are not using SSH or TLS you don't need to bring in the underlying depdendencies into your binary. -* **Stream based transports.** Should mean less memory usage and much less allocation bringing overall performance higher. +- **Much cleaner, idomatic API, less dumb** I, @nemith, was the original creator of the netconf package and it was my very first Go project and it shows. There are number of questionable API design, code, and a lot of odd un tested bugs. Really this rewrite was created to fix this. +- **No impled vendor ownership** Moving the project out of the `Juniper` organization allowes better control over the project, less implied support (or lack there of), and hopefully more contributions. +- **Transports are implemented in their own packages.** This means if you are not using SSH or TLS you don't need to bring in the underlying depdendencies into your binary. +- **Stream based transports.** Should mean less memory usage and much less allocation bringing overall performance higher. ### Differences from [`github.com/scrapli/scrapligo/driver/netconf`](https://pkg.go.dev/github.com/scrapli/scrapligo/driver/netconf) -Scrapligo driver is quite good and way better than the original juniper project. However this new package concentrates more on RFC correctness and implementing some of the more advanced RFC features like call-home and event notifications. If there is a desire there could be some callaboration with scrapligo in the future. +Scrapligo driver is quite good and way better than the original juniper project. However this new package concentrates more on RFC correctness and implementing some of the more advanced RFC features like call-home and event notifications. If there is a desire there could be some callaboration with scrapligo in the future. diff --git a/go.mod b/go.mod index 02c4897..f25c27d 100644 --- a/go.mod +++ b/go.mod @@ -1,17 +1,18 @@ module github.com/nemith/netconf -go 1.21 -toolchain go1.23.6 +go 1.23.0 + +toolchain go1.24.1 require ( github.com/stretchr/testify v1.10.0 - golang.org/x/crypto v0.34.0 + golang.org/x/crypto v0.37.0 ) require ( github.com/davecgh/go-spew v1.1.1 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect golang.org/x/exp v0.0.0-20230817173708-d852ddb80c63 - golang.org/x/sys v0.30.0 // indirect + golang.org/x/sys v0.32.0 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect ) diff --git a/go.sum b/go.sum index 7a9c6a0..323b38b 100644 --- a/go.sum +++ b/go.sum @@ -4,14 +4,14 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= -golang.org/x/crypto v0.34.0 h1:+/C6tk6rf/+t5DhUketUbD1aNGqiSX3j15Z6xuIDlBA= -golang.org/x/crypto v0.34.0/go.mod h1:dy7dXNW32cAb/6/PRuTNsix8T+vJAqvuIy5Bli/x0YQ= +golang.org/x/crypto v0.37.0 h1:kJNSjF/Xp7kU0iB2Z+9viTPMW4EqqsrywMXLJOOsXSE= +golang.org/x/crypto v0.37.0/go.mod h1:vg+k43peMZ0pUMhYmVAWysMK35e6ioLh3wB8ZCAfbVc= golang.org/x/exp v0.0.0-20230817173708-d852ddb80c63 h1:m64FZMko/V45gv0bNmrNYoDEq8U5YUhetc9cBWKS1TQ= golang.org/x/exp v0.0.0-20230817173708-d852ddb80c63/go.mod h1:0v4NqG35kSWCMzLaMeX+IQrlSnVE/bqGSyC2cz/9Le8= -golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc= -golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/term v0.29.0 h1:L6pJp37ocefwRRtYPKSWOWzOtWSxVajvz2ldH/xi3iU= -golang.org/x/term v0.29.0/go.mod h1:6bl4lRlvVuDgSf3179VpIxBF0o10JUpXWOnI7nErv7s= +golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20= +golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= +golang.org/x/term v0.31.0 h1:erwDkOK1Msy6offm1mOgvspSkslFnIGsFnxOKoufg3o= +golang.org/x/term v0.31.0/go.mod h1:R4BeIy7D95HzImkxGkTW1UQTtP54tio2RyHz7PwK0aw= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= diff --git a/session.go b/session.go index f7f008e..15552d7 100644 --- a/session.go +++ b/session.go @@ -1,6 +1,7 @@ package netconf import ( + "bufio" "context" "encoding/xml" "errors" @@ -163,6 +164,54 @@ func (s *Session) ServerCapabilities() []string { return s.serverCaps.All() } +type peekReader struct { + br *bufio.Reader + offset int +} + +func newPeakReader(r io.Reader) *peekReader { + // Reuse a bufio reader if given one + br, ok := r.(*bufio.Reader) + if !ok { + br = bufio.NewReader(r) + } + + return &peekReader{br: br} +} + +func (r *peekReader) Read(p []byte) (int, error) { + buf, err := r.br.Peek(r.offset + len(p)) + if err != nil { + return 0, err + } + + available := len(buf) - r.offset + if available <= 0 { + return 0, io.EOF + } + + n := min(available, len(p)) + copy(p, buf[r.offset:r.offset+n]) + r.offset += n + return n, nil +} + +// ByteReader implements io.ByteReader (duh) but this is mostly what encoding/xml uses. +func (r *peekReader) ReadByte() (byte, error) { + buf, err := r.br.Peek(r.offset + 1) + if err != nil { + return 0, err + } + + if len(buf) <= r.offset { + return 0, io.EOF + } + + b := buf[r.offset] + r.offset++ + return b, nil +} + // startElement will walk though a xml.Decode until it finds a start element // and returns it. func startElement(d *xml.Decoder) (*xml.StartElement, error) {