resource/include/OCSecurityModel.h

   1 //******************************************************************
   2 //
   3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   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
  10 //
  11 //      http://www.apache.org/licenses/LICENSE-2.0
  12 //
  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 //
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  20
  21 /// @file OCSecurityModel.h
  22
  23 /// @brief      This file contains the declaration of classes and its members required to provide
  24 ///                     security model support.
  25
  26 #ifndef __OCSECURITYMODEL_H
  27 #define __OCSECURITYMODEL_H
  28
  29 #include "OCApi.h"
  30
  31 namespace OC
  32 {
  33         /**
  34         * @brief        This class provides the required security model to
  35         *                       access a service or a particular resource.
  36         */
  37         class OCSecurityModel
  38         {
  39         public:
  40                 OCSecurityModel(void);
  41
  42                 virtual ~OCSecurityModel(void);
  43
  44                 /**
  45                 * @fn   checks the security access
  46                 *
  47                 * @param sourceURI - source URI
  48                 * @param destinationURI - destination URI of the resoruce to access
  49                 * @param encryptionLevel - Encryption level
  50                 * @param remoteIdentity - remote identity
  51                 */
  52                 void checkAccess(URI sourceURI, URI destinationURI, int encryptionLevel, int remoteIdentity);
  53         };
  54 }
  55
  56 #endif //__OCSECURITYMODEL_H