|
| 1 | +Choobs MySQL Grants Toolkit |
| 2 | +=========================== |
| 3 | + |
| 4 | +MySQL's [GRANT syntax](http://dev.mysql.com/doc/refman/5.0/en/grant.html "MySQL 5.0 Reference Manual") uses the WITH GRANT OPTION which lets you GRANT a permission to a user and then allows the user to GRANT that permission further. However a limitation of MySQL is that the option is automatically valid for **all** permissions you granted the user, not just the one that you specified with the WITH GRANT OPTION. |
| 5 | + |
| 6 | +This means that the moment you use the WITH GRANT OPTION the user automatically can give his permissions and the power to GRANT to another user. In effect with the help of another user the current user can gain all the permissions of the other user. |
| 7 | + |
| 8 | +This toolkit restricts the GRANT OPTION by adding a layer of checking which means you can only apply grants for a specific set of permissions (wether you have them or not). |
| 9 | + |
| 10 | +You can therefore limit the propagation of permissions between users to a well defined set of permissions and databases/tables. |
| 11 | + |
| 12 | +##Documentation |
| 13 | + |
| 14 | +MySQL stores table privileges in mysql.tables_priv and column privileges in mysql.columns_priv internally. However, since GRANT statement has the aforementioned issue, we avoid giving actual GRANT permissions to the users. |
| 15 | +Instead, we give EXECUTE privilege to custom procedures which do what the GRANT/REVOKE statements do after checking if the user is allowed to grant the privilege. The list of privileges the user is allowed to grant is stored in a custom table. The users don't actually have the GRANT privilege, so they can't bypass the security using GRANT statement. |
| 16 | + |
| 17 | +#### Compatibility |
| 18 | +Limited testing was done on MySQL and MariaDB. In principle any MySQL compatible database server version 5.0 and later should work. Please let us know if you have any issues with your database. |
| 19 | + |
| 20 | +#### Setup |
| 21 | +Use the install-mysqlgt-5.0.sql for MySQL version >=5.0 and <5.5 and install-mysqlgt-5.5.sql for MySQL version >=5.5. The script must be run as root. |
| 22 | + |
| 23 | +After you run it, a new schema mysqlgt is created with tables mysqlgt.db_grant and mysqlgt.log and new procedures mysqlgt.gtSIMPLIFY_DATA, mysqlgt.gtGRANT and mysqlgt.gtREVOKE are created. |
| 24 | + |
| 25 | +To allow a user (say test_user) to grant only the specified privileges: |
| 26 | + |
| 27 | + * give EXECUTE permissions to the user to execute mysqlgt.gtGRANT and mysqlgt.gtREVOKE |
| 28 | + * insert a row in mysqlgt.db_grant specifying what table privileges a user is allowed to grant |
| 29 | + |
| 30 | +##### Example: |
| 31 | + |
| 32 | +In the following example, a user test_user@localhost is allowed to grant SELECT, UPDATE, INSERT and DELETE privileges on database test_db: |
| 33 | + |
| 34 | +```sql |
| 35 | +-- Allow EXECUTE for 'test_user'@'localhost' on mysqlgt procedures |
| 36 | +GRANT EXECUTE ON PROCEDURE `mysqlgt`.`gtREVOKE` TO 'test_user'@'localhost'; |
| 37 | +GRANT EXECUTE ON PROCEDURE `mysqlgt`.`gtGRANT` TO 'test_user'@'localhost'; |
| 38 | + |
| 39 | +-- Allow the user to reload privileges after updating grants |
| 40 | +-- make sure you are comfortable giving this permission to the user |
| 41 | +-- allows reloading of logs, replication sync and a few other reloads |
| 42 | +GRANT RELOAD ON *.* TO 'test_user'@'localhost'; |
| 43 | + |
| 44 | +REPLACE INTO `mysqlgt`.`db_grant` (`Host`, `Db`, `User`, `Table_priv`) VALUES |
| 45 | +-- Allow SELECT,INSERT,UPDATE,DELETE GRANT for test@% on schema test |
| 46 | + ('%', 'test_db', 'test_user', 'select,insert,update,delete') |
| 47 | +``` |
| 48 | + |
| 49 | +Please note that in mysqlgt.db_grant, Host is set to '%'. Please check the [Known Issues](#known-issues) section for more information about why this is done here. |
| 50 | + |
| 51 | +#### Usage |
| 52 | +Now, the user (test_user) will be allowed to grant/revoke privileges to/from other users in the following ways: |
| 53 | + |
| 54 | +```sql |
| 55 | +CALL mysqlgt.gtGRANT ( PERMISSIONS, DB.TABLE[.COLUMN], USER@HOST ) |
| 56 | +CALL mysqlgt.gtREVOKE ( PERMISSIONS, DB.TABLE[.COLUMN], USER@HOST ) |
| 57 | +``` |
| 58 | + |
| 59 | +##### Examples: |
| 60 | +###### Table privileges: |
| 61 | + |
| 62 | +```sql |
| 63 | +CALL mysqlgt.gtGRANT ( 'Delete,Insert,Update', 'mydb.mytable', 'myuser@hostname' ); |
| 64 | +CALL mysqlgt.gtREVOKE ( 'Update,Delete', 'mydb.mytable', 'myuser@hostname' ); |
| 65 | +``` |
| 66 | + |
| 67 | +###### Column privileges: |
| 68 | + |
| 69 | +```sql |
| 70 | +CALL mysqlgt.gtGRANT ( 'Select,Insert,Update', 'mydb.mytable.mycol', 'myuser@hostname' ); |
| 71 | +CALL mysqlgt.gtREVOKE ( 'Select,Insert', 'mydb.mytable.mycol', 'myuser@hostname' ); |
| 72 | +``` |
| 73 | + |
| 74 | +##### Notes: |
| 75 | + |
| 76 | +Please note that mysqlgt.gtGRANT and mysqlgt.gtREVOKE will not always replace single GRANT/REVOKE statement with a single call. Consider the following MySQL GRANT Statement: |
| 77 | +```sql |
| 78 | +GRANT SELECT (mycol1), INSERT (mycol1,mycol2), DELETE ON mydb.mytbl TO 'myuser'@'hostname'; |
| 79 | +``` |
| 80 | + |
| 81 | +Equavalent mysqlgt calls to acheive the above will be: |
| 82 | +```sql |
| 83 | +CALL mysqlgt.gtGRANT ( 'Select,Insert', 'mydb.mytable.mycol1', 'myuser@hostname' ); |
| 84 | +CALL mysqlgt.gtGRANT ( 'Insert', 'mydb.mytable.mycol2', 'myuser@hostname' ); |
| 85 | +CALL mysqlgt.gtGRANT ( 'Delete', 'mydb.mytable', 'myuser@hostname' ); |
| 86 | +``` |
| 87 | + |
| 88 | +Also, note that it currently only supports table and column privileges, it doesn't support database privileges. So, there is no equivalent for the following statement: |
| 89 | +```sql |
| 90 | +GRANT SELECT ON mydb.* TO 'myuser'@'hostname'; |
| 91 | +``` |
| 92 | +This feature is planned for future release. |
| 93 | + |
| 94 | +#### Known Issues |
| 95 | +Because using the function `CURRENT_USER()` returns the DEFINER inside of our PROCEDURE instead of the calling user. We were forced to use `USER()` which returns the connected user. However this introduces the following issue. |
| 96 | + |
| 97 | +In the row in mysqlgt.db_grant, Host must be set to whatever the user connects with, not what is in the user db. If name resolve is enabled and you are in an intranet, it is possible that the server will get the hostname (instead of the IP) eg. user@my-pc-hostname instead of [email protected] |
| 98 | + |
| 99 | +This can be an issue for configuration. The following approaches can be used to workaround this limitation: |
| 100 | + |
| 101 | + * disable dns resolve on the MySQL server (add skip-name-resolve under [mysqld] in my.ini) and use static IPs for your users |
| 102 | + * use the exact hostname of your user |
| 103 | + * use % to match anything, the user will already be authenticated by MySQL according to its HOST rules |
| 104 | + |
| 105 | +#### Contributing To Choobs MySQL Grants Toolkit |
| 106 | + |
| 107 | +Since this is hosted on github: |
| 108 | + |
| 109 | +**All issues and pull requests should be filed on the [choobs/mysqlgt](http://github.com/choobs/mysqlgt) repository.** |
| 110 | + |
| 111 | +Thank you. |
| 112 | + |
| 113 | +## Authors |
| 114 | + |
| 115 | + * Erik DeLamarter ( [email protected]) |
| 116 | + * Pravin Dahal |
| 117 | + |
| 118 | +## License |
| 119 | + |
| 120 | +The Choobs MySQL Grants Toolkit is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT) |
0 commit comments