← Back to branch summary

~nskaggs/+junk/xenial-test

« back to all changes in this revision

Viewing changes to src/github.com/juju/juju/audit/audit.go

  • Committer: Nicholas Skaggs
  • Date: 2016-10-24 20:56:05 UTC
  • Revision ID: nicholas.skaggs@canonical.com-20161024205605-z8lta0uvuhtxwzwl
Initi with beta15

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/github.com/juju/juju/audit/audit.go
 
1
// Copyright 2016 Canonical Ltd.
 
2
// Licensed under the AGPLv3, see LICENCE file for details.
 
3
 
 
4
// Package audit records auditable events
 
5
package audit
 
6
 
 
7
import (
 
8
        "time"
 
9
 
 
10
        "github.com/juju/errors"
 
11
        "github.com/juju/utils"
 
12
        "github.com/juju/version"
 
13
)
 
14
 
 
15
// AuditEntrySinkFn defines a function which will send an
 
16
// AuditEntry to a backing store and return an error upon failure.
 
17
type AuditEntrySinkFn func(AuditEntry) error
 
18
 
 
19
// AuditEntry represents an auditted event.
 
20
type AuditEntry struct {
 
21
        // JujuServerVersion is the version of the jujud that recorded
 
22
        // this AuditEntry.
 
23
        JujuServerVersion version.Number
 
24
        // ModelUUID is the ID of the model the audit entry was written
 
25
        // on.
 
26
        ModelUUID string
 
27
        // Timestamp is when the audit entry was generated. It must be
 
28
        // stored with the UTC locale.
 
29
        Timestamp time.Time
 
30
        // RemoteAddress is the IP of the machine from which the
 
31
        // audit-event was triggered.
 
32
        RemoteAddress string
 
33
        // OriginType is the type of entity (e.g. model, user, action)
 
34
        // which triggered the audit event.
 
35
        OriginType string
 
36
        // OriginName is the name of the origin which triggered the
 
37
        // audit-event.
 
38
        OriginName string
 
39
        // Operation is the operation that was performed that triggered
 
40
        // the audit event.
 
41
        Operation string
 
42
        // Data is a catch-all for storing random data.
 
43
        Data map[string]interface{}
 
44
}
 
45
 
 
46
// Validate ensures that the entry considers itself to be in a
 
47
// complete and valid state.
 
48
func (e AuditEntry) Validate() error {
 
49
        if e.JujuServerVersion == version.Zero {
 
50
                return errors.NewNotValid(errors.NotAssignedf("JujuServerVersion"), "")
 
51
        }
 
52
        if e.ModelUUID == "" {
 
53
                return errors.NewNotValid(errors.NotAssignedf("ModelUUID"), "")
 
54
        }
 
55
        if utils.IsValidUUIDString(e.ModelUUID) == false {
 
56
                return errors.NotValidf("ModelUUID")
 
57
        }
 
58
        if e.Timestamp.IsZero() {
 
59
                return errors.NewNotValid(errors.NotAssignedf("Timestamp"), "")
 
60
        }
 
61
        if e.Timestamp.Location() != time.UTC {
 
62
                return errors.NewNotValid(errors.NotValidf("Timestamp"), "must be set to UTC")
 
63
        }
 
64
        if e.RemoteAddress == "" {
 
65
                return errors.NewNotValid(errors.NotAssignedf("RemoteAddress"), "")
 
66
        }
 
67
        if e.OriginType == "" {
 
68
                return errors.NewNotValid(errors.NotAssignedf("OriginType"), "")
 
69
        }
 
70
        if e.OriginName == "" {
 
71
                return errors.NewNotValid(errors.NotAssignedf("OriginName"), "")
 
72
        }
 
73
        if e.Operation == "" {
 
74
                return errors.NewNotValid(errors.NotAssignedf("Operation"), "")
 
75
        }
 
76
 
 
77
        // Data remains unchecked as it is always optional.
 
78
 
 
79
        return nil
 
80
}