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 comparison of missing ID in Organization
115 * feed with a "Deleted ID" feed.
118 public boolean isRevoked(AuthzTrans trans, String id);
122 * Does the ID pass Organization Standards
124 * Return a Blank (empty) String if empty, otherwise, return a "\n" separated list of
125 * reasons why it fails
130 public String isValidID(AuthzTrans trans, String id);
133 * Return a Blank (empty) String if empty, otherwise, return a "\n" separated list of
134 * reasons why it fails
136 * Identity is passed in to allow policies regarding passwords that are the same as user ID
138 * any entries for "prev" imply a reset
144 public String isValidPassword(final AuthzTrans trans, final String id, final String password, final String ... prev);
147 * Return a list of Strings denoting Organization Password Rules, suitable for posting on a WebPage with <p>
149 public String[] getPasswordRules();
156 public boolean isValidCred(final AuthzTrans trans, final String id);
159 * If response is Null, then it is valid. Otherwise, the Organization specific reason is returned.
166 * @throws OrganizationException
168 public String validate(AuthzTrans trans, Policy policy, Executor executor, String ... vars) throws OrganizationException;
171 * Does your Company distinguish essential permission structures by kind of Identity?
172 * i.e. Employee, Contractor, Vendor
175 public Set<String> getIdentityTypes();
179 PasswordExpiration(2),
183 Notify(int id) {this.id = id;}
184 public int getValue() {return id;}
185 public static Notify from(int type) {
186 for (Notify t : Notify.values()) {
195 public enum Response{
199 ERR_NotificationFailure,
202 public enum Expiration {
215 CREATE_MECHID_BY_PERM_ONLY,
218 MAY_EXTEND_CRED_EXPIRES,
219 MAY_APPLY_DEFAULT_REALM
223 * Notify a User of Action or Info
227 * @param users (separated by commas)
228 * @param ccs (separated by commas)
232 public Response notify(AuthzTrans trans, Notify type, String url, String ids[], String ccs[], String summary, Boolean urgent);
235 * (more) generic way to send an email
244 public int sendEmail(AuthzTrans trans, List<String> toList, List<String> ccList, String subject, String body, Boolean urgent) throws OrganizationException;
249 * Authz support services will ask the Organization Object at startup when it should
250 * kickoff Validation processes given particular types.
252 * This allows the Organization to express Policy
254 * Turn off Validation behavior by returning "null"
257 public Date whenToValidate(Notify type, Date lastValidated);
263 * Given a Calendar item of Start (or now), set the Expiration Date based on the Policy
266 * For instance, "Passwords expire in 3 months"
268 * The Extra Parameter is used by certain Orgs.
270 * For Password, the extra is UserID, so it can check the User Type
276 public GregorianCalendar expiration(GregorianCalendar gc, Expiration exp, String ... extra);
279 * Get Email Warning timing policies
282 public EmailWarnings emailWarningPolicy();
290 public List<Identity> getApprovers(AuthzTrans trans, String user) throws OrganizationException ;
293 * Get Identities for Escalation Level
295 * 2 = expects both self and immediate responsible party
296 * 3 = expects self, immediate report and any higher that the Organization wants to escalate to in the
299 * Note: this is used to notify of imminent danger of Application's Cred or Role expirations.
301 public List<Identity> getIDs(AuthzTrans trans, String user, int escalate) throws OrganizationException ;
310 public Response notifyRequest(AuthzTrans trans, String user, Approval type, List<User> approvers);
317 public String getApproverType();
320 * startOfDay - define for company what hour of day business starts (specifically for password and other expiration which
321 * were set by Date only.)
325 public int startOfDay();
328 * implement this method to support any IDs that can have multiple entries in the cred table
329 * NOTE: the combination of ID/expiration date/(encryption type when implemented) must be unique.
330 * Since expiration date is based on startOfDay for your company, you cannot create many
331 * creds for the same ID in the same day.
335 public boolean canHaveMultipleCreds(String id);
339 public void setTestMode(boolean dryRun);
341 public static final Organization NULL = new Organization()
343 private final GregorianCalendar gc = new GregorianCalendar(1900, 1, 1);
344 private final List<Identity> nullList = new ArrayList<>();
345 private final Set<String> nullStringSet = new HashSet<>();
346 private String[] nullStringArray = new String[0];
347 private final Identity nullIdentity = new Identity() {
348 List<String> nullUser = new ArrayList<>();
350 public String type() {
355 public String mayOwn() {
356 return N_A; // negative case
360 public boolean isFound() {
370 public String fullID() {
375 public String email() {
380 public List<String> delegate() {
384 public String fullName() {
388 public Organization org() {
392 public String firstName() {
396 public boolean isPerson() {
401 public Identity responsibleTo() {
406 public String getName() {
411 public String getRealm() {
416 public boolean supportsRealm(String r) {
421 public void addSupportedRealm(String r) {
425 public String getDomain() {
430 public Identity getIdentity(AuthzTrans trans, String id) {
435 public String isValidID(final AuthzTrans trans, String id) {
440 public String isValidPassword(final AuthzTrans trans, final String user, final String password, final String... prev) {
445 public Set<String> getIdentityTypes() {
446 return nullStringSet;
450 public Response notify(AuthzTrans trans, Notify type, String url,
451 String[] users, String[] ccs, String summary, Boolean urgent) {
452 return Response.ERR_NotImplemented;
456 public int sendEmail(AuthzTrans trans, List<String> toList, List<String> ccList,
457 String subject, String body, Boolean urgent) throws OrganizationException {
462 public Date whenToValidate(Notify type, Date lastValidated) {
467 public GregorianCalendar expiration(GregorianCalendar gc,
468 Expiration exp, String... extra) {
473 public List<Identity> getApprovers(AuthzTrans trans, String user)
474 throws OrganizationException {
479 public String getApproverType() {
484 public int startOfDay() {
489 public boolean canHaveMultipleCreds(String id) {
494 public boolean isValidCred(final AuthzTrans trans, final String id) {
499 public String validate(AuthzTrans trans, Policy policy, Executor executor, String ... vars)
500 throws OrganizationException {
501 return "Null Organization rejects all Policies";
505 public boolean isTestEnv() {
510 public void setTestMode(boolean dryRun) {
514 public EmailWarnings emailWarningPolicy() {
515 return new EmailWarnings() {
518 public long credEmailInterval()
520 return 604800000L; // 7 days in millis 1000 * 86400 * 7
524 public long roleEmailInterval()
526 return 604800000L; // 7 days in millis 1000 * 86400 * 7
530 public long apprEmailInterval() {
531 return 259200000L; // 3 days in millis 1000 * 86400 * 3
535 public long credExpirationWarning()
537 return( 2592000000L ); // One month, in milliseconds 1000 * 86400 * 30 in milliseconds
541 public long roleExpirationWarning()
543 return( 2592000000L ); // One month, in milliseconds 1000 * 86400 * 30 in milliseconds
547 public long emailUrgentWarning()
549 return( 1209600000L ); // Two weeks, in milliseconds 1000 * 86400 * 14 in milliseconds
558 public String[] getPasswordRules() {
559 return nullStringArray;
563 public boolean isRevoked(AuthzTrans trans, String id) {
564 // provide a corresponding feed that indicates that an ID has been intentionally removed from identities.dat table.
569 public List<Identity> getIDs(AuthzTrans trans, String user, int escalate) throws OrganizationException {
570 // TODO Auto-generated method stub