forked from Juniper/go-netconf
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rpc.go
174 lines (146 loc) · 5.12 KB
/
rpc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
// Go NETCONF Client
//
// Copyright (c) 2013-2018, Juniper Networks, Inc. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package netconf
import (
"bytes"
"crypto/rand"
"encoding/xml"
"fmt"
"io"
)
const (
editConfigXml = `<edit-config>
<target><%s/></target>
<default-operation>merge</default-operation>
<error-option>rollback-on-error</error-option>
<config>%s</config>
</edit-config>`
)
// RPCMessage represents an RPC Message to be sent.
type RPCMessage struct {
MessageID string
Methods []RPCMethod
}
// NewRPCMessage generates a new RPC Message structure with the provided methods
func NewRPCMessage(methods []RPCMethod) *RPCMessage {
return &RPCMessage{
MessageID: msgID(),
Methods: methods,
}
}
// MarshalXML marshals the NETCONF XML data
func (m *RPCMessage) MarshalXML(e *xml.Encoder, start xml.StartElement) error {
var buf bytes.Buffer
for _, method := range m.Methods {
buf.WriteString(method.MarshalMethod())
}
data := struct {
MessageID string `xml:"message-id,attr"`
Xmlns string `xml:"xmlns,attr"`
Methods []byte `xml:",innerxml"`
}{
m.MessageID,
"urn:ietf:params:xml:ns:netconf:base:1.0",
buf.Bytes(),
}
// Wrap the raw XML (data) into <rpc>...</rpc> tags
start.Name.Local = "rpc"
return e.EncodeElement(data, start)
}
// RPCReply defines a reply to a RPC request
type RPCReply struct {
XMLName xml.Name `xml:"rpc-reply"`
Errors []RPCError `xml:"rpc-error,omitempty"`
Data string `xml:",innerxml"`
Ok bool `xml:",omitempty"`
RawReply string `xml:"-"`
MessageID string `xml:"-"`
}
func newRPCReply(rawXML []byte, ErrOnWarning bool, messageID string) (*RPCReply, error) {
reply := &RPCReply{}
reply.RawReply = string(rawXML)
if err := xml.Unmarshal(rawXML, reply); err != nil {
return nil, err
}
// will return a valid reply so setting Requests message id
reply.MessageID = messageID
if reply.Errors != nil {
for _, rpcErr := range reply.Errors {
if rpcErr.Severity == "error" || ErrOnWarning {
return reply, &rpcErr
}
}
}
return reply, nil
}
// RPCError defines an error reply to a RPC request
type RPCError struct {
Type string `xml:"error-type"`
Tag string `xml:"error-tag"`
Severity string `xml:"error-severity"`
Path string `xml:"error-path"`
Message string `xml:"error-message"`
Info string `xml:",innerxml"`
}
// Error generates a string representation of the provided RPC error
func (re *RPCError) Error() string {
return fmt.Sprintf("netconf rpc [%s] '%s'", re.Severity, re.Message)
}
// RPCMethod defines the interface for creating an RPC method.
type RPCMethod interface {
MarshalMethod() string
}
// RawMethod defines how a raw text request will be responded to
type RawMethod string
// MarshalMethod converts the method's output into a string
func (r RawMethod) MarshalMethod() string {
return string(r)
}
// MethodLock files a NETCONF lock target request with the remote host
func MethodLock(target string) RawMethod {
return RawMethod(fmt.Sprintf("<lock><target><%s/></target></lock>", target))
}
// MethodUnlock files a NETCONF unlock target request with the remote host
func MethodUnlock(target string) RawMethod {
return RawMethod(fmt.Sprintf("<unlock><target><%s/></target></unlock>", target))
}
// MethodGetConfig files a NETCONF get-config source request with the remote host
func MethodGetConfig(source string) RawMethod {
return RawMethod(fmt.Sprintf("<get-config><source><%s/></source></get-config>", source))
}
// MethodGetConfigFiltered files a NETCONF get-config source request with the remote host with a filter
func MethodGetConfigFiltered(source string, filterType string, dataXml string) RawMethod {
if filterType == "xpath" {
return RawMethod(fmt.Sprintf("<get-config><source><%s/></source><filter type=\"xpath\" select=\"%s\"/></get-config>", source, dataXml))
} else if filterType == "subtree" {
return RawMethod(fmt.Sprintf("<get-config><source><%s/></source><filter type=\"subtree\">%s</filter></get-config>", source, dataXml))
}
// if the filter type was not recognized, return a non-filtered get
return RawMethod(fmt.Sprintf("<get-config><source><%s/></source></get-config>", source))
}
// MethodGet files a NETCONF get source request with the remote host
func MethodGet(filterType string, dataXml string) RawMethod {
if filterType == "subtree" {
return RawMethod(fmt.Sprintf("<get><filter type=\"%s\">%s</filter></get>", filterType, dataXml))
}
if filterType == "xpath" {
return RawMethod(fmt.Sprintf("<get><filter type=\"%s\" select=\"%s\"/></get>", filterType, dataXml))
}
return RawMethod("<get/>")
}
// MethodEditConfig files a NETCONF edit-config request with the remote host
func MethodEditConfig(database string, dataXml string) RawMethod {
return RawMethod(fmt.Sprintf(editConfigXml, database, dataXml))
}
var msgID = uuid
// uuid generates a "good enough" uuid without adding external dependencies
func uuid() string {
b := make([]byte, 16)
io.ReadFull(rand.Reader, b)
b[6] = (b[6] & 0x0f) | 0x40
b[8] = (b[8] & 0x3f) | 0x80
return fmt.Sprintf("%x-%x-%x-%x-%x", b[0:4], b[4:6], b[6:8], b[8:10], b[10:])
}