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 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
|
package secrets
import (
"fmt"
"net/url"
"strings"
"time"
"github.com/gophercloud/gophercloud"
"github.com/gophercloud/gophercloud/pagination"
)
// DateFilter represents a valid filter to use for filtering
// secrets by their date during a list.
type DateFilter string
const (
DateFilterGT DateFilter = "gt"
DateFilterGTE DateFilter = "gte"
DateFilterLT DateFilter = "lt"
DateFilterLTE DateFilter = "lte"
)
// DateQuery represents a date field to be used for listing secrets.
// If no filter is specified, the query will act as if "equal" is used.
type DateQuery struct {
Date time.Time
Filter DateFilter
}
// SecretType represents a valid secret type.
type SecretType string
const (
SymmetricSecret SecretType = "symmetric"
PublicSecret SecretType = "public"
PrivateSecret SecretType = "private"
PassphraseSecret SecretType = "passphrase"
CertificateSecret SecretType = "certificate"
OpaqueSecret SecretType = "opaque"
)
// ListOptsBuilder allows extensions to add additional parameters to
// the List request
type ListOptsBuilder interface {
ToSecretListQuery() (string, error)
}
// ListOpts provides options to filter the List results.
type ListOpts struct {
// Offset is the starting index within the total list of the secrets that
// you would like to retrieve.
Offset int `q:"offset"`
// Limit is the maximum number of records to return.
Limit int `q:"limit"`
// Name will select all secrets with a matching name.
Name string `q:"name"`
// Alg will select all secrets with a matching algorithm.
Alg string `q:"alg"`
// Mode will select all secrets with a matching mode.
Mode string `q:"mode"`
// Bits will select all secrets with a matching bit length.
Bits int `q:"bits"`
// SecretType will select all secrets with a matching secret type.
SecretType SecretType `q:"secret_type"`
// ACLOnly will select all secrets with an ACL that contains the user.
ACLOnly *bool `q:"acl_only"`
// CreatedQuery will select all secrets with a created date matching
// the query.
CreatedQuery *DateQuery
// UpdatedQuery will select all secrets with an updated date matching
// the query.
UpdatedQuery *DateQuery
// ExpirationQuery will select all secrets with an expiration date
// matching the query.
ExpirationQuery *DateQuery
// Sort will sort the results in the requested order.
Sort string `q:"sort"`
}
// ToSecretListQuery formats a ListOpts into a query string.
func (opts ListOpts) ToSecretListQuery() (string, error) {
q, err := gophercloud.BuildQueryString(opts)
params := q.Query()
if opts.CreatedQuery != nil {
created := opts.CreatedQuery.Date.Format(time.RFC3339)
if v := opts.CreatedQuery.Filter; v != "" {
created = fmt.Sprintf("%s:%s", v, created)
}
params.Add("created", created)
}
if opts.UpdatedQuery != nil {
updated := opts.UpdatedQuery.Date.Format(time.RFC3339)
if v := opts.UpdatedQuery.Filter; v != "" {
updated = fmt.Sprintf("%s:%s", v, updated)
}
params.Add("updated", updated)
}
if opts.ExpirationQuery != nil {
expiration := opts.ExpirationQuery.Date.Format(time.RFC3339)
if v := opts.ExpirationQuery.Filter; v != "" {
expiration = fmt.Sprintf("%s:%s", v, expiration)
}
params.Add("expiration", expiration)
}
q = &url.URL{RawQuery: params.Encode()}
return q.String(), err
}
// List retrieves a list of Secrets.
func List(client *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager {
url := listURL(client)
if opts != nil {
query, err := opts.ToSecretListQuery()
if err != nil {
return pagination.Pager{Err: err}
}
url += query
}
return pagination.NewPager(client, url, func(r pagination.PageResult) pagination.Page {
return SecretPage{pagination.LinkedPageBase{PageResult: r}}
})
}
// Get retrieves details of a secrets.
func Get(client *gophercloud.ServiceClient, id string) (r GetResult) {
_, r.Err = client.Get(getURL(client, id), &r.Body, nil)
return
}
// GetPayloadOpts represents options used for obtaining a payload.
type GetPayloadOpts struct {
PayloadContentType string `h:"Accept"`
}
// GetPayloadOptsBuilder allows extensions to add additional parameters to
// the GetPayload request.
type GetPayloadOptsBuilder interface {
ToSecretPayloadGetParams() (map[string]string, error)
}
// ToSecretPayloadGetParams formats a GetPayloadOpts into a query string.
func (opts GetPayloadOpts) ToSecretPayloadGetParams() (map[string]string, error) {
return gophercloud.BuildHeaders(opts)
}
// GetPayload retrieves the payload of a secret.
func GetPayload(client *gophercloud.ServiceClient, id string, opts GetPayloadOptsBuilder) (r PayloadResult) {
h := map[string]string{"Accept": "text/plain"}
if opts != nil {
headers, err := opts.ToSecretPayloadGetParams()
if err != nil {
r.Err = err
return
}
for k, v := range headers {
h[k] = v
}
}
url := payloadURL(client, id)
resp, err := client.Get(url, nil, &gophercloud.RequestOpts{
MoreHeaders: h,
OkCodes: []int{200},
})
if resp != nil {
r.Header = resp.Header
r.Body = resp.Body
}
r.Err = err
return
}
// CreateOptsBuilder allows extensions to add additional parameters to
// the Create request.
type CreateOptsBuilder interface {
ToSecretCreateMap() (map[string]interface{}, error)
}
// CreateOpts provides options used to create a secrets.
type CreateOpts struct {
// Algorithm is the algorithm of the secret.
Algorithm string `json:"algorithm,omitempty"`
// BitLength is the bit length of the secret.
BitLength int `json:"bit_length,omitempty"`
// Mode is the mode of encryption for the secret.
Mode string `json:"mode,omitempty"`
// Name is the name of the secret
Name string `json:"name,omitempty"`
// Payload is the secret.
Payload string `json:"payload,omitempty"`
// PayloadContentType is the content type of the payload.
PayloadContentType string `json:"payload_content_type,omitempty"`
// PayloadContentEncoding is the content encoding of the payload.
PayloadContentEncoding string `json:"payload_content_encoding,omitempty"`
// SecretType is the type of secret.
SecretType SecretType `json:"secret_type,omitempty"`
}
// ToSecretCreateMap formats a CreateOpts into a create request.
func (opts CreateOpts) ToSecretCreateMap() (map[string]interface{}, error) {
return gophercloud.BuildRequestBody(opts, "")
}
// Create creates a new secrets.
func Create(client *gophercloud.ServiceClient, opts CreateOptsBuilder) (r CreateResult) {
b, err := opts.ToSecretCreateMap()
if err != nil {
r.Err = err
return
}
_, r.Err = client.Post(createURL(client), &b, &r.Body, &gophercloud.RequestOpts{
OkCodes: []int{201},
})
return
}
// Delete deletes a secrets.
func Delete(client *gophercloud.ServiceClient, id string) (r DeleteResult) {
_, r.Err = client.Delete(deleteURL(client, id), nil)
return
}
// UpdateOptsBuilder allows extensions to add additional parameters to
// the Update request.
type UpdateOptsBuilder interface {
ToSecretUpdateRequest() (string, map[string]string, error)
}
// UpdateOpts represents parameters to add a payload to an existing
// secret which does not already contain a payload.
type UpdateOpts struct {
// ContentType represents the content type of the payload.
ContentType string `h:"Content-Type"`
// ContentEncoding represents the content encoding of the payload.
ContentEncoding string `h:"Content-Encoding"`
// Payload is the payload of the secret.
Payload string
}
// ToUpdateCreateRequest formats a UpdateOpts into an update request.
func (opts UpdateOpts) ToSecretUpdateRequest() (string, map[string]string, error) {
h, err := gophercloud.BuildHeaders(opts)
if err != nil {
return "", nil, err
}
return opts.Payload, h, nil
}
// Update modifies the attributes of a secrets.
func Update(client *gophercloud.ServiceClient, id string, opts UpdateOptsBuilder) (r UpdateResult) {
url := updateURL(client, id)
h := make(map[string]string)
var b string
if opts != nil {
payload, headers, err := opts.ToSecretUpdateRequest()
if err != nil {
r.Err = err
return
}
for k, v := range headers {
h[k] = v
}
b = payload
}
resp, err := client.Put(url, nil, nil, &gophercloud.RequestOpts{
RawBody: strings.NewReader(b),
MoreHeaders: h,
OkCodes: []int{204},
})
r.Err = err
if resp != nil {
r.Header = resp.Header
}
return
}
// GetMetadata will list metadata for a given secret.
func GetMetadata(client *gophercloud.ServiceClient, secretID string) (r MetadataResult) {
_, r.Err = client.Get(metadataURL(client, secretID), &r.Body, nil)
return
}
// MetadataOpts is a map that contains key-value pairs for secret metadata.
type MetadataOpts map[string]string
// CreateMetadataOptsBuilder allows extensions to add additional parameters to
// the CreateMetadata request.
type CreateMetadataOptsBuilder interface {
ToMetadataCreateMap() (map[string]interface{}, error)
}
// ToMetadataCreateMap converts a MetadataOpts into a request body.
func (opts MetadataOpts) ToMetadataCreateMap() (map[string]interface{}, error) {
return map[string]interface{}{"metadata": opts}, nil
}
// CreateMetadata will set metadata for a given secret.
func CreateMetadata(client *gophercloud.ServiceClient, secretID string, opts CreateMetadataOptsBuilder) (r MetadataCreateResult) {
b, err := opts.ToMetadataCreateMap()
if err != nil {
r.Err = err
return
}
_, r.Err = client.Put(metadataURL(client, secretID), b, &r.Body, &gophercloud.RequestOpts{
OkCodes: []int{201},
})
return
}
// GetMetadatum will get a single key/value metadata from a secret.
func GetMetadatum(client *gophercloud.ServiceClient, secretID string, key string) (r MetadatumResult) {
_, r.Err = client.Get(metadatumURL(client, secretID, key), &r.Body, nil)
return
}
// MetadatumOpts represents a single metadata.
type MetadatumOpts struct {
Key string `json:"key" required:"true"`
Value string `json:"value" required:"true"`
}
// CreateMetadatumOptsBuilder allows extensions to add additional parameters to
// the CreateMetadatum request.
type CreateMetadatumOptsBuilder interface {
ToMetadatumCreateMap() (map[string]interface{}, error)
}
// ToMetadatumCreateMap converts a MetadatumOpts into a request body.
func (opts MetadatumOpts) ToMetadatumCreateMap() (map[string]interface{}, error) {
return gophercloud.BuildRequestBody(opts, "")
}
// CreateMetadatum will add a single key/value metadata to a secret.
func CreateMetadatum(client *gophercloud.ServiceClient, secretID string, opts CreateMetadatumOptsBuilder) (r MetadatumCreateResult) {
b, err := opts.ToMetadatumCreateMap()
if err != nil {
r.Err = err
return
}
_, r.Err = client.Post(metadataURL(client, secretID), b, &r.Body, &gophercloud.RequestOpts{
OkCodes: []int{201},
})
return
}
// UpdateMetadatumOptsBuilder allows extensions to add additional parameters to
// the UpdateMetadatum request.
type UpdateMetadatumOptsBuilder interface {
ToMetadatumUpdateMap() (map[string]interface{}, string, error)
}
// ToMetadatumUpdateMap converts a MetadataOpts into a request body.
func (opts MetadatumOpts) ToMetadatumUpdateMap() (map[string]interface{}, string, error) {
b, err := gophercloud.BuildRequestBody(opts, "")
return b, opts.Key, err
}
// UpdateMetadatum will update a single key/value metadata to a secret.
func UpdateMetadatum(client *gophercloud.ServiceClient, secretID string, opts UpdateMetadatumOptsBuilder) (r MetadatumResult) {
b, key, err := opts.ToMetadatumUpdateMap()
if err != nil {
r.Err = err
return
}
_, r.Err = client.Put(metadatumURL(client, secretID, key), b, &r.Body, &gophercloud.RequestOpts{
OkCodes: []int{200},
})
return
}
// DeleteMetadatum will delete an individual metadatum from a secret.
func DeleteMetadatum(client *gophercloud.ServiceClient, secretID string, key string) (r MetadatumDeleteResult) {
_, r.Err = client.Delete(metadatumURL(client, secretID, key), nil)
return
}
|