Blame view

auth_utility.go 6.3 KB
ea858b8a7   Marko Tikvić   refactoring
1
  package webutility
90fd36e9b   Marko Tikvić   resolved some dep...
2
3
  
  import (
90fd36e9b   Marko Tikvić   resolved some dep...
4
  	"crypto/rand"
d2ddf82ef   Marko Tikvić   started on new rbac
5
  	"crypto/sha256"
90fd36e9b   Marko Tikvić   resolved some dep...
6
  	"encoding/hex"
d2ddf82ef   Marko Tikvić   started on new rbac
7
  	"errors"
33d137a67   Marko Tikvić   Functional role c...
8
  	"net/http"
d2ddf82ef   Marko Tikvić   started on new rbac
9
10
  	"strings"
  	"time"
33d137a67   Marko Tikvić   Functional role c...
11

90fd36e9b   Marko Tikvić   resolved some dep...
12
  	"github.com/dgrijalva/jwt-go"
90fd36e9b   Marko Tikvić   resolved some dep...
13
  )
d2ddf82ef   Marko Tikvić   started on new rbac
14
15
  const OneDay = time.Hour * 24
  const OneWeek = OneDay * 7
90fd36e9b   Marko Tikvić   resolved some dep...
16
  const saltSize = 32
f84e7607d   Marko Tikvić   added dictionary;...
17
18
19
  
  var appName = "webutility"
  var secret = "webutility"
90fd36e9b   Marko Tikvić   resolved some dep...
20

d2ddf82ef   Marko Tikvić   started on new rbac
21
  type Role struct {
077dae33c   Marko Tikvić   removed role cons...
22
  	Name string `json:"name"`
f84e7607d   Marko Tikvić   added dictionary;...
23
  	ID   int32  `json:"id"`
d2ddf82ef   Marko Tikvić   started on new rbac
24
  }
6ec91280b   Marko Tikvić   working on docume...
25
  // TokenClaims are JWT token claims.
90fd36e9b   Marko Tikvić   resolved some dep...
26
  type TokenClaims struct {
6620591d8   Marko Tikvić   moved DeliverPayl...
27
28
29
30
  	Token     string `json:"access_token"`
  	TokenType string `json:"token_type"`
  	Username  string `json:"username"`
  	Role      string `json:"role"`
f84e7607d   Marko Tikvić   added dictionary;...
31
  	RoleID    int32  `json:"role_id"`
6620591d8   Marko Tikvić   moved DeliverPayl...
32
33
34
35
  	ExpiresIn int64  `json:"expires_in"`
  
  	// extending a struct
  	jwt.StandardClaims
90fd36e9b   Marko Tikvić   resolved some dep...
36
  }
f84e7607d   Marko Tikvić   added dictionary;...
37
38
39
40
  func InitJWT(appName, secret string) {
  	appName = appName
  	secret = secret
  }
bc3671b26   Marko Tikvić   refactoring token...
41
  // ValidateCredentials hashes pass and salt and returns comparison result with resultHash
f84e7607d   Marko Tikvić   added dictionary;...
42
  func ValidateCredentials(pass, salt, resultHash string) (bool, error) {
bc3671b26   Marko Tikvić   refactoring token...
43
  	hash, _, err := CreateHash(pass, salt)
90fd36e9b   Marko Tikvić   resolved some dep...
44
  	if err != nil {
f84e7607d   Marko Tikvić   added dictionary;...
45
  		return false, err
90fd36e9b   Marko Tikvić   resolved some dep...
46
  	}
f84e7607d   Marko Tikvić   added dictionary;...
47
48
  	res := hash == resultHash
  	return res, nil
90fd36e9b   Marko Tikvić   resolved some dep...
49
  }
bc3671b26   Marko Tikvić   refactoring token...
50
51
52
53
  // CreateHash hashes str using SHA256.
  // If the presalt parameter is not provided CreateHash will generate new salt string.
  // Returns hash and salt strings or an error if it fails.
  func CreateHash(str, presalt string) (hash, salt string, err error) {
90fd36e9b   Marko Tikvić   resolved some dep...
54
55
  	// chech if message is presalted
  	if presalt == "" {
bc3671b26   Marko Tikvić   refactoring token...
56
  		salt, err = randomSalt()
90fd36e9b   Marko Tikvić   resolved some dep...
57
58
59
60
61
62
63
64
  		if err != nil {
  			return "", "", err
  		}
  	} else {
  		salt = presalt
  	}
  
  	// convert strings to raw byte slices
33fd58161   markotikvic   minor changes, sh...
65
  	rawstr := []byte(str)
90fd36e9b   Marko Tikvić   resolved some dep...
66
67
68
69
  	rawsalt, err := hex.DecodeString(salt)
  	if err != nil {
  		return "", "", err
  	}
33fd58161   markotikvic   minor changes, sh...
70

d2ddf82ef   Marko Tikvić   started on new rbac
71
  	rawdata := make([]byte, len(rawstr)+len(rawsalt))
33fd58161   markotikvic   minor changes, sh...
72
  	rawdata = append(rawdata, rawstr...)
90fd36e9b   Marko Tikvić   resolved some dep...
73
74
75
76
77
78
  	rawdata = append(rawdata, rawsalt...)
  
  	// hash message + salt
  	hasher := sha256.New()
  	hasher.Write(rawdata)
  	rawhash := hasher.Sum(nil)
33fd58161   markotikvic   minor changes, sh...
79

90fd36e9b   Marko Tikvić   resolved some dep...
80
81
82
  	hash = hex.EncodeToString(rawhash)
  	return hash, salt, nil
  }
