docs/developer-guide/usecplugin-aaa-developer-guide.rst

   1 Usecplugin-AAA Developer Guide
   2 ==============================
   3
   4 Overview
   5 --------
   6
   7 Usecplugin-AAA provides security related information for the AAA
   8 northbound interface.
   9
  10 Usecplugin-AAA Architecture
  11 ---------------------------
  12
  13 AAA plugin creates log messages about successful and failed login
  14 attempts to OpenDaylight. Usecplugin-AAA continuously reads this log
  15 file and checks for either successful and failed attempt information.
  16 Whenever Usecpluin-AAA identifies a new attempt entry in the log file it
  17 is stored in YANG Data Store and its own log file.
  18
  19 Usecplugin-AAA is implemented with the help of a few java classes.
  20
  21 UsecpluginAAAProvider
  22     Provider class for Usecplugin-AAA feature implementation.
  23
  24 UsecpluginAAANotifImpl
  25     Logs notification information which can be seen by log:display at
  26     the Karaf terminal
  27
  28 UsecpluginAAARPCImpl
  29     Implements Usecplugin RPCs
  30
  31 UsecpluginAAAParsingLog
  32     Parses OpenDaylight log information for identifying login attempts.
  33
  34 UsecpluginAAAPublishNotif
  35     Publishes failed login attempt notification.
  36
  37 UsecpluginAAAStore
  38     Creates login information at the YANG Data Store.
  39
  40 Key APIs and Interfaces
  41 -----------------------
  42
  43 -  RPC APIs
  44
  45    Login Attempt from IP
  46        Returns Time and Type of Attempts (Success or Failure)
  47
  48    Login Attempt at Time
  49        Returns Attempter IP Address and Type of Attempts (Success or
  50        Failure)
  51
  52 -  Notification APIs
  53
  54    On Invalid Login Attempt
  55        Notification generated on Invalid Login Attempt
  56
  57 -  YANG Data Store APIs
  58
  59    Get Login Attempts
  60        Returns Source IP address of Attempter with Time of Attempts and
  61        Type of Attempts (Success or Failure)
  62