mlpiAccessControlLib.h

Go to the documentation of this file.

#ifndef __MLPIACCESSCONTROLLIB_H__
#define __MLPIACCESSCONTROLLIB_H__

// -----------------------------------------------------------------------
// MLPI - <mlpiAccessControlLib.h>
// -----------------------------------------------------------------------
// Copyright (c) 2016 Bosch Rexroth. All rights reserved.
// Redistribution and use in source and binary forms of this MLPI software
// (SW) provided to you, with or without modification, are permitted
// without prior approval provided that the following conditions are met:
//
// 1. Redistributions of source code of SW must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form of SW must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. User recognizes and acknowledges that it acquires no right,
// title or interest in or to any of the names or trademarks used in
// connection with the SW ("names") by virtue of this License and waives
// any right to or interest in the names. User recognizes and acknowledges
// that names of companies or names or products of companies displayed
// in the documentation of SW to indicate the interoperability of products
// with the SW are the names of their respective owners. The use of such
// names in the documentation of SW does not imply any sponsorship,
// approval, or endorsement by such companies of this product.
//
// 4. Modified code versions, i.e. any addition to or deletion from
// the substance or structure of the original code of the SW running
// the MLPI must be plainly marked as such and must not be misrepresented
// as being original SW.
//
// 5. The SW may only be used in connection with a Bosch Rexroth product.
//
// THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
// AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
// (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
// INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
// ERRORS OR INACCURACIES.
// SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
// THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
// NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
// THE  SOFTWARE  DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
// DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
// -----------------------------------------------------------------------
//
//
// -----------------------------------------------------------------------



// -----------------------------------------------------------------------
// GLOBAL INCLUDES
// -----------------------------------------------------------------------
#include "mlpiGlobal.h"

// -----------------------------------------------------------------------
// GLOBAL CONSTANTS
// -----------------------------------------------------------------------


// , ; " "

#define MLPI_MAX_USERNAME_LEN            (32)
#define MLPI_MAX_GROUPNAME_LEN           (32)
#define MLPI_MAX_INVALIDCHARS_LEN        (32)
#define MLPI_MAX_USER_DESCRIPTION_LEN    (128)
#define MLPI_MAX_GROUP_DESCRIPTION_LEN   (128)
#define MLPI_MAX_PERMISSION_LEN          (128)

//-----------------------------------------------------------------------
// GLOBAL ENUMERATIONS
//-----------------------------------------------------------------------

typedef enum MlpiUserPersistenceType
{
  MLPI_USER_PERSISTENCE_TYPE_TEMPORARY  = 0, 
  MLPI_USER_PERSISTENCE_TYPE_PERMANENT  = 1  
}MlpiUserPersistenceType;

typedef enum MlpiAccessControlExpirationTimeUnit
{
  MLPI_ACCESSCONTROL_EXPIRATION_UNIT_MINUTES   = 0, 
  MLPI_ACCESSCONTROL_EXPIRATION_UNIT_DAYS      = 1, 
}MlpiAccessControlExpirationTimeUnit;

// -----------------------------------------------------------------------
// GLOBAL TYPEDEFS
// -----------------------------------------------------------------------

// message packing follows 8 byte natural alignment
#if !defined(TARGET_OS_VXWORKS)
#pragma pack(push,8)
#endif

typedef struct MlpiUserInfo
{
  ULONG                      MLPI_STRUCT_ALIGN_ULONG    userId;
  WCHAR16                    MLPI_STRUCT_ALIGN_WCHAR16  username[MLPI_MAX_USERNAME_LEN];
  WCHAR16                    MLPI_STRUCT_ALIGN_WCHAR16  description[MLPI_MAX_USER_DESCRIPTION_LEN];
  MlpiUserPersistenceType    MLPI_STRUCT_ALIGN_ENUM     persistenceType;
  BOOL8                      MLPI_STRUCT_ALIGN_BOOL8    disabled;
} MlpiUserInfo;



typedef struct MlpiAccessControlExpirationDetails
{
  BOOL8                                MLPI_STRUCT_ALIGN_BOOL8  enabled;
  ULONG                                MLPI_STRUCT_ALIGN_ULONG  expirationTime;
  MlpiAccessControlExpirationTimeUnit  MLPI_STRUCT_ALIGN_ENUM   expirationTimeUnit;
} MlpiAccessControlExpirationDetails;

typedef struct MlpiUserDetails
{
  ULONG                                 MLPI_STRUCT_ALIGN_ULONG    userId;
  WCHAR16                               MLPI_STRUCT_ALIGN_WCHAR16  username[MLPI_MAX_USERNAME_LEN];
  WCHAR16                               MLPI_STRUCT_ALIGN_WCHAR16  description[MLPI_MAX_USER_DESCRIPTION_LEN];
  BOOL8                                 MLPI_STRUCT_ALIGN_BOOL8    disabled;
  BOOL8                                 MLPI_STRUCT_ALIGN_BOOL8    userExpirationEnabled;
  MlpiDateAndTime                       MLPI_STRUCT_ALIGN_STRUCT   userExpirationTime;
  MlpiAccessControlExpirationDetails    MLPI_STRUCT_ALIGN_STRUCT   sessionExpiration;
  MlpiUserPersistenceType               MLPI_STRUCT_ALIGN_ENUM     persistenceType;
} MlpiUserDetails;

