core/src/main/java/com/att/cadi/Taf.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START====================================================\r
   3  * * org.onap.aai\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * Copyright © 2017 Amdocs\r
   7  * * ===========================================================================\r
   8  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   9  * * you may not use this file except in compliance with the License.\r
  10  * * You may obtain a copy of the License at\r
  11  * * \r
  12  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  13  * * \r
  14  *  * Unless required by applicable law or agreed to in writing, software\r
  15  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  16  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  17  * * See the License for the specific language governing permissions and\r
  18  * * limitations under the License.\r
  19  * * ============LICENSE_END====================================================\r
  20  * *\r
  21  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  22  * *\r
  23  ******************************************************************************/\r
  24 package com.att.cadi;\r
  25 \r
  26 import com.att.cadi.taf.TafResp;\r
  27 \r
  28 \r
  29 /**\r
  30  * TAF - Transmutative Assertion Framework.  \r
  31  * \r
  32  * This main Interface embodies the essential of the assertion, where a number of different TAFs might be used to authenticate\r
  33  * and that authentication to be recognized through other elements.\r
  34  * \r
  35  * Concept by Robert Garskof.  Implemented by Jonathan Gathman\r
  36  *  \r
  37  *\r
  38  */\r
  39 public interface Taf {\r
  40         enum LifeForm {CBLF, SBLF, LFN};\r
  41         /**\r
  42          * The lifeForm param is a humorous way of describing whether the interaction is proceeding from direct Human Interaction via a browser \r
  43          * or App which can directly query a memorized password, key sequence, bio-feedback, from that user, or a machine mechanism for which identity\r
  44          * can more easily be determined by Certificate, Mechanical ID/Password etc.  Popularized in modern culture and Science Fiction (especially \r
  45          * Star Trek), we (starting with Robert Garskof) use the terms "Carbon Based Life Form" (CBLF) for mechanisms with people at the end of them, or \r
  46          * "Silicon Based Life Forms" (SBLF) to indicate machine only interactions.  I have added "LFN" for (Life-Form Neutral) to aid identifying\r
  47          * processes for which it doesn't matter whether there is a human at the immediate end of the chain, or cannot be determined mechanically.  \r
  48          * \r
  49          * The variable parameter is not necessarily ideal, but with too many unknown Tafs to be created, flexibility,\r
  50          * is unfortunately required at this point.  Future versions could lock this down more.  JG 10/18/2012\r
  51          * \r
  52          * @param lifeForm\r
  53          * @param info\r
  54          * @return\r
  55          */\r
  56         public TafResp validate(LifeForm reading, String ... info);\r
  57         \r
  58 }\r