/* * Copyright (C) 2008 Search Solution Corporation. All rights reserved by Search Solution. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; version 2 of the License. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * */ /* * authenticate.h - Authorization manager * */ #ifndef _AUTHENTICATE_H_ #define _AUTHENTICATE_H_ #ident "$Id$" #include #include #include "error_manager.h" #include "dbdef.h" #include "class_object.h" /* * Authorization Class Names */ extern const char *AU_ROOT_CLASS_NAME; extern const char *AU_OLD_ROOT_CLASS_NAME; extern const char *AU_USER_CLASS_NAME; extern const char *AU_PASSWORD_CLASS_NAME; extern const char *AU_AUTH_CLASS_NAME; extern const char *AU_GRANT_CLASS_NAME; extern const char *AU_PUBLIC_USER_NAME; extern const char *AU_DBA_USER_NAME; /* * Authorization Types */ /* obsolete, should be using the definition from dbdef.h */ #define AU_TYPE DB_AUTH #define AU_NONE DB_AUTH_NONE #define AU_SELECT DB_AUTH_SELECT #define AU_INSERT DB_AUTH_INSERT #define AU_UPDATE DB_AUTH_UPDATE #define AU_DELETE DB_AUTH_DELETE #define AU_ALTER DB_AUTH_ALTER #define AU_INDEX DB_AUTH_INDEX #define AU_EXECUTE DB_AUTH_EXECUTE /* * Mask to extract only the authorization bits from a cache. This can also * be used as an absolute value to see if all possible authorizations have * been given * TODO : LP64 */ #define AU_TYPE_MASK 0x7F #define AU_GRANT_MASK 0x7F00 #define AU_FULL_AUTHORIZATION 0x7F7F #define AU_NO_AUTHORIZATION 0 /* * the grant option for any particular authorization type is cached in the * same integer, shifted up eight bits. */ #define AU_GRANT_SHIFT 8 /* Invalid cache is identified when the high bit is on. */ #define AU_CACHE_INVALID 0x80000000 #define AU_DISABLE(save) \ do \ { \ save = Au_disable; \ Au_disable = 1; \ } \ while (0) #define AU_ENABLE(save) \ do \ { \ Au_disable = save; \ } \ while (0) #define AU_SAVE_AND_ENABLE(save) \ do \ { \ save = Au_disable; \ Au_disable = 0; \ } \ while (0) #define AU_SAVE_AND_DISABLE(save) \ do \ { \ save = Au_disable; \ Au_disable = 1; \ } \ while (0) #define AU_RESTORE(save) \ do \ { \ Au_disable = save; \ } \ while (0) #define AU_DISABLE_PASSWORDS au_disable_passwords #define AU_SET_USER au_set_user #define AU_MAX_PASSWORD_CHARS 8 #define AU_MAX_PASSWORD_BUF 128 typedef enum au_fetchmode { AU_FETCH_READ, AU_FETCH_WRITE, AU_FETCH_UPDATE } AU_FETCHMODE; /* * Global Variables */ extern MOP Au_root; extern MOP Au_user; extern MOP Au_dba_user; extern MOP Au_public_user; extern bool Au_remember_first_user; extern char Au_user_password[AU_MAX_PASSWORD_BUF + 4]; extern int Au_disable; extern void au_init (void); extern void au_final (void); extern int au_install (void); extern int au_force_write_new_auth (void); extern int au_add_method_check_authorization (void); extern int au_start (void); extern int au_login (const char *name, const char *password); extern void au_disable_passwords (void); extern int au_set_user (MOP newuser); /* user/group hierarchy maintenance */ extern MOP au_find_user (const char *user_name); extern MOP au_add_user (const char *name, int *exists); extern int au_add_member (MOP group, MOP member); extern int au_drop_member (MOP group, MOP member); extern int au_drop_user (MOP user); extern int au_set_password (MOP user, const char *password); extern const char *au_user_name (void); extern int au_user_password (char *buffer); /* grant/revoke */ extern int au_grant (MOP user, MOP class_mop, DB_AUTH type, bool grant_option); extern int au_revoke (MOP user, MOP class_mop, DB_AUTH type); /* class & instance accessors */ extern int au_fetch_class (MOP op, SM_CLASS ** class_ptr, AU_FETCHMODE fetchmode, DB_AUTH type); extern int au_fetch_class_force (MOP op, SM_CLASS ** class_, AU_FETCHMODE fetchmode); extern int au_fetch_instance (MOP op, MOBJ * obj_ptr, AU_FETCHMODE mode, DB_AUTH type); extern int au_fetch_instance_force (MOP op, MOBJ * obj_ptr, AU_FETCHMODE fetchmode); extern int au_check_authorization (MOP op, DB_AUTH auth); /* class cache support */ extern void au_free_authorization_cache (void *cache); extern void au_reset_authorization_caches (void); /* misc utilities */ extern int au_change_owner (MOP classmop, MOP owner); extern MOP au_get_class_owner (MOP classmop); extern int au_check_user (void); extern char *au_get_user_name (MOP obj); extern bool au_is_dba_group_member (MOP user); /* debugging functions */ extern void au_dump (void); extern void au_dump_to_file (FILE * fp); extern void au_dump_user (MOP user, FILE * fp); /* used by test code, should be changed to au_dump . . . */ extern void au_print_class_auth (MOP class_mop); /* called only at initialization time to get the static methods linked */ extern void au_link_static_methods (void); /* migration utilities */ extern int au_export_users (FILE * outfp); extern int au_export_grants (FILE * outfp, MOP class_mop, bool quoted_id_flag); extern int au_get_class_privilege (DB_OBJECT * mop, unsigned int *auth); /* * Etc */ extern void au_find_user_method (MOP class_mop, DB_VALUE * returnval, DB_VALUE * name); extern void au_add_user_method (MOP class_mop, DB_VALUE * returnval, DB_VALUE * name, DB_VALUE * password); extern void au_set_password_method (MOP user, DB_VALUE * returnval, DB_VALUE * password); extern void au_set_password_encoded_method (MOP user, DB_VALUE * returnval, DB_VALUE * password); extern void au_add_member_method (MOP user, DB_VALUE * returnval, DB_VALUE * memval); extern void au_drop_member_method (MOP user, DB_VALUE * returnval, DB_VALUE * memval); extern void au_drop_user_method (MOP root, DB_VALUE * returnval, DB_VALUE * name); extern void au_change_owner_method (MOP obj, DB_VALUE * returnval, DB_VALUE * class_, DB_VALUE * owner); extern int au_change_trigger_owner (MOP trigger, MOP owner); extern void au_change_trigger_owner_method (MOP obj, DB_VALUE * returnval, DB_VALUE * trigger, DB_VALUE * owner); extern void au_get_owner_method (MOP obj, DB_VALUE * returnval, DB_VALUE * class_); extern void au_check_authorization_method (MOP obj, DB_VALUE * returnval, DB_VALUE * class_, DB_VALUE * auth); extern int au_change_sp_owner (MOP sp, MOP owner); extern void au_change_sp_owner_method (MOP obj, DB_VALUE * returnval, DB_VALUE * sp, DB_VALUE * owner); extern void au_login_method (MOP class_mop, DB_VALUE * returnval, DB_VALUE * user, DB_VALUE * password); extern void au_dump_auth (FILE * fp); extern void au_describe_user_method (MOP user, DB_VALUE * returnval); extern void au_info_method (MOP class_mop, DB_VALUE * returnval, DB_VALUE * info); extern void au_describe_root_method (MOP class_mop, DB_VALUE * returnval, DB_VALUE * info); #endif /* _AUTHENTICATE_H_ */