-
Notifications
You must be signed in to change notification settings - Fork 26
/
otxapi.go
275 lines (230 loc) · 7.4 KB
/
otxapi.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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
package otxapi
import (
"bytes"
"encoding/json"
"fmt"
"github.com/google/go-querystring/query"
"io"
"io/ioutil"
"net/http"
"net/url"
"os"
"reflect"
)
const (
get = "GET"
libraryVersion = "0.1"
userAgent = "go-otx-api/" + libraryVersion
defaultBaseURL = "https://otx.alienvault.com/"
subscriptionsURLPath = "api/v1/pulses/subscribed"
pulseDetailURLPath = "api/v1/pulses/"
userURLPath = "api/v1/user/"
apiVersion = "v1"
)
// A Client manages communication with the OTX API.
type Client struct {
// HTTP client used to communicate with the API.
client *http.Client
// Base URL for API requests. Defaults to the otx.alienvault.com:443.
// BaseURL should always be specified with a trailing slash
BaseURL *url.URL
UserAgent string
// OTX API Services
UserDetail *OTXUserDetailService
PulseDetail *OTXPulseDetailService
ThreatIntel *OTXThreatIntelFeedService
}
// Response is a otx API response. This wraps the standard http.Response
// returned from OTX and provides convenient access to things like
// pagination links.
type Response struct {
*http.Response
// RawContent - raw stream
RawContent []uint8
// Content - additional way to access the content body of the response.
Content map[string]interface{} `json:"results,omitempty"`
}
// ListOptions specifies the optional parameters to various List methods that
// support pagination. our list options: ?limit=50&page_num=1
type ListOptions struct {
// For paginated result sets, page of results to retrieve.
Page int `url:"page,omitempty"`
// For paginated result sets, the number of results to include per page.
PerPage int `url:"limit,omitempty"`
}
// addOptions adds the parameters in opt as URL query parameters to s. opt
// must be a struct whose fields may contain "url" tags.
func addOptions(s string, opt interface{}) (string, error) {
v := reflect.ValueOf(opt)
if v.Kind() == reflect.Ptr && v.IsNil() {
return s, nil
}
u, err := url.Parse(s)
if err != nil {
return s, err
}
qs, err := query.Values(opt)
if err != nil {
return s, err
}
u.RawQuery = qs.Encode()
return u.String(), nil
}
func (c *OTXPulseDetailService) Get(id_string string) (PulseDetail, Response, error) {
client := &http.Client{}
req, _ := http.NewRequest(get, fmt.Sprintf("%s/%s/%s/", defaultBaseURL, pulseDetailURLPath, id_string), nil)
req.Header.Set("X-OTX-API-KEY", fmt.Sprintf("%s", os.Getenv("X_OTX_API_KEY")))
response, _ := client.Do(req)
resp := Response{Response: response}
contents, err := ioutil.ReadAll(response.Body)
if err != nil {
fmt.Printf("%s", err)
os.Exit(1)
}
pulse_detail := new(PulseDetail)
json.Unmarshal(contents, &(pulse_detail))
json.Unmarshal(contents, &(resp.Content))
return *pulse_detail, resp, err
}
func (c *OTXThreatIntelFeedService) List(opt *ListOptions) (ThreatIntelFeed, Response, error) {
client := &http.Client{}
requestpath, err := addOptions(defaultBaseURL + subscriptionsURLPath, opt)
if err != nil {
return ThreatIntelFeed{}, Response{}, err
}
req, _ := http.NewRequest(get, requestpath, nil)
req.Header.Set("X-OTX-API-KEY", fmt.Sprintf("%s", os.Getenv("X_OTX_API_KEY")))
response, _ := client.Do(req)
resp := Response{Response: response}
contents, err := ioutil.ReadAll(response.Body)
if err != nil {
fmt.Printf("%s", err)
os.Exit(1)
}
pulse_list := new(ThreatIntelFeed)
err = json.Unmarshal(contents, &(pulse_list))
json.Unmarshal(contents, &(resp.Content))
if err != nil {
fmt.Println("error not nil on json unmarshall")
fmt.Println(err)
}
return *pulse_list, resp, err
}
func (c *OTXUserDetailService) Get() (UserDetail, *Response, error) {
req, err := c.client.NewRequest(get, userURLPath, nil)
if err != nil {
return UserDetail{}, nil, err
}
req.Header.Set("X-OTX-API-KEY", fmt.Sprintf("%s", os.Getenv("X_OTX_API_KEY")))
userdetail := &UserDetail{}
resp, err := c.client.Do(req, userdetail)
if err != nil {
return UserDetail{}, resp, err
}
err = json.Unmarshal(resp.RawContent, &(userdetail))
json.Unmarshal(resp.RawContent, &(resp.Content))
return *userdetail, resp, err
}
// NewClient returns a new OTX API client. If a nil httpClient is
// provided, http.DefaultClient will be used.
func NewClient(httpClient *http.Client) *Client {
if httpClient == nil {
httpClient = http.DefaultClient
}
baseURL, _ := url.Parse(defaultBaseURL)
c := &Client{client: httpClient, BaseURL: baseURL, UserAgent: userAgent}
c.UserDetail = &OTXUserDetailService{client: c}
return c
}
// Do sends an API request and returns the API response. The API response is
// JSON decoded and stored in the value pointed to by v, or returned as an
// error if an API error has occurred. If v implements the io.Writer
// interface, the raw response body will be written to v, without attempting to
// first decode it.
func (c *Client) Do(req *http.Request, v interface{}) (*Response, error) {
resp, err := c.client.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
response := newResponse(resp)
// check response for error
err = CheckResponse(resp)
if err != nil {
// even though there was an error, we still return the response
// in case the caller wants to inspect it further
return response, err
}
content, err := ioutil.ReadAll(resp.Body)
if err != nil {
fmt.Printf("%s", err)
os.Exit(1)
}
response.RawContent = content
return response, err
}
// NewRequest creates an API request. A relative URL can be provided in urlStr,
// in which case it is resolved relative to the BaseURL of the Client.
// Relative URLs should always be specified without a preceding slash. If
// specified, the value pointed to by body is JSON encoded and included as the
// request body.
func (c *Client) NewRequest(method, urlStr string, body interface{}) (*http.Request, error) {
rel, err := url.Parse(urlStr)
if err != nil {
return nil, err
}
u := c.BaseURL.ResolveReference(rel)
var buf io.ReadWriter
if body != nil {
buf = new(bytes.Buffer)
err := json.NewEncoder(buf).Encode(body)
if err != nil {
return nil, err
}
}
req, err := http.NewRequest(method, u.String(), buf)
if err != nil {
return nil, err
}
if c.UserAgent != "" {
req.Header.Add("User-Agent", c.UserAgent)
}
return req, nil
}
// newResponse creates a new Response for the provided http.Response.
func newResponse(r *http.Response) *Response {
response := &Response{Response: r}
return response
}
// CheckResponse checks the API response for errors, and returns them if
// present. A response is considered an error if it has a status code outside
// the 200 range. API error responses are expected to have either no response
// body, or a JSON response body that maps to ErrorResponse. Any other
// response body will be silently ignored.
func CheckResponse(r *http.Response) error {
if c := r.StatusCode; 200 <= c && c <= 299 {
return nil
}
errorResponse := &ErrorResponse{Response: r}
data, err := ioutil.ReadAll(r.Body)
if err == nil && data != nil {
json.Unmarshal(data, errorResponse)
}
return errorResponse
}
type Error struct {
Message string
}
func (e *Error) Error() string {
return fmt.Sprintf("error: %v",
e.Message)
}
type ErrorResponse struct {
Response *http.Response // HTTP response that caused this error
Message string `json:"detail"` // error message
}
func (r *ErrorResponse) Error() string {
return fmt.Sprintf("%v %v: %d %v",
r.Response.Request.Method, r.Response.Request.URL,
r.Response.StatusCode, r.Message)
}