bc3671b26   Marko Tikvić   refactoring token...
83
  // CreateAuthToken returns JWT token with encoded username, role, expiration date and issuer claims.
6ec91280b   Marko Tikvić   working on docume...
84
  // It returns an error if it fails.
bc3671b26   Marko Tikvić   refactoring token...
85
86
87
  func CreateAuthToken(username string, role Role) (TokenClaims, error) {
  	t0 := (time.Now()).Unix()
  	t1 := (time.Now().Add(OneWeek)).Unix()
90fd36e9b   Marko Tikvić   resolved some dep...
88
  	claims := TokenClaims{
bc3671b26   Marko Tikvić   refactoring token...
89
90
91
92
93
  		TokenType: "Bearer",
  		Username:  username,
  		Role:      role.Name,
  		RoleID:    role.ID,
  		ExpiresIn: t1 - t0,
90fd36e9b   Marko Tikvić   resolved some dep...
94
  	}
bc3671b26   Marko Tikvić   refactoring token...
95
96
97
98
  	// initialize jwt.StandardClaims fields (anonymous struct)
  	claims.IssuedAt = t0
  	claims.ExpiresAt = t1
  	claims.Issuer = appName
90fd36e9b   Marko Tikvić   resolved some dep...
99
100
  
  	jwtToken := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
bc3671b26   Marko Tikvić   refactoring token...
101
  	token, err := jwtToken.SignedString([]byte(secret))
90fd36e9b   Marko Tikvić   resolved some dep...
102
  	if err != nil {
bc3671b26   Marko Tikvić   refactoring token...
103
  		return TokenClaims{}, err
90fd36e9b   Marko Tikvić   resolved some dep...
104
  	}
bc3671b26   Marko Tikvić   refactoring token...
105
106
  	claims.Token = token
  	return claims, nil
90fd36e9b   Marko Tikvić   resolved some dep...
107
  }
c7aadbb39   Marko Tikvić   minor changes
108
  // RefreshAuthToken returns new JWT token with sprolongs JWT token's expiration date for one week.
6ec91280b   Marko Tikvić   working on docume...
109
  // It returns new JWT token or an error if it fails.
c7aadbb39   Marko Tikvić   minor changes
110
111
  func RefreshAuthToken(tok string) (TokenClaims, error) {
  	token, err := jwt.ParseWithClaims(tok, &TokenClaims{}, secretFunc)
90fd36e9b   Marko Tikvić   resolved some dep...
112
  	if err != nil {
052f8a3a6   Marko Tikvić   token validation ...
113
114
115
116
117
118
119
120
121
  		if validation, ok := err.(*jwt.ValidationError); ok {
  			// don't return error if token is expired
  			// just extend it
  			if !(validation.Errors&jwt.ValidationErrorExpired != 0) {
  				return TokenClaims{}, err
  			}
  		} else {
  			return TokenClaims{}, err
  		}
90fd36e9b   Marko Tikvić   resolved some dep...
122
123
124
125
  	}
  
  	// type assertion
  	claims, ok := token.Claims.(*TokenClaims)
052f8a3a6   Marko Tikvić   token validation ...
126
  	if !ok {
bc3671b26   Marko Tikvić   refactoring token...
127
  		return TokenClaims{}, errors.New("token is not valid")
90fd36e9b   Marko Tikvić   resolved some dep...
128
  	}
bc3671b26   Marko Tikvić   refactoring token...
129
130
  	// extend token expiration date
  	return CreateAuthToken(claims.Username, Role{claims.Role, claims.RoleID})
90fd36e9b   Marko Tikvić   resolved some dep...
131
  }
d29773cc4   Marko Tikvić   ProcessRBAC
132
  // RbacCheck returns true if user that made HTTP request is authorized to
bc3671b26   Marko Tikvić   refactoring token...
133
134
135
136
137
  // access the resource it is targeting.
  // It exctracts user's role from the JWT token located in Authorization header of
  // http.Request and then compares it with the list of supplied roles and returns
  // true if there's a match, if "*" is provided or if the authRoles is nil.
  // Otherwise it returns false.