typedef struct MlpiPasswordPolicies
{
  ULONG  MLPI_STRUCT_ALIGN_ULONG  minLength;
  ULONG  MLPI_STRUCT_ALIGN_ULONG  maxLength;
  ULONG  MLPI_STRUCT_ALIGN_ULONG  minUpperCase;
  ULONG  MLPI_STRUCT_ALIGN_ULONG  minLowerCase;
  ULONG  MLPI_STRUCT_ALIGN_ULONG  minNumerical;
  ULONG  MLPI_STRUCT_ALIGN_ULONG  minSpecial;
} MlpiPasswordPolicies;

typedef struct MlpiUserPolicies
{
  ULONG                                MLPI_STRUCT_ALIGN_ULONG    usernameMinLength;
  ULONG                                MLPI_STRUCT_ALIGN_ULONG    usernameMaxLength;
  WCHAR16                              MLPI_STRUCT_ALIGN_WCHAR16  usernameInvalidChars[MLPI_MAX_INVALIDCHARS_LEN];  
  ULONG                                MLPI_STRUCT_ALIGN_ULONG    descriptionMinLength;
  ULONG                                MLPI_STRUCT_ALIGN_ULONG    descriptionMaxLength;
  MlpiAccessControlExpirationDetails   MLPI_STRUCT_ALIGN_STRUCT   sessionExpirationSettings;
} MlpiUserPolicies;

typedef struct MlpiGroupInfo
{
  ULONG    MLPI_STRUCT_ALIGN_ULONG    groupId;
  WCHAR16  MLPI_STRUCT_ALIGN_WCHAR16  groupName[MLPI_MAX_GROUPNAME_LEN];
  WCHAR16  MLPI_STRUCT_ALIGN_WCHAR16  description[MLPI_MAX_GROUP_DESCRIPTION_LEN];
  BOOL8    MLPI_STRUCT_ALIGN_BOOL8    disabled;
} MlpiGroupInfo;

typedef struct MlpiGroupPolicies
{
  ULONG    MLPI_STRUCT_ALIGN_ULONG    groupNameMinLength;
  ULONG    MLPI_STRUCT_ALIGN_ULONG    groupNameMaxLength;
  WCHAR16  MLPI_STRUCT_ALIGN_WCHAR16  groupNameInvalidChars[MLPI_MAX_INVALIDCHARS_LEN];  
  ULONG    MLPI_STRUCT_ALIGN_ULONG    descriptionMinLength;
  ULONG    MLPI_STRUCT_ALIGN_ULONG    descriptionMaxLength;
} MlpiGroupPolicies;

typedef struct MlpiGroupDetails
{
  ULONG   MLPI_STRUCT_ALIGN_ULONG    groupId;
  WCHAR16 MLPI_STRUCT_ALIGN_WCHAR16  groupName[MLPI_MAX_GROUPNAME_LEN];
  WCHAR16 MLPI_STRUCT_ALIGN_WCHAR16  description[MLPI_MAX_GROUP_DESCRIPTION_LEN];
  BOOL8   MLPI_STRUCT_ALIGN_BOOL8    disabled;
} MlpiGroupDetails;

#if !defined(TARGET_OS_VXWORKS)
#pragma pack(pop)
#endif

// -----------------------------------------------------------------------
// GLOBAL EXPORTS
// -----------------------------------------------------------------------
#ifdef MLPI_API
#undef MLPI_API
#endif

#if defined(TARGET_OS_WINNT)
#if defined(MLPI_EXPORTS)
#define MLPI_API __declspec(dllexport)
#elif defined(MLPI_IMPORTS)
#define MLPI_API __declspec(dllimport)
#else
#define MLPI_API
#endif
#else
#if defined(MLPI_EXPORTS)
#define MLPI_API __attribute__ ((visibility("default")))
#elif defined(MLPI_IMPORTS)
#define MLPI_API
#else
#define MLPI_API
#endif
#endif

