-
Notifications
You must be signed in to change notification settings - Fork 234
/
CredentialsTypeFilter.java
397 lines (353 loc) · 11.1 KB
/
CredentialsTypeFilter.java
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
/*
* The MIT License
*
* Copyright (c) 2016, CloudBees, Inc., Stephen Connolly.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.cloudbees.plugins.credentials;
import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.annotations.NonNull;
import hudson.Extension;
import hudson.ExtensionList;
import hudson.ExtensionPoint;
import hudson.Util;
import hudson.model.AbstractDescribableImpl;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.DataBoundConstructor;
/**
* A filter of {@link CredentialsDescriptor} types used by {@link CredentialsProviderManager} to determine which
* types are active.
*
* @since 2.0
*/
public abstract class CredentialsTypeFilter extends AbstractDescribableImpl<CredentialsTypeFilter>
implements Serializable, ExtensionPoint {
/**
* Ensure consistent serialization.
*/
private static final long serialVersionUID = 1L;
/**
* Returns {@code true} if and only if the supplied {@link CredentialsDescriptor} is permitted to be active.
*
* @param type the {@link CredentialsDescriptor} to check.
* @return {@code true} if and only if the supplied {@link CredentialsDescriptor} is permitted to be active.
*/
public abstract boolean filter(CredentialsDescriptor type);
/**
* {@inheritDoc}
*/
@Override
public CredentialsTypeFilterDescriptor getDescriptor() {
return (CredentialsTypeFilterDescriptor) super.getDescriptor();
}
/**
* {@inheritDoc}
*/
@Override
public abstract int hashCode();
/**
* {@inheritDoc}
*/
@Override
public abstract boolean equals(Object obj);
/**
* {@inheritDoc}
*/
@Override
public abstract String toString();
/**
* A filter that does not filter anything.
*
* @since 2.0
*/
public static class None extends CredentialsTypeFilter {
/**
* Ensure consistent serialization.
*/
private static final long serialVersionUID = 1L;
/**
* Our constructor.
*/
@DataBoundConstructor
public None() {
}
/**
* {@inheritDoc}
*/
@Override
public boolean filter(CredentialsDescriptor type) {
return true;
}
/**
* {@inheritDoc}
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
return true;
}
/**
* {@inheritDoc}
*/
@Override
public int hashCode() {
return None.class.hashCode();
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
final StringBuilder sb = new StringBuilder("None{");
sb.append('}');
return sb.toString();
}
/**
* Our descriptor.
*
* @since 2.0
*/
@Extension
public static class DescriptorImpl extends CredentialsTypeFilterDescriptor {
/**
* {@inheritDoc}
*/
@Override
public String getDisplayName() {
return Messages.CredentialsTypeFilter_None_DisplayName();
}
}
}
/**
* A filter that implements a whitelist policy, "if you are not on the list you can't come in".
*
* @since 2.0
*/
public static class Includes extends CredentialsTypeFilter {
/**
* Ensure consistent serialization.
*/
private static final long serialVersionUID = 1L;
/**
* The set of classes that will be allowed.
*/
private final Set<String> classNames;
/**
* Our constructor.
*
* @param classNames the whitelist of class names.
*/
@DataBoundConstructor
public Includes(@CheckForNull List<String> classNames) {
this.classNames = new LinkedHashSet<String>(Util.fixNull(classNames));
}
/**
* {@inheritDoc}
*/
@Override
public boolean filter(CredentialsDescriptor type) {
return classNames.contains(type.getClass().getName());
}
/**
* Returns the whitelist of allowed {@link Class#getName()}.
*
* @return the whitelist of allowed {@link Class#getName()}.
*/
@NonNull
public List<String> getClassNames() {
List<String> result = new ArrayList<String>();
for (CredentialsDescriptor type : ExtensionList.lookup(CredentialsDescriptor.class)) {
if (classNames.contains(type.getClass().getName())) {
result.add(type.getClass().getName());
}
}
return result;
}
/**
* {@inheritDoc}
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Includes includes = (Includes) o;
return classNames.equals(includes.classNames);
}
/**
* {@inheritDoc}
*/
@Override
public int hashCode() {
return classNames.hashCode();
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
final StringBuilder sb = new StringBuilder("Includes{");
sb.append("classes=").append(getClassNames());
sb.append('}');
return sb.toString();
}
/**
* Our descriptor.
*
* @since 2.0
*/
@Extension
public static class DescriptorImpl extends CredentialsTypeFilterDescriptor {
/**
* {@inheritDoc}
*/
@Override
public String getDisplayName() {
return Messages.CredentialsTypeFilter_Includes_DisplayName();
}
/**
* Gets the full list of available types without any filtering.
*
* @return the full list of available types without any filtering.
*/
@SuppressWarnings("unused")
@Restricted(NoExternalUse.class) // stapler EL binding
public List<CredentialsDescriptor> getTypeDescriptors() {
return ExtensionList.lookup(CredentialsDescriptor.class);
}
}
}
/**
* A filter that implements a blacklist policy, "if you are not on the list you can come in".
*
* @since 2.0
*/
public static class Excludes extends CredentialsTypeFilter {
/**
* Ensure consistent serialization.
*/
private static final long serialVersionUID = 1L;
/**
* The set of classes that will not be allowed.
*/
private final Set<String> classNames;
/**
* Our constructor.
*
* @param classNames the blacklist of class names.
*/
@DataBoundConstructor
public Excludes(@CheckForNull List<String> classNames) {
this.classNames = new LinkedHashSet<String>(Util.fixNull(classNames));
}
/**
* {@inheritDoc}
*/
@Override
public boolean filter(CredentialsDescriptor type) {
return !classNames.contains(type.getClass().getName());
}
/**
* Returns the blacklist of banned {@link Class#getName()}.
*
* @return the blacklist of banned {@link Class#getName()}.
*/
@NonNull
public List<String> getClassNames() {
List<String> result = new ArrayList<String>();
for (CredentialsDescriptor type : ExtensionList.lookup(CredentialsDescriptor.class)) {
if (classNames.contains(type.getClass().getName())) {
result.add(type.getClass().getName());
}
}
return result;
}
/**
* {@inheritDoc}
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Excludes excludes = (Excludes) o;
return classNames.equals(excludes.classNames);
}
/**
* {@inheritDoc}
*/
@Override
public int hashCode() {
return classNames.hashCode();
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
final StringBuilder sb = new StringBuilder("Excludes{");
sb.append("classes=").append(getClassNames());
sb.append('}');
return sb.toString();
}
/**
* Our descriptor.
*
* @since 2.0
*/
@Extension
public static class DescriptorImpl extends CredentialsTypeFilterDescriptor {
/**
* {@inheritDoc}
*/
@Override
public String getDisplayName() {
return Messages.CredentialsTypeFilter_Excludes_DisplayName();
}
/**
* Gets the full list of available types without any filtering.
*
* @return the full list of available types without any filtering.
*/
@SuppressWarnings("unused")
@Restricted(NoExternalUse.class) // stapler EL binding
public List<CredentialsDescriptor> getTypeDescriptors() {
return ExtensionList.lookup(CredentialsDescriptor.class);
}
}
}
}