docs/sections/configuration/client.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 Client Configuration
   5 ====================
   6
   7 TEST version of "cadi.properties"
   8 ---------------------------------
   9 These properties point you to the ONAP TEST environment.
  10
  11 Properties are separated into
  12
  13  * etc
  14     * main Property file which provides Client specific info.  As a client, this could be put in container, or placed on Host Box
  15     * The important thing is to LINK the property with Location and Certificate Properties, see "local"
  16  * local
  17    * where there is Machine specific information (i.e. GEO Location (Latitude/Longitude)
  18    * where this is Machine specific Certificates (for running services)
  19        * This is because the certificates used must match the Endpoint that the Container is running on
  20        * Note Certificate Manager can Place all these components together in one place.
  21            * For April, 2018, please write Jonathan.gathman@att.com for credentials until TEST Env with Certificate Manager is fully tested.  Include
  22            1. AAF Namespace (you MUST be the owner for the request to be accepted)
  23            2. Fully Qualified App ID (ID + Namespace)
  24            3. Machine to be deployed on.
  25
  26 Client Credentials
  27 ------------------
  28 For Beijing, full TLS is expected among all components.  AAF provides the "Certificate Manager" which can "Place" Certificate information
  29
  30 Example Source Code
  31 -------------------
  32 Note the FULL class is available in the authz repo, cadi_aaf/org/onap/aaf/client/sample/Sample.java
  33
  34 .. code:: java
  35
  36 /**
  37  * ============LICENSE_START====================================================
  38  * org.onap.aaf
  39  * ===========================================================================
  40  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
  41  * ===========================================================================
  42  * Licensed under the Apache License, Version 2.0 (the "License");
  43  * you may not use this file except in compliance with the License.
  44  * You may obtain a copy of the License at
  45  *
  46  *      http://www.apache.org/licenses/LICENSE-2.0
  47  *
  48  * Unless required by applicable law or agreed to in writing, software
  49  * distributed under the License is distributed on an "AS IS" BASIS,
  50  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  51  * See the License for the specific language governing permissions and
  52  * limitations under the License.
  53  * ============LICENSE_END====================================================
  54  *
  55  */
  56
  57 package org.onap.aaf.client.sample;
  58
  59 import java.io.IOException;
  60 import java.security.Principal;
  61 import java.util.ArrayList;
  62 import java.util.List;
  63
  64 import org.onap.aaf.cadi.Access;
  65 import org.onap.aaf.cadi.CadiException;
  66 import org.onap.aaf.cadi.LocatorException;
  67 import org.onap.aaf.cadi.Permission;
  68 import org.onap.aaf.cadi.PropAccess;
  69 import org.onap.aaf.cadi.aaf.AAFPermission;
  70 import org.onap.aaf.cadi.aaf.v2_0.AAFAuthn;
  71 import org.onap.aaf.cadi.aaf.v2_0.AAFConHttp;
  72 import org.onap.aaf.cadi.aaf.v2_0.AAFLurPerm;
  73 import org.onap.aaf.cadi.principal.UnAuthPrincipal;
  74 import org.onap.aaf.cadi.util.Split;
  75 import org.onap.aaf.misc.env.APIException;
  76
  77 public class Sample {
  78     private static Sample singleton;
  79     final private AAFConHttp aafcon;
  80     final private AAFLurPerm aafLur;
  81     final private AAFAuthn<?> aafAuthn;
  82
  83     /**
  84      * This method is to emphasize the importance of not creating the AAFObjects over and over again.
  85      * @return
  86      */
  87     public static Sample singleton() {
  88         return singleton;
  89     }
  90
  91     public Sample(Access myAccess) throws APIException, CadiException, LocatorException {
  92         aafcon = new AAFConHttp(myAccess);
  93         aafLur = aafcon.newLur();
  94         aafAuthn = aafcon.newAuthn(aafLur);
  95     }
  96
  97     /**
  98      * Checking credentials outside of HTTP/S presents fewer options initially. There is not, for instance,
  99      * the option of using 2-way TLS HTTP/S.
 100      *
 101      *  However, Password Checks are still useful, and, if the Client Certificate could be obtained in other ways, the
 102      *  Interface can be expanded in the future to include Certificates.
 103      * @throws CadiException
 104      * @throws IOException
 105      */
 106     public Principal checkUserPass(String fqi, String pass) throws IOException, CadiException {
 107         String ok = aafAuthn.validate(fqi, pass);
 108         if(ok==null) {
 109             System.out.println("Success!");
 110             /*
 111              UnAuthPrincipal means that it is not coming from the official Authorization chain.
 112              This is useful for Security Plugins which don't use Principal as the tie between
 113              Authentication and Authorization
 114
 115              You can also use this if you want to check Authorization without actually Authenticating, as may
 116              be the case with certain Onboarding Tooling.
 117             */
 118             return new UnAuthPrincipal(fqi);
 119         } else {
 120             System.out.printf("Failure: %s\n",ok);
 121             return null;
 122         }
 123
 124
 125     }
 126
 127     /**
 128      * An example of looking for One Permission within all the permissions user has.  CADI does cache these,
 129      * so the call is not expensive.
 130      *
 131      * Note: If you are using "J2EE" (Servlets), CADI ties this function to the method:
 132      *    HttpServletRequest.isUserInRole(String user)
 133      *
 134      *  The J2EE user can expect that his servlet will NOT be called without a Validated Principal, and that
 135      *  "isUserInRole()" will validate if the user has the Permission designated.
 136      *
 137      */
 138     public boolean oneAuthorization(Principal fqi, Permission p) {
 139         return aafLur.fish(fqi, p);
 140     }
 141
 142     public List<Permission> allAuthorization(Principal fqi) {
 143         List<Permission> pond = new ArrayList<Permission>();
 144         aafLur.fishAll(fqi, pond);
 145         return pond;
 146     }
 147
 148
 149     public static void main(String[] args) {
 150         // Note: you can pick up Properties from Command line as well as VM Properties
 151         // Code "user_fqi=... user_pass=..." (where user_pass can be encrypted) in the command line for this sample.
 152         // Also code "perm=<perm type>|<instance>|<action>" to test a specific Permission
 153         PropAccess myAccess = new PropAccess(args);
 154         try {
 155             /*
 156              * NOTE:  Do NOT CREATE new aafcon, aafLur and aafAuthn each transaction.  They are built to be
 157              * reused!
 158              *
 159              * This is why this code demonstrates "Sample" as a singleton.
 160              */
 161             singleton = new Sample(myAccess);
 162             String user = myAccess.getProperty("user_fqi");
 163             String pass= myAccess.getProperty("user_pass");
 164
 165             if(user==null || pass==null) {
 166                 System.err.println("This Sample class requires properties user_fqi and user_pass");
 167             } else {
 168                 pass =  myAccess.decrypt(pass, false); // Note, with "false", decryption will only happen if starts with "enc:"
 169                 // See the CODE for Java Methods used
 170                 Principal fqi = Sample.singleton().checkUserPass(user,pass);
 171
 172                 if(fqi==null) {
 173                     System.out.println("OK, normally, you would cease processing for an "
 174                             + "unauthenticated user, but for the purpose of Sample, we'll keep going.\n");
 175                     fqi=new UnAuthPrincipal(user);
 176                 }
 177
 178                 // AGAIN, NOTE: If your client fails Authentication, the right behavior 99.9%
 179                 // of the time is to drop the transaction.  We continue for sample only.
 180
 181                 // note, default String for perm
 182                 String permS = myAccess.getProperty("perm","org.osaaf.aaf.access|*|read");
 183                 String[] permA = Split.splitTrim('|', permS);
 184                 if(permA.length>2) {
 185                     final Permission perm = new AAFPermission(permA[0],permA[1],permA[2]);
 186                     // See the CODE for Java Methods used
 187                     if(singleton().oneAuthorization(fqi, perm)) {
 188                         System.out.printf("Success: %s has %s\n",fqi.getName(),permS);
 189                     } else {
 190                         System.out.printf("%s does NOT have %s\n",fqi.getName(),permS);
 191                     }
 192                 }
 193
 194
 195                 // Another form, you can get ALL permissions in a list
 196                 // See the CODE for Java Methods used
 197                 List<Permission> permL = singleton().allAuthorization(fqi);
 198                 if(permL.size()==0) {
 199                     System.out.printf("User %s has no Permissions THAT THE CALLER CAN SEE",fqi.getName());
 200                 } else {
 201                     System.out.print("Success:\n");
 202                     for(Permission p : permL) {
 203                         System.out.printf("\t%s has %s\n",fqi.getName(),p.getKey());
 204                     }
 205                 }
 206             }
 207         } catch (APIException | CadiException | LocatorException | IOException e) {
 208             e.printStackTrace();
 209         }
 210     }
 211 }