#ifdef __cplusplus
extern "C" {
#endif



MLPI_API MLPIRESULT mlpiAccessControlGetUserPolicies(const MLPIHANDLE connection, MlpiUserPolicies* userPolicies);

MLPI_API MLPIRESULT mlpiAccessControlGetPasswordPolicies(const MLPIHANDLE connection, MlpiPasswordPolicies* passwordPolicies);

MLPI_API MLPIRESULT mlpiAccessControlGetAllUserInfos(const MLPIHANDLE connection, MlpiUserInfo* userInfos, const ULONG numElements, ULONG* numElementsRet);

MLPI_API MLPIRESULT mlpiAccessControlAddUser(const MLPIHANDLE connection, MlpiUserDetails userDetails, const WCHAR16* tmpPassword);

MLPI_API MLPIRESULT mlpiAccessControlGetUser(const MLPIHANDLE connection,  const WCHAR16* username, MlpiUserDetails* userDetails);

MLPI_API MLPIRESULT mlpiAccessControlSetUser(const MLPIHANDLE connection, MlpiUserDetails userDetails);

MLPI_API MLPIRESULT mlpiAccessControlDeleteUser(const MLPIHANDLE connection, const WCHAR16* username);

MLPI_API MLPIRESULT mlpiAccessControlChangePassword(const MLPIHANDLE connection, const WCHAR16* username, const WCHAR16* oldPassword, const WCHAR16* newPassword);

MLPI_API MLPIRESULT mlpiAccessControlGetAllGroupInfos(const MLPIHANDLE connection, MlpiGroupInfo* groupInfos, const ULONG numElements, ULONG* numElementsRet);

MLPI_API MLPIRESULT mlpiAccessControlGetAllGroupsOfUser(const MLPIHANDLE connection, const WCHAR16* username, WCHAR16* groupNames, const ULONG numElements, ULONG* numElementsRet);

MLPI_API MLPIRESULT mlpiAccessControlGetAllUsersOfGroup(const MLPIHANDLE connection, const WCHAR16* groupName, WCHAR16* usernames, const ULONG numElements, ULONG* numElementsRet);

MLPI_API MLPIRESULT mlpiAccessControlAddUserToGroup(const MLPIHANDLE connection, const WCHAR16* groupName, const WCHAR16* username);

MLPI_API MLPIRESULT mlpiAccessControlRemoveUserFromGroup(const MLPIHANDLE connection, const WCHAR16* groupName, const WCHAR16* username);

MLPI_API MLPIRESULT mlpiAccessControlSetUsersOfGroup(const MLPIHANDLE connection, const WCHAR16* groupName, const WCHAR16* usernames);

MLPI_API MLPIRESULT mlpiAccessControlSetGroupsOfUser(const MLPIHANDLE connection, const WCHAR16* username, const WCHAR16* groupNames);

MLPI_API MLPIRESULT mlpiAccessControlGetGroupPolicies(const MLPIHANDLE connection, MlpiGroupPolicies* groupPolicies);

MLPI_API MLPIRESULT mlpiAccessControlResetPassword(const MLPIHANDLE connection, const WCHAR16* username, const WCHAR16* newPassword);

MLPI_API MLPIRESULT mlpiAccessControlAddGroup(const MLPIHANDLE connection, MlpiGroupDetails groupDetails);


MLPI_API MLPIRESULT mlpiAccessControlGetGroup(const MLPIHANDLE connection, const WCHAR16* groupName, MlpiGroupDetails* groupDetails);

MLPI_API MLPIRESULT mlpiAccessControlSetGroup(const MLPIHANDLE connection, MlpiGroupDetails groupDetails);

MLPI_API MLPIRESULT mlpiAccessControlDeleteGroup(const MLPIHANDLE connection, const WCHAR16* groupName);

MLPI_API MLPIRESULT mlpiAccessControlSetPermissionsOfGroup(const MLPIHANDLE connection, const WCHAR16* groupName, const WCHAR16* permissions);

MLPI_API MLPIRESULT mlpiAccessControlGetAllPermissionsOfGroup(const MLPIHANDLE connection, const WCHAR16* groupName, WCHAR16* permissions, const ULONG numElements, ULONG* numElementsRet); 

MLPI_API MLPIRESULT mlpiAccessControlGetAllPermissions(const MLPIHANDLE connection, WCHAR16* permissions, const ULONG numElements, ULONG* numElementsRet);

MLPI_API MLPIRESULT mlpiAccessControlSetAuthorizedGroupsOfPermission(const MLPIHANDLE connection, const WCHAR16* permission, const WCHAR16* groupNames);

MLPI_API MLPIRESULT mlpiAccessControlGetAllAuthorizedGroupsOfPermission(const MLPIHANDLE connection, const WCHAR16* permission, WCHAR16* groupNames, const ULONG numElements, ULONG* numElementsRet);

MLPI_API MLPIRESULT mlpiAccessControlAddPermissionToGroup(const MLPIHANDLE connection, const WCHAR16* groupName, const WCHAR16* permission);

MLPI_API MLPIRESULT mlpiAccessControlRemovePermissionFromGroup(const MLPIHANDLE connection, const WCHAR16* groupName, const WCHAR16* permission);

#ifdef __cplusplus
}
#endif
#endif /*__MLPIACCESSCONTROLLIB_H__*/