-
Notifications
You must be signed in to change notification settings - Fork 1
/
stackage.go
460 lines (391 loc) · 13.2 KB
/
stackage.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
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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
package aci
/*
stackage is a bridge to the go-stackage package
*/
import (
"github.com/JesseCoretta/go-stackage"
)
var (
stackOr func(...int) stackage.Stack = stackage.Or
stackAnd func(...int) stackage.Stack = stackage.And
stackNot func(...int) stackage.Stack = stackage.Not
stackList func(...int) stackage.Stack = stackage.List
)
/*
[ComparisonOperator] constants defined within the stackage package are aliased
within this package for convenience, without the need for user-invoked stackage
package import.
*/
const (
badCop ComparisonOperator = ComparisonOperator(stackage.ComparisonOperator(0x0))
Eq ComparisonOperator = ComparisonOperator(stackage.Eq) // 0x1, "Equal To"
Ne ComparisonOperator = ComparisonOperator(stackage.Ne) // 0x2, "Not Equal to" !! USE WITH CAUTION !!
Lt ComparisonOperator = ComparisonOperator(stackage.Lt) // 0x3, "Less Than"
Gt ComparisonOperator = ComparisonOperator(stackage.Gt) // 0x4, "Greater Than"
Le ComparisonOperator = ComparisonOperator(stackage.Le) // 0x5, "Less Than Or Equal"
Ge ComparisonOperator = ComparisonOperator(stackage.Ge) // 0x6, "Greater Than Or Equal"
)
type (
// ComparisonOperator is an alias for [stackage.ComparisonOperator]. Instances of
// this type are used to contruct [TargetRule] and [BindRule] instances, and describe
// the manner in which abstract contexts are to be evaluated.
ComparisonOperator stackage.ComparisonOperator
// BindDistinguishedNames is an alias type for [stackage.Stack], and is intended
// to house one (1) or more [BindDistinguishedName] instances for the purpose of
// expression within a [BindRule] instance.
BindDistinguishedNames stackage.Stack
// TargetDistinguishedNames is an alias type for [stackage.Stack], and is intended
// to house one (1) or more [TargetDistinguishedName] instances for the purpose of
// expression within a [TargetRule] instance.
TargetDistinguishedNames stackage.Stack
// PermissionBindRules is a [stackage.Stack] type alias used to store one (1)
// or more instances of [PermissionBindRule]. Instances of this kind are used
// in top-level [Instruction] (ACI) assembly.
PermissionBindRules stackage.Stack
// ObjectIdentifiers is an alias type for [stackage.Stack], and is intended
// to house one (1) or more [ObjectIdentifier] instances for the purpose of
// expression within a [TargetRule] instance.
ObjectIdentifiers stackage.Stack
// Instructions is a [stackage.Stack] alias type intended to store slices of
// [Instruction] instances.
//
// Note that the concept of a "collection" of [Instruction] instances does not
// come from the ACIv3 syntax per se, and is implemented here merely for the
// user's convenience. Use of this type is not required in any scenario.
Instructions stackage.Stack
// AttributeTypes is an alias type for [stackage.Stack], and is intended
// to house one (1) or more [AttributeType] instances for the purpose of
// expression within a [BindRule] or [TargetRule] instance.
AttributeTypes stackage.Stack
// BindRule is a [stackage.Condition] type alias intended to represent
// a single Bind Rule; that is, one (1) [BindKeyword], one (1)
// [ComparisonOperator] and one (1) or more string values (called an
// 'expression').
//
// For example:
//
// ssf >= "128"
//
// Instances of this type may be assembled manually by users, or may be
// created logically as a result of textual parsing. Users may also want
// to use convenient Eq, Ne, Gt, Ge, Lt, and Le methods extended through
// various types (as permitted) for simplicity.
//
// Instances of this type shall appear within [BindRules] instances and
// may or may not be parenthetical.
BindRule stackage.Condition
// BindRules is a [stackage.Stack] type alias intended to store and express
// one (1) or more [BindRule] statements, with or without nesting and (at
// least usually) bound by Boolean logical WORD operators 'AND', 'OR' and
// 'AND NOT'.
//
// For example:
//
// ssf >= "128" AND ip = "192.168.*"
//
// Instances of this type may be assembled manually by users, or may be
// created logically as a result of textual parsing. There are also some
// convenient operator-specific methods available (And() for 'AND', Or()
// for 'OR' and Not() for 'AND NOT'.
BindRules stackage.Stack
// TargetRule is a [stackage.Condition] type alias intended to represent
// a single Target Rule; that is, one (1) [TargetKeyword], one (1)
// [ComparisonOperator] and one (1) or more string values (called an
// 'expression').
//
// For example:
//
// ( targetscope = "subordinate" )
//
// Instances of this type may be assembled manually by users, or may be
// created logically as a result of textual parsing. Users may also want
// to use convenient Eq and Ne methods extended through various types
// (as permitted) for simplicity.
//
// Instances of this type shall appear within [TargetRules] instances.
//
// [TargetRule] instances are always parenthetical. No parenthetical control
// methods exist for instances of this type.
TargetRule stackage.Condition
// TargetRules is a [stackage.Stack] type alias intended to store and express
// one (1) or more [TargetRule] statements.
//
// For example:
//
// ( targetscope = "subordinate" )( targetattr = "cn || sn || givenName || objectClass" )
//
// Instances of this type may be assembled manually by users, or may be
// created logically as a result of textual parsing. See the [TR] function
// for easily initializing and returning instances of this type.
//
// Instances of this type will not allow nesting (i.e.: the addition of any
// [stackage.Stack] type alias instances). Only individual [TargetRule] instances
// may be pushed into instances of this type.
TargetRules stackage.Stack
// AttributeFilterOperation is a [stackage.Stack] type alias used to store [TargetAttrFilters] expressions,
// specifically those used within [TargetRule] instances bearing the [TargetAttrFilters] [TargetRule] keyword
// context.
//
// See also the [AttributeFilterOperations] type and its methods.
AttributeFilterOperation stackage.Stack
// AttributeFilterOperations is a [stackage.Stack] alias type, used for the
// storage of individual [AttributeFilterOperation] instances.
//
// Instances of this design are used in [TargetRule] instances which bear the
// [TargetAttrFilters] [Keyword] context.
AttributeFilterOperations stackage.Stack
)
/*
castAsCondition merely wraps (casts, converts) and returns an
instance of BindRule -OR- TargetRule as a [stackage.Condition]
instance. This is useful for calling methods that have not been
extended (wrapped) in this package via [stackage], as it may not
be needed in many cases ...
An instance submitted as x that is neither a BindRule or TargetRule
will result in an empty [stackage.Condition] return value.
Note this won't alter an existing BindRule or TargetRule instance,
rather a new reference is made through the [stackage.Condition] type
defined within go-stackage. The BindRule or TargetRule, once it has
been altered to one's satisfaction, can be sent off as intended and
this "Condition Counterpart" can be discarded, or left for GC.
*/
func castAsCondition(x any) (c stackage.Condition) {
c = badCond(errorf("Unsupported cast type %T for %T", x, c))
switch tv := x.(type) {
// case match is a single BindRule instance
case BindRule:
c = stackage.Condition(tv)
// case match is a single TargetRule instance
case TargetRule:
c = stackage.Condition(tv)
}
return
}
/*
cast is a private convenience method intended to streamline
the act of casting a BindRule instance to a stackage.Condition
instance if access to unwrapped methods is needed.
*/
func (r BindRule) cast() stackage.Condition {
return castAsCondition(r)
}
/*
cast is a private convenience method intended to streamline
the act of casting a BindRules instance to a [stackage.Stack]
instance if access to unwrapped methods is needed.
*/
func (r BindRules) cast() stackage.Stack {
x, _ := castAsStack(r)
return x
}
/*
cast is a private convenience method intended to streamline
the act of casting a TargetRule instance to a stackage.Condition
instance if access to unwrapped methods is needed.
*/
func (r TargetRule) cast() stackage.Condition {
return castAsCondition(r)
}
/*
cast is a private convenience method intended to streamline
the act of casting a TargetRules instance to a stackage.Stack
instance if access to unwrapped methods is needed.
*/
func (r TargetRules) cast() stackage.Stack {
x, _ := castAsStack(r)
return x
}
func (r AttributeTypes) cast() stackage.Stack {
x, _ := castAsStack(r)
return x
}
func (r BindDistinguishedNames) cast() stackage.Stack {
x, _ := castAsStack(r)
return x
}
func (r AttributeFilterOperation) cast() stackage.Stack {
x, _ := castAsStack(r)
return x
}
func (r AttributeFilterOperations) cast() stackage.Stack {
x, _ := castAsStack(r)
return x
}
func (r PermissionBindRules) cast() stackage.Stack {
x, _ := castAsStack(r)
return x
}
func (r Instructions) cast() stackage.Stack {
x, _ := castAsStack(r)
return x
}
func (r ObjectIdentifiers) cast() stackage.Stack {
x, _ := castAsStack(r)
return x
}
func (r TargetDistinguishedNames) cast() stackage.Stack {
x, _ := castAsStack(r)
return x
}
func (r ComparisonOperator) cast() stackage.ComparisonOperator {
return castAsCop(r)
}
func castAsBindRule(x any) BindRule {
_b, _ := x.(stackage.Condition)
return BindRule(_b)
}
func castAsBindRules(x any) BindRules {
_b, _ := x.(stackage.Stack)
return BindRules(_b)
}
/*
castAsCop wraps (casts, converts) and instance of ComparisonOperator
into a native stackage.ComparisonOperator instance. This is useful
when aliasing imported types and want to wrap and call the remote
function equivalent instead of writing your own.
*/
func castAsCop(x ComparisonOperator) stackage.ComparisonOperator {
return stackage.ComparisonOperator(x)
}
func castCop(x any) (cop ComparisonOperator) {
//case stackage.ComparisonOperator:
// cop = ComparisonOperator(tv)
switch tv := x.(type) {
case ComparisonOperator:
cop = tv
}
return
}
func isStack(stack any) (is bool) {
if is = isStackageStack(stack); !is {
is = isPkgStack(stack)
}
return
}
/*
isStackageStack merely matches the input type as a [stackage.Stack]
type and returns the resultant Boolean value.
*/
func isStackageStack(stack any) (is bool) {
_, is = stack.(stackage.Stack)
return
}
func isPkgStack(stack any) (is bool) {
switch stack.(type) {
case BindRules,
TargetRules,
Instructions,
AttributeTypes,
ObjectIdentifier,
ObjectIdentifiers,
PermissionBindRules,
BindDistinguishedName,
BindDistinguishedNames,
TargetDistinguishedName,
TargetDistinguishedNames,
AttributeFilterOperation,
AttributeFilterOperations:
is = true
}
return
}
/*
isStackageStack merely matches the input type as a [stackage.Stack]
type and returns the resultant Boolean value.
*/
func isStackageCondition(stack any) (is bool) {
switch stack.(type) {
case *stackage.Condition,
stackage.Condition:
is = true
}
return
}
func derefC(cond any) (c stackage.Condition) {
switch tv := cond.(type) {
case stackage.Condition:
c = tv
}
return
}
/*
castAsStack merely wraps (casts, converts) and returns any type
alias of [stackage.Stack] as a native stackage.Stack.
This is useful for calling methods that have not been extended
(wrapped) in this package via go-stackage, as it might not be
needed in most cases ...
An instance submitted as x that is NOT a type alias of [stackage.Stack]
will result in an empty [stackage.Stack] return value.
Note this won't alter an existing values, rather a new reference is
made through the stackage.Condition type defined within go-stackage.
The alias type, once it has been altered to one's satisfaction, can be
sent off as intended and this "Stack Counterpart" can be discarded, or
left for GC.
*/
func castAsStack(u any) (S stackage.Stack, converted bool) {
switch tv := u.(type) {
case stackage.Stack:
converted = true
S = tv
case Instructions:
converted = true
S = stackage.Stack(tv)
case ObjectIdentifiers:
converted = true
S = stackage.Stack(tv)
case BindDistinguishedNames,
TargetDistinguishedNames:
S, converted = castDNRules(tv)
case BindRules, TargetRules,
PermissionBindRules:
S, converted = castBTRules(tv)
case AttributeTypes:
converted = true
S = stackage.Stack(tv)
case AttributeFilterOperation,
AttributeFilterOperations:
S, converted = castFilterRules(tv)
}
return
}
func castBTRules(x any) (S stackage.Stack, converted bool) {
switch tv := x.(type) {
case BindRules:
S = stackage.Stack(tv)
converted = true
case TargetRules:
S = stackage.Stack(tv)
converted = true
case PermissionBindRules:
S = stackage.Stack(tv)
converted = true
}
return
}
func castDNRules(x any) (S stackage.Stack, converted bool) {
switch tv := x.(type) {
case BindDistinguishedNames:
S = stackage.Stack(tv)
converted = true
case TargetDistinguishedNames:
S = stackage.Stack(tv)
converted = true
}
return
}
func castFilterRules(x any) (S stackage.Stack, converted bool) {
switch tv := x.(type) {
case AttributeFilterOperation:
S = stackage.Stack(tv)
converted = true
case AttributeFilterOperations:
S = stackage.Stack(tv)
converted = true
}
return
}
func badCond(err error) (bad stackage.Condition) {
bad.Init()
bad.SetErr(err)
return
}