2d79a4120   Marko Tikvić   Responses contain...
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
  func RbacCheck(req *http.Request, authRoles []string) bool {
  	if authRoles == nil {
  		return true
  	}
  
  	// validate token and check expiration date
  	claims, err := GetTokenClaims(req)
  	if err != nil {
  		return false
  	}
  	// check if token has expired
  	if claims.ExpiresAt < (time.Now()).Unix() {
  		return false
  	}
  
  	// check if role extracted from token matches
  	// any of the provided (allowed) ones
  	for _, r := range authRoles {
  		if claims.Role == r || r == "*" {
  			return true
  		}
  	}
  
  	return false
  }
d29773cc4   Marko Tikvić   ProcessRBAC
163
164
  // ProcessRBAC returns token claims and boolean value based on user's rights to access resource specified in req.
  // It exctracts user's role from the JWT token located in Authorization header of
c7aadbb39   Marko Tikvić   minor changes
165
166
  // HTTP request and then compares it with the list of supplied (authorized);
  // it returns true if there's a match, if "*" is provided or if the authRoles is nil.
d29773cc4   Marko Tikvić   ProcessRBAC
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
  func ProcessRBAC(req *http.Request, authRoles []string) (*TokenClaims, bool) {
  	if authRoles == nil {
  		return nil, true
  	}
  
  	// validate token and check expiration date
  	claims, err := GetTokenClaims(req)
  	if err != nil {
  		return claims, false
  	}
  	// check if token has expired
  	if claims.ExpiresAt < (time.Now()).Unix() {
  		return claims, false
  	}
  
  	// check if role extracted from token matches
  	// any of the provided (allowed) ones
  	for _, r := range authRoles {
  		if claims.Role == r || r == "*" {
  			return claims, true
  		}
  	}
  
  	return claims, false
  }
bc3671b26   Marko Tikvić   refactoring token...
192
193
194
195
196
197
198
  // GetTokenClaims extracts JWT claims from Authorization header of the request.
  // Returns token claims or an error.
  func GetTokenClaims(req *http.Request) (*TokenClaims, error) {
  	// check for and strip 'Bearer' prefix
  	var tokstr string
  	authHead := req.Header.Get("Authorization")
  	if ok := strings.HasPrefix(authHead, "Bearer "); ok {
2d79a4120   Marko Tikvić   Responses contain...
199
  		tokstr = strings.TrimPrefix(authHead, "Bearer ")
33d137a67   Marko Tikvić   Functional role c...
200
  	} else {
bc3671b26   Marko Tikvić   refactoring token...
201
  		return &TokenClaims{}, errors.New("authorization header in incomplete")
33d137a67   Marko Tikvić   Functional role c...
202
  	}
bc3671b26   Marko Tikvić   refactoring token...
203
  	token, err := jwt.ParseWithClaims(tokstr, &TokenClaims{}, secretFunc)
33d137a67   Marko Tikvić   Functional role c...
204
205
206
207
208
  	if err != nil {
  		return &TokenClaims{}, err
  	}
  
  	// type assertion
bc3671b26   Marko Tikvić   refactoring token...
209
210
  	claims, ok := token.Claims.(*TokenClaims)
  	if !ok || !token.Valid {
33d137a67   Marko Tikvić   Functional role c...
211
212
  		return &TokenClaims{}, errors.New("token is not valid")
  	}
33d137a67   Marko Tikvić   Functional role c...
213

bc3671b26   Marko Tikvić   refactoring token...
214
  	return claims, nil
90fd36e9b   Marko Tikvić   resolved some dep...
215
  }
33d137a67   Marko Tikvić   Functional role c...
216

bc3671b26   Marko Tikvić   refactoring token...
217
218
219
  // randomSalt returns a string of random characters of 'saltSize' length.
  func randomSalt() (s string, err error) {
  	rawsalt := make([]byte, saltSize)
d2ddf82ef   Marko Tikvić   started on new rbac
220

bc3671b26   Marko Tikvić   refactoring token...
221
  	_, err = rand.Read(rawsalt)
d2ddf82ef   Marko Tikvić   started on new rbac
222
  	if err != nil {
bc3671b26   Marko Tikvić   refactoring token...
223
  		return "", err
33d137a67   Marko Tikvić   Functional role c...
224
  	}
d2ddf82ef   Marko Tikvić   started on new rbac
225

bc3671b26   Marko Tikvić   refactoring token...
226
227
  	s = hex.EncodeToString(rawsalt)
  	return s, nil
33d137a67   Marko Tikvić   Functional role c...
228
  }
d2ddf82ef   Marko Tikvić   started on new rbac
229

bc3671b26   Marko Tikvić   refactoring token...
230
231
232
  // secretFunc returns byte slice of API secret keyword.
  func secretFunc(token *jwt.Token) (interface{}, error) {
  	return []byte(secret), nil
d2ddf82ef   Marko Tikvić   started on new rbac
233
  }