core/sql/sqlcomp/PrivMgrDefs.h - trafodion - Git at Google

 //*****************************************************************************
 // @@@ START COPYRIGHT @@@
 //
 // Licensed to the Apache Software Foundation (ASF) under one
 // or more contributor license agreements.  See the NOTICE file
 // distributed with this work for additional information
 // regarding copyright ownership.  The ASF licenses this file
 // to you under the Apache License, Version 2.0 (the
 // "License"); you may not use this file except in compliance
 // with the License.  You may obtain a copy of the License at
 //
 //   http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing,
 // software distributed under the License is distributed on an
 // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 // KIND, either express or implied.  See the License for the
 // specific language governing permissions and limitations
 // under the License.
 //
 //// @@@ END COPYRIGHT @@@
 //*****************************************************************************

 #ifndef PRIVMGR_DEFS_H
 #define PRIVMGR_DEFS_H

 #include <bitset>
 #include <map>
 #include <iterator>
 #include "NAUserId.h"
 #include "ComSmallDefs.h"

 // *****************************************************************************
 // *
 // * File:         PrivMgrDef.h
 // * Description:  This file contains common definitions used by the
 // *               privilege manager component
 // *
 // *****************************************************************************

 // Returns the result of the operation
 enum PrivStatus { STATUS_UNKNOWN   = 20,
                   STATUS_GOOD      = 21,
                   STATUS_WARNING   = 22,
                   STATUS_NOTFOUND  = 23,
                   STATUS_ERROR     = 24
                 };

 inline const char * privStatusEnumToLit(PrivStatus privStatus)
 {
   std::string result;
   switch (privStatus)
   {
     case STATUS_GOOD:
       result = "GOOD";
       break;
     case STATUS_WARNING:
       result = "WARNING";
       break;
     case STATUS_NOTFOUND:
       result = "NOTFOUND";
       break;
     case STATUS_ERROR:
       result = "ERROR";
       break;
     default:
       result = "UNKNOWN";
   }
   return result.c_str();
 }


 enum {SQL_OPERATIONS_COMPONENT_UID = 1};
 #define SQL_OPERATION_NAME "SQL_OPERATIONS"

 #define PRIVMGR_INTERNAL_ERROR(text)                                      \
    *pDiags_ << DgSqlCode(-CAT_INTERNAL_EXCEPTION_ERROR)                   \
             << DgString0(__FILE__)                                        \
             << DgInt0(__LINE__)                                           \
             << DgString1(text)


 enum class PrivClass {
    ALL = 2,
    OBJECT = 3,
    COMPONENT = 4,
    SCHEMA = 5
 };

 // Defines the list of supported privileges
 // and their order in the privilege and grantable bitmaps
 // stored in the OBJECT_PRIVILEGES table
 enum PrivType { SELECT_PRIV = 0, //DML PRIVS START HERE
                 INSERT_PRIV,
                 DELETE_PRIV,
                 UPDATE_PRIV,
                 USAGE_PRIV,
                 REFERENCES_PRIV,
                 EXECUTE_PRIV,
                 CREATE_PRIV,     //DDL PRIVS START HERE
                 ALTER_PRIV,
                 DROP_PRIV,
                 ALL_DML,
                 ALL_DDL,
                 ALL_PRIVS };

 class ColPrivSpec
 {
 public:
    PrivType       privType;
    int32_t        columnOrdinal;
    bool           grantorHasWGO;
 };

 inline bool isColumnPrivType(PrivType privType)
 {

    return (privType == PrivType::SELECT_PRIV ||
            privType == PrivType::INSERT_PRIV ||
            privType == PrivType::REFERENCES_PRIV ||
            privType == PrivType::UPDATE_PRIV);

 }

 inline bool isLibraryPrivType(PrivType privType)
 {

    return (privType == PrivType::USAGE_PRIV ||
            privType == PrivType::UPDATE_PRIV);

 }

 inline bool isTablePrivType(PrivType privType)
 {

    return (privType == PrivType::SELECT_PRIV ||
            privType == PrivType::INSERT_PRIV ||
            privType == PrivType::DELETE_PRIV ||
            privType == PrivType::REFERENCES_PRIV ||
            privType == PrivType::UPDATE_PRIV);

 }

 inline bool isUDRPrivType(PrivType privType)
 {

    return (privType == PrivType::EXECUTE_PRIV);

 }

 inline bool isSequenceGeneratorPrivType(PrivType privType)
 {

    return (privType == PrivType::USAGE_PRIV);

 }

 // Defines the list of privileges that are supported for the
 // SQLOperation component
 enum class SQLOperation {
    ALTER = 2,
    ALTER_LIBRARY,
    ALTER_ROUTINE,
    ALTER_ROUTINE_ACTION,
    ALTER_SCHEMA,
    ALTER_SEQUENCE,
    ALTER_SYNONYM,
    ALTER_TABLE,
    ALTER_TRIGGER,
    ALTER_VIEW,
    CREATE,
    CREATE_CATALOG,
    CREATE_INDEX,
    CREATE_LIBRARY,
    CREATE_PROCEDURE,
    CREATE_ROUTINE,
    CREATE_ROUTINE_ACTION,
    CREATE_SCHEMA,
    CREATE_SEQUENCE,
    CREATE_SYNONYM,
    CREATE_TABLE,
    CREATE_TRIGGER,
    CREATE_VIEW,
    DML_DELETE,
    DML_EXECUTE,
    DML_INSERT,
    DML_REFERENCES,
    DML_SELECT,
    DML_UPDATE,
    DML_USAGE,
    DROP,
    DROP_CATALOG,
    DROP_INDEX,
    DROP_LIBRARY,
    DROP_PROCEDURE,
    DROP_ROUTINE,
    DROP_ROUTINE_ACTION,
    DROP_SCHEMA,
    DROP_SEQUENCE,
    DROP_SYNONYM,
    DROP_TABLE,
    DROP_TRIGGER,
    DROP_VIEW,
    MANAGE,
    MANAGE_COMPONENTS,
    MANAGE_LIBRARY,
    MANAGE_LOAD,
    MANAGE_PRIVILEGES,
    MANAGE_ROLES,
    MANAGE_STATISTICS,
    MANAGE_USERS,
    QUERY_ACTIVATE,
    QUERY_CANCEL,
    QUERY_SUSPEND,
    REMAP_USER,
    REGISTER_HIVE_OBJECT,
    SHOW,
    UNREGISTER_HIVE_OBJECT,
    USE_ALTERNATE_SCHEMA,
    COMMENT,
    FIRST_OPERATION = ALTER,
    LAST_OPERATION = COMMENT,
    NUMBER_OF_OPERATIONS = LAST_OPERATION - FIRST_OPERATION + 1,
    UNKNOWN,
    FIRST_DML_PRIV = DML_DELETE,
    LAST_DML_PRIV = DML_USAGE
 };

 enum class PrivDropBehavior {
    CASCADE = 2,
    RESTRICT = 3
 };

 enum class PrivLevel {
    UNKNOWN = 0,
    GLOBAL = 2,
    CATALOG = 3,
    SCHEMA = 4,
    OBJECT = 5,
    COLUMN = 6
 };

 // NOTE: These values need to match the corresponding values in
 // common/ComSmallDefs.h, ComIdClass.
 enum class PrivAuthClass {
    UNKNOWN = 0,
    ROLE = 1,
    USER = 2
 };

 const static int32_t FIRST_DML_PRIV = SELECT_PRIV;
 const static int32_t FIRST_DML_COL_PRIV = SELECT_PRIV;
 const static int32_t FIRST_PRIV = SELECT_PRIV;
 const static int32_t LAST_PRIMARY_DML_PRIV = UPDATE_PRIV;
 const static int32_t LAST_DML_PRIV = EXECUTE_PRIV;
 const static int32_t LAST_DML_COL_PRIV = REFERENCES_PRIV;
 const static int32_t FIRST_DDL_PRIV = CREATE_PRIV;
 const static int32_t LAST_DDL_PRIV = DROP_PRIV;
 const static int32_t LAST_PRIV = DROP_PRIV;

 const static int32_t NBR_DML_PRIVS = LAST_DML_PRIV-FIRST_DML_PRIV + 1;
 // This calculation includes non-column-level privileges.  There are only four
 // column-level privileges, but DELETE and USAGE are include so bit indexing works.
 const static int32_t NBR_DML_COL_PRIVS = LAST_DML_COL_PRIV - FIRST_DML_COL_PRIV + 1;
 const static int32_t NBR_DDL_PRIVS = LAST_DDL_PRIV-FIRST_DDL_PRIV + 1;
 const static int32_t NBR_OF_PRIVS = NBR_DML_PRIVS+NBR_DDL_PRIVS;

 // Defines the privileges and grantable bitmaps as PrivMgrBitmap
 //using PrivMgrBitmap = std::bitset<NBR_OF_PRIVS>;
 #define PrivMgrBitmap std::bitset<NBR_OF_PRIVS>
 typedef std::bitset<NBR_OF_PRIVS> PrivObjectBitmap;
 typedef std::bitset<NBR_OF_PRIVS> PrivColumnBitmap;
 typedef std::bitset<NBR_OF_PRIVS> PrivSchemaBitmap;
 typedef std::map<size_t,PrivColumnBitmap> PrivColList;
 typedef std::map<size_t,std::bitset<NBR_OF_PRIVS> >::const_iterator PrivColIterator;

 inline bool isDMLPrivType(PrivType privType)
 {

    if ((privType >= FIRST_DML_PRIV && privType <= LAST_DML_PRIV) ||
        privType == ALL_DML)
       return true;

    return false;

 }


 // object types for grantable objects
 #define BASE_TABLE_OBJECT_LIT               "BT"
 #define LIBRARY_OBJECT_LIT                  "LB"
 #define VIEW_OBJECT_LIT                     "VI"
 #define USER_DEFINED_ROUTINE_OBJECT_LIT     "UR"
 #define SEQUENCE_GENERATOR_OBJECT_LIT       "SG"

 #define UNKNOWN_GRANTOR_TYPE_LIT               "  "
 #define SYSTEM_GRANTOR_LIT                     "S "
 #define USER_GRANTOR_LIT                       "U "

 #define UNKNOWN_GRANTEE_TYPE_LIT               "  "
 #define PUBLIC_GRANTEE_LIT                     "P "
 #define USER_GRANTEE_LIT                       "U "

 #define MAX_SQL_IDENTIFIER_NAME_LEN 256

 #endif
	//*****************************************************************************
	// @@@ START COPYRIGHT @@@
	//
	// Licensed to the Apache Software Foundation (ASF) under one
	// or more contributor license agreements. See the NOTICE file
	// distributed with this work for additional information
	// regarding copyright ownership. The ASF licenses this file
	// to you under the Apache License, Version 2.0 (the
	// "License"); you may not use this file except in compliance
	// with the License. You may obtain a copy of the License at
	//
	// http://www.apache.org/licenses/LICENSE-2.0
	//
	// Unless required by applicable law or agreed to in writing,
	// software distributed under the License is distributed on an
	// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	// KIND, either express or implied. See the License for the
	// specific language governing permissions and limitations
	// under the License.
	//
	//// @@@ END COPYRIGHT @@@
	//*****************************************************************************

	#ifndef PRIVMGR_DEFS_H
	#define PRIVMGR_DEFS_H

	#include <bitset>
	#include <map>
	#include <iterator>
	#include "NAUserId.h"
	#include "ComSmallDefs.h"

	// *****************************************************************************
	// *
	// * File: PrivMgrDef.h
	// * Description: This file contains common definitions used by the
	// * privilege manager component
	// *
	// *****************************************************************************

	// Returns the result of the operation
	enum PrivStatus { STATUS_UNKNOWN = 20,
	STATUS_GOOD = 21,
	STATUS_WARNING = 22,
	STATUS_NOTFOUND = 23,
	STATUS_ERROR = 24
	};

	inline const char * privStatusEnumToLit(PrivStatus privStatus)
	{
	std::string result;
	switch (privStatus)
	{
	case STATUS_GOOD:
	result = "GOOD";
	break;
	case STATUS_WARNING:
	result = "WARNING";
	break;
	case STATUS_NOTFOUND:
	result = "NOTFOUND";
	break;
	case STATUS_ERROR:
	result = "ERROR";
	break;
	default:
	result = "UNKNOWN";
	}
	return result.c_str();
	}


	enum {SQL_OPERATIONS_COMPONENT_UID = 1};
	#define SQL_OPERATION_NAME "SQL_OPERATIONS"

	#define PRIVMGR_INTERNAL_ERROR(text) \
	*pDiags_ << DgSqlCode(-CAT_INTERNAL_EXCEPTION_ERROR) \
	<< DgString0(__FILE__) \
	<< DgInt0(__LINE__) \
	<< DgString1(text)


	enum class PrivClass {
	ALL = 2,
	OBJECT = 3,
	COMPONENT = 4,
	SCHEMA = 5
	};

	// Defines the list of supported privileges
	// and their order in the privilege and grantable bitmaps
	// stored in the OBJECT_PRIVILEGES table
	enum PrivType { SELECT_PRIV = 0, //DML PRIVS START HERE
	INSERT_PRIV,
	DELETE_PRIV,
	UPDATE_PRIV,
	USAGE_PRIV,
	REFERENCES_PRIV,
	EXECUTE_PRIV,
	CREATE_PRIV, //DDL PRIVS START HERE
	ALTER_PRIV,
	DROP_PRIV,
	ALL_DML,
	ALL_DDL,
	ALL_PRIVS };

	class ColPrivSpec
	{
	public:
	PrivType privType;
	int32_t columnOrdinal;
	bool grantorHasWGO;
	};

	inline bool isColumnPrivType(PrivType privType)
	{

	return (privType == PrivType::SELECT_PRIV \|\|
	privType == PrivType::INSERT_PRIV \|\|
	privType == PrivType::REFERENCES_PRIV \|\|
	privType == PrivType::UPDATE_PRIV);

	}

	inline bool isLibraryPrivType(PrivType privType)
	{

	return (privType == PrivType::USAGE_PRIV \|\|
	privType == PrivType::UPDATE_PRIV);

	}

	inline bool isTablePrivType(PrivType privType)
	{

	return (privType == PrivType::SELECT_PRIV \|\|
	privType == PrivType::INSERT_PRIV \|\|
	privType == PrivType::DELETE_PRIV \|\|
	privType == PrivType::REFERENCES_PRIV \|\|
	privType == PrivType::UPDATE_PRIV);

	}

	inline bool isUDRPrivType(PrivType privType)
	{

	return (privType == PrivType::EXECUTE_PRIV);

	}

	inline bool isSequenceGeneratorPrivType(PrivType privType)
	{

	return (privType == PrivType::USAGE_PRIV);

	}

	// Defines the list of privileges that are supported for the
	// SQLOperation component
	enum class SQLOperation {
	ALTER = 2,
	ALTER_LIBRARY,
	ALTER_ROUTINE,
	ALTER_ROUTINE_ACTION,
	ALTER_SCHEMA,
	ALTER_SEQUENCE,
	ALTER_SYNONYM,
	ALTER_TABLE,
	ALTER_TRIGGER,
	ALTER_VIEW,
	CREATE,
	CREATE_CATALOG,
	CREATE_INDEX,
	CREATE_LIBRARY,
	CREATE_PROCEDURE,
	CREATE_ROUTINE,
	CREATE_ROUTINE_ACTION,
	CREATE_SCHEMA,
	CREATE_SEQUENCE,
	CREATE_SYNONYM,
	CREATE_TABLE,
	CREATE_TRIGGER,
	CREATE_VIEW,
	DML_DELETE,
	DML_EXECUTE,
	DML_INSERT,
	DML_REFERENCES,
	DML_SELECT,
	DML_UPDATE,
	DML_USAGE,
	DROP,
	DROP_CATALOG,
	DROP_INDEX,
	DROP_LIBRARY,
	DROP_PROCEDURE,
	DROP_ROUTINE,
	DROP_ROUTINE_ACTION,
	DROP_SCHEMA,
	DROP_SEQUENCE,
	DROP_SYNONYM,
	DROP_TABLE,
	DROP_TRIGGER,
	DROP_VIEW,
	MANAGE,
	MANAGE_COMPONENTS,
	MANAGE_LIBRARY,
	MANAGE_LOAD,
	MANAGE_PRIVILEGES,
	MANAGE_ROLES,
	MANAGE_STATISTICS,
	MANAGE_USERS,
	QUERY_ACTIVATE,
	QUERY_CANCEL,
	QUERY_SUSPEND,
	REMAP_USER,
	REGISTER_HIVE_OBJECT,
	SHOW,
	UNREGISTER_HIVE_OBJECT,
	USE_ALTERNATE_SCHEMA,
	COMMENT,
	FIRST_OPERATION = ALTER,
	LAST_OPERATION = COMMENT,
	NUMBER_OF_OPERATIONS = LAST_OPERATION - FIRST_OPERATION + 1,
	UNKNOWN,
	FIRST_DML_PRIV = DML_DELETE,
	LAST_DML_PRIV = DML_USAGE
	};

	enum class PrivDropBehavior {
	CASCADE = 2,
	RESTRICT = 3
	};

	enum class PrivLevel {
	UNKNOWN = 0,
	GLOBAL = 2,
	CATALOG = 3,
	SCHEMA = 4,
	OBJECT = 5,
	COLUMN = 6
	};

	// NOTE: These values need to match the corresponding values in
	// common/ComSmallDefs.h, ComIdClass.
	enum class PrivAuthClass {
	UNKNOWN = 0,
	ROLE = 1,
	USER = 2
	};

	const static int32_t FIRST_DML_PRIV = SELECT_PRIV;
	const static int32_t FIRST_DML_COL_PRIV = SELECT_PRIV;
	const static int32_t FIRST_PRIV = SELECT_PRIV;
	const static int32_t LAST_PRIMARY_DML_PRIV = UPDATE_PRIV;
	const static int32_t LAST_DML_PRIV = EXECUTE_PRIV;
	const static int32_t LAST_DML_COL_PRIV = REFERENCES_PRIV;
	const static int32_t FIRST_DDL_PRIV = CREATE_PRIV;
	const static int32_t LAST_DDL_PRIV = DROP_PRIV;
	const static int32_t LAST_PRIV = DROP_PRIV;

	const static int32_t NBR_DML_PRIVS = LAST_DML_PRIV-FIRST_DML_PRIV + 1;
	// This calculation includes non-column-level privileges. There are only four
	// column-level privileges, but DELETE and USAGE are include so bit indexing works.
	const static int32_t NBR_DML_COL_PRIVS = LAST_DML_COL_PRIV - FIRST_DML_COL_PRIV + 1;
	const static int32_t NBR_DDL_PRIVS = LAST_DDL_PRIV-FIRST_DDL_PRIV + 1;
	const static int32_t NBR_OF_PRIVS = NBR_DML_PRIVS+NBR_DDL_PRIVS;

	// Defines the privileges and grantable bitmaps as PrivMgrBitmap
	//using PrivMgrBitmap = std::bitset<NBR_OF_PRIVS>;
	#define PrivMgrBitmap std::bitset<NBR_OF_PRIVS>
	typedef std::bitset<NBR_OF_PRIVS> PrivObjectBitmap;
	typedef std::bitset<NBR_OF_PRIVS> PrivColumnBitmap;
	typedef std::bitset<NBR_OF_PRIVS> PrivSchemaBitmap;
	typedef std::map<size_t,PrivColumnBitmap> PrivColList;
	typedef std::map<size_t,std::bitset<NBR_OF_PRIVS> >::const_iterator PrivColIterator;

	inline bool isDMLPrivType(PrivType privType)
	{

	if ((privType >= FIRST_DML_PRIV && privType <= LAST_DML_PRIV) \|\|
	privType == ALL_DML)
	return true;

	return false;

	}



	// object types for grantable objects
	#define BASE_TABLE_OBJECT_LIT "BT"
	#define LIBRARY_OBJECT_LIT "LB"
	#define VIEW_OBJECT_LIT "VI"
	#define USER_DEFINED_ROUTINE_OBJECT_LIT "UR"
	#define SEQUENCE_GENERATOR_OBJECT_LIT "SG"

	#define UNKNOWN_GRANTOR_TYPE_LIT " "
	#define SYSTEM_GRANTOR_LIT "S "
	#define USER_GRANTOR_LIT "U "

	#define UNKNOWN_GRANTEE_TYPE_LIT " "
	#define PUBLIC_GRANTEE_LIT "P "
	#define USER_GRANTEE_LIT "U "

	#define MAX_SQL_IDENTIFIER_NAME_LEN 256

	#endif