2 * ============LICENSE_START====================================================
4 * ===========================================================================
5 * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
6 * ===========================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END====================================================
22 package org.onap.aaf.auth.org;
24 import java.util.ArrayList;
25 import java.util.Date;
26 import java.util.GregorianCalendar;
27 import java.util.HashSet;
28 import java.util.List;
31 import org.onap.aaf.auth.env.AuthzTrans;
36 * There is Organizational specific information required which we have extracted to a plugin
38 * It supports using Company Specific User Directory lookups, as well as supporting an
39 * Approval/Validation Process to simplify control of Roles and Permissions for large organizations
40 * in lieu of direct manipulation by a set of Admins.
45 public interface Organization {
46 public static final String N_A = "n/a";
48 public interface Identity {
50 public String fullID() throws OrganizationException; // Fully Qualified ID (includes Domain of Organization)
51 public String type(); // Must be one of "IdentityTypes", see below
52 public Identity responsibleTo() throws OrganizationException; // Chain of Command, or Application ID Sponsor
53 public List<String> delegate(); // Someone who has authority to act on behalf of Identity
54 public String email();
55 public String fullName();
56 public String firstName();
58 * If Responsible entity, then String returned is "null" meaning "no Objection".
59 * If String exists, it is the Policy objection text setup by the entity.
62 public String mayOwn(); // Is id passed belong to a person suitable to be Responsible for content Management
63 public boolean isFound(); // Is Identity found in Identity stores
64 public boolean isPerson(); // Whether a Person or a Machine (App)
65 public Organization org(); // Organization of Identity
68 public static String mixedCase(String in) {
69 StringBuilder sb = new StringBuilder();
70 for(int i=0;i<in.length();++i) {
72 sb.append(Character.toUpperCase(in.charAt(i)));
74 sb.append(Character.toLowerCase(in.charAt(i)));
83 * Name of Organization, suitable for Logging
86 public String getName();
89 * Realm, for use in distinguishing IDs from different systems/Companies
92 public String getRealm();
94 public boolean supportsRealm(String user);
96 public void addSupportedRealm(String r);
98 public String getDomain();
101 * Get Identity information based on userID
106 public Identity getIdentity(AuthzTrans trans, String id) throws OrganizationException;
111 * Deletion of an Identity that has been removed from an Organization can be dangerous. Mistakes may have been made
112 * in the Organization side, a Feed might be corrupted, an API might not be quite right.
114 * The implementation of this method can use a double check of some sort, such as comparsion of missing ID in Organization
115 * feed with a "Deleted ID" feed.
117 * The failure to be in Organization will still be reported, if returned "false", but if true, it is taken as an
118 * ok to proceed with deletion.
120 public boolean mayAutoDelete(AuthzTrans trans, String id);
124 * Does the ID pass Organization Standards
126 * Return a Blank (empty) String if empty, otherwise, return a "\n" separated list of
127 * reasons why it fails
132 public String isValidID(AuthzTrans trans, String id);
135 * Return a Blank (empty) String if empty, otherwise, return a "\n" separated list of
136 * reasons why it fails
138 * Identity is passed in to allow policies regarding passwords that are the same as user ID
140 * any entries for "prev" imply a reset
146 public String isValidPassword(final AuthzTrans trans, final String id, final String password, final String ... prev);
149 * Return a list of Strings denoting Organization Password Rules, suitable for posting on a WebPage with <p>
151 public String[] getPasswordRules();
158 public boolean isValidCred(final AuthzTrans trans, final String id);
161 * If response is Null, then it is valid. Otherwise, the Organization specific reason is returned.
168 * @throws OrganizationException
170 public String validate(AuthzTrans trans, Policy policy, Executor executor, String ... vars) throws OrganizationException;
173 * Does your Company distinguish essential permission structures by kind of Identity?
174 * i.e. Employee, Contractor, Vendor
177 public Set<String> getIdentityTypes();
181 PasswordExpiration(2),
185 Notify(int id) {this.id = id;}
186 public int getValue() {return id;}
187 public static Notify from(int type) {
188 for (Notify t : Notify.values()) {
197 public enum Response{
201 ERR_NotificationFailure,
204 public enum Expiration {
217 CREATE_MECHID_BY_PERM_ONLY,
220 MAY_EXTEND_CRED_EXPIRES,
221 MAY_APPLY_DEFAULT_REALM
225 * Notify a User of Action or Info
229 * @param users (separated by commas)
230 * @param ccs (separated by commas)
234 public Response notify(AuthzTrans trans, Notify type, String url, String ids[], String ccs[], String summary, Boolean urgent);
237 * (more) generic way to send an email
246 public int sendEmail(AuthzTrans trans, List<String> toList, List<String> ccList, String subject, String body, Boolean urgent) throws OrganizationException;
251 * Authz support services will ask the Organization Object at startup when it should
252 * kickoff Validation processes given particular types.
254 * This allows the Organization to express Policy
256 * Turn off Validation behavior by returning "null"
259 public Date whenToValidate(Notify type, Date lastValidated);
265 * Given a Calendar item of Start (or now), set the Expiration Date based on the Policy
268 * For instance, "Passwords expire in 3 months"
270 * The Extra Parameter is used by certain Orgs.
272 * For Password, the extra is UserID, so it can check the User Type
278 public GregorianCalendar expiration(GregorianCalendar gc, Expiration exp, String ... extra);
281 * Get Email Warning timing policies
284 public EmailWarnings emailWarningPolicy();
292 public List<Identity> getApprovers(AuthzTrans trans, String user) throws OrganizationException ;
300 public Response notifyRequest(AuthzTrans trans, String user, Approval type, List<User> approvers);
307 public String getApproverType();
310 * startOfDay - define for company what hour of day business starts (specifically for password and other expiration which
311 * were set by Date only.)
315 public int startOfDay();
318 * implement this method to support any IDs that can have multiple entries in the cred table
319 * NOTE: the combination of ID/expiration date/(encryption type when implemented) must be unique.
320 * Since expiration date is based on startOfDay for your company, you cannot create many
321 * creds for the same ID in the same day.
325 public boolean canHaveMultipleCreds(String id);
329 public void setTestMode(boolean dryRun);
331 public static final Organization NULL = new Organization()
333 private final GregorianCalendar gc = new GregorianCalendar(1900, 1, 1);
334 private final List<Identity> nullList = new ArrayList<>();
335 private final Set<String> nullStringSet = new HashSet<>();
336 private String[] nullStringArray = new String[0];
337 private final Identity nullIdentity = new Identity() {
338 List<String> nullUser = new ArrayList<>();
340 public String type() {
345 public String mayOwn() {
346 return N_A; // negative case
350 public boolean isFound() {
360 public String fullID() {
365 public String email() {
370 public List<String> delegate() {
374 public String fullName() {
378 public Organization org() {
382 public String firstName() {
386 public boolean isPerson() {
391 public Identity responsibleTo() {
396 public String getName() {
401 public String getRealm() {
406 public boolean supportsRealm(String r) {
411 public void addSupportedRealm(String r) {
415 public String getDomain() {
420 public Identity getIdentity(AuthzTrans trans, String id) {
425 public String isValidID(final AuthzTrans trans, String id) {
430 public String isValidPassword(final AuthzTrans trans, final String user, final String password, final String... prev) {
435 public Set<String> getIdentityTypes() {
436 return nullStringSet;
440 public Response notify(AuthzTrans trans, Notify type, String url,
441 String[] users, String[] ccs, String summary, Boolean urgent) {
442 return Response.ERR_NotImplemented;
446 public int sendEmail(AuthzTrans trans, List<String> toList, List<String> ccList,
447 String subject, String body, Boolean urgent) throws OrganizationException {
452 public Date whenToValidate(Notify type, Date lastValidated) {
457 public GregorianCalendar expiration(GregorianCalendar gc,
458 Expiration exp, String... extra) {
463 public List<Identity> getApprovers(AuthzTrans trans, String user)
464 throws OrganizationException {
469 public String getApproverType() {
474 public int startOfDay() {
479 public boolean canHaveMultipleCreds(String id) {
484 public boolean isValidCred(final AuthzTrans trans, final String id) {
489 public String validate(AuthzTrans trans, Policy policy, Executor executor, String ... vars)
490 throws OrganizationException {
491 return "Null Organization rejects all Policies";
495 public boolean isTestEnv() {
500 public void setTestMode(boolean dryRun) {
504 public EmailWarnings emailWarningPolicy() {
505 return new EmailWarnings() {
508 public long credEmailInterval()
510 return 604800000L; // 7 days in millis 1000 * 86400 * 7
514 public long roleEmailInterval()
516 return 604800000L; // 7 days in millis 1000 * 86400 * 7
520 public long apprEmailInterval() {
521 return 259200000L; // 3 days in millis 1000 * 86400 * 3
525 public long credExpirationWarning()
527 return( 2592000000L ); // One month, in milliseconds 1000 * 86400 * 30 in milliseconds
531 public long roleExpirationWarning()
533 return( 2592000000L ); // One month, in milliseconds 1000 * 86400 * 30 in milliseconds
537 public long emailUrgentWarning()
539 return( 1209600000L ); // Two weeks, in milliseconds 1000 * 86400 * 14 in milliseconds
548 public String[] getPasswordRules() {
549 return nullStringArray;
553 public boolean mayAutoDelete(AuthzTrans trans, String id) {
554 // provide a corresponding feed that indicates that an ID has been intentionally removed from identities.dat table.