Repository: sqoop Updated Branches: refs/heads/sqoop2 99223379b -> 1bd26e7f3
SQOOP-2876: Sqoop2: Document TLS support (Abraham Fine via Jarek Jarcec Cecho) Project: http://git-wip-us.apache.org/repos/asf/sqoop/repo Commit: http://git-wip-us.apache.org/repos/asf/sqoop/commit/1bd26e7f Tree: http://git-wip-us.apache.org/repos/asf/sqoop/tree/1bd26e7f Diff: http://git-wip-us.apache.org/repos/asf/sqoop/diff/1bd26e7f Branch: refs/heads/sqoop2 Commit: 1bd26e7f311d45ac9d59f3e134e1fa148f54d2e7 Parents: 9922337 Author: Jarek Jarcec Cecho <[email protected]> Authored: Tue Mar 8 14:03:31 2016 -0800 Committer: Jarek Jarcec Cecho <[email protected]> Committed: Tue Mar 8 14:03:31 2016 -0800 ---------------------------------------------------------------------- .../security/AuthenticationAndAuthorization.rst | 239 +++++++++++++++++++ docs/src/site/sphinx/security/Encryption.rst | 102 ++++++++ .../sphinx/security/SecurityGuideOnSqoop2.rst | 239 ------------------- 3 files changed, 341 insertions(+), 239 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/sqoop/blob/1bd26e7f/docs/src/site/sphinx/security/AuthenticationAndAuthorization.rst ---------------------------------------------------------------------- diff --git a/docs/src/site/sphinx/security/AuthenticationAndAuthorization.rst b/docs/src/site/sphinx/security/AuthenticationAndAuthorization.rst new file mode 100644 index 0000000..7ff6c7d --- /dev/null +++ b/docs/src/site/sphinx/security/AuthenticationAndAuthorization.rst @@ -0,0 +1,239 @@ +.. 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. + + +================================ +Authentication and Authorization +================================ + +Most Hadoop components, such as HDFS, Yarn, Hive, etc., have security frameworks, which support Simple, Kerberos and LDAP authentication. currently Sqoop 2 provides 2 types of authentication: simple and kerberos. The authentication module is pluggable, so more authentication types can be added. Additionally, a new role based access control is introduced in Sqoop 1.99.6. We recommend to use this capability in multi tenant environments, so that malicious users canât easily abuse your created link and job objects. + +Simple Authentication +===================== + +Configuration +------------- +Modify Sqoop configuration file, normally in <Sqoop Folder>/conf/sqoop.properties. + +:: + + org.apache.sqoop.authentication.type=SIMPLE + org.apache.sqoop.authentication.handler=org.apache.sqoop.security.authentication.SimpleAuthenticationHandler + org.apache.sqoop.anonymous=true + +- Simple authentication is used by default. Commenting out authentication configuration will yield the use of simple authentication. + +Run command +----------- +Start Sqoop server as usual. + +:: + + <Sqoop Folder>/bin/sqoop.sh server start + +Start Sqoop client as usual. + +:: + + <Sqoop Folder>/bin/sqoop.sh client + +Kerberos Authentication +======================= + +Kerberos is a computer network authentication protocol which works on the basis of 'tickets' to allow nodes communicating over a non-secure network to prove their identity to one another in a secure manner. Its designers aimed it primarily at a clientâserver model and it provides mutual authenticationâboth the user and the server verify each other's identity. Kerberos protocol messages are protected against eavesdropping and replay attacks. + +Dependency +---------- +Set up a KDC server. Skip this step if KDC server exists. It's difficult to cover every way Kerberos can be setup (ie: there are cross realm setups and multi-trust environments). This section will describe how to setup the sqoop principals with a local deployment of MIT kerberos. + +- All components which are Kerberos authenticated need one KDC server. If current Hadoop cluster uses Kerberos authentication, there should be a KDC server. +- If there is no KDC server, follow http://web.mit.edu/kerberos/krb5-devel/doc/admin/install_kdc.html to set up one. + +Configure Hadoop cluster to use Kerberos authentication. + +- Authentication type should be cluster level. All components must have the same authentication type: use Kerberos or not. In other words, Sqoop with Kerberos authentication could not communicate with other Hadoop components, such as HDFS, Yarn, Hive, etc., without Kerberos authentication, and vice versa. +- How to set up a Hadoop cluster with Kerberos authentication is out of the scope of this document. Follow the related links like https://hadoop.apache.org/docs/r2.5.0/hadoop-project-dist/hadoop-common/SecureMode.html + +Create keytab and principal for Sqoop 2 via kadmin in command line. + +:: + + addprinc -randkey HTTP/<FQDN>@<REALM> + addprinc -randkey sqoop/<FQDN>@<REALM> + xst -k /home/kerberos/sqoop.keytab HTTP/<FQDN>@<REALM> + xst -k /home/kerberos/sqoop.keytab sqoop/<FQDN>@<REALM> + +- The <FQDN> should be replaced by the FQDN of the server, which could be found via âhostname -fâ in command line. +- The <REALM> should be replaced by the realm name in krb5.conf file generated when installing the KDC server in the former step. +- The principal HTTP/<FQDN>@<REALM> is used in communication between Sqoop client and Sqoop server. Since Sqoop server is an http server, so the HTTP principal is a must during SPNEGO process, and it is case sensitive. +- Http request could be sent from other client like browser, wget or curl with SPNEGO support. +- The principal sqoop/<FQDN>@<REALM> is used in communication between Sqoop server and Hdfs/Yarn as the credential of Sqoop server. + +Configuration +------------- +Modify Sqoop configuration file, normally in <Sqoop Folder>/conf/sqoop.properties. + +:: + + org.apache.sqoop.authentication.type=KERBEROS + org.apache.sqoop.authentication.handler=org.apache.sqoop.security.authentication.KerberosAuthenticationHandler + org.apache.sqoop.authentication.kerberos.principal=sqoop/_HOST@<REALM> + org.apache.sqoop.authentication.kerberos.keytab=/home/kerberos/sqoop.keytab + org.apache.sqoop.authentication.kerberos.http.principal=HTTP/_HOST@<REALM> + org.apache.sqoop.authentication.kerberos.http.keytab=/home/kerberos/sqoop.keytab + org.apache.sqoop.authentication.kerberos.proxyuser=true + +- When _HOST is used as FQDN in principal, it will be replaced by the real FQDN. https://issues.apache.org/jira/browse/HADOOP-6632 +- If parameter proxyuser is set true, Sqoop server will use proxy user mode (sqoop delegate real client user) to run Yarn job. If false, Sqoop server will use sqoop user to run Yarn job. + +Run command +----------- +Set SQOOP2_HOST to FQDN. + +:: + + export SQOOP2_HOST=$(hostname -f). + +- The <FQDN> should be replaced by the FQDN of the server, which could be found via âhostname -fâ in command line. + +Start Sqoop server using sqoop user. + +:: + + sudo âu sqoop <Sqoop Folder>/bin/sqoop.sh server start + +Run kinit to generate ticket cache. + +:: + + kinit HTTP/<FQDN>@<REALM> -kt /home/kerberos/sqoop.keytab + +Start Sqoop client. + +:: + + <Sqoop Folder>/bin/sqoop.sh client + +Verify +------ +If the Sqoop server has started successfully with Kerberos authentication, the following line will be in <@LOGDIR>/sqoop.log: + +:: + + 2014-12-04 15:02:58,038 INFO security.KerberosAuthenticationHandler [org.apache.sqoop.security.authentication.KerberosAuthenticationHandler.secureLogin(KerberosAuthenticationHandler.java:84)] Using Kerberos authentication, principal [sqoop/[email protected]] keytab [/home/kerberos/sqoop.keytab] + +If the Sqoop client was able to communicate with the Sqoop server, the following will be in <@LOGDIR>/sqoop.log : + +:: + + Refreshing Kerberos configuration + Acquire TGT from Cache + Principal is HTTP/<FQDN>@HADOOP.COM + null credentials from Ticket Cache + principal is HTTP/<FQDN>@HADOOP.COM + Will use keytab + Commit Succeeded + +Customized Authentication +========================= + +Users can create their own authentication modules. By performing the following steps: + +- Create customized authentication handler extends abstract class AuthenticationHandler. +- Implement abstract function doInitialize and secureLogin in AuthenticationHandler. + +:: + + public class MyAuthenticationHandler extends AuthenticationHandler { + + private static final Logger LOG = Logger.getLogger(MyAuthenticationHandler.class); + + public void doInitialize() { + securityEnabled = true; + } + + public void secureLogin() { + LOG.info("Using customized authentication."); + } + } + +- Modify configuration org.apache.sqoop.authentication.handler in <Sqoop Folder>/conf/sqoop.properties and set it to the customized authentication handler class name. +- Restart the Sqoop server. + +Authorization +============= + +Users, Groups, and Roles +------------------------ + +At the core of Sqoop's authorization system are users, groups, and roles. Roles allow administrators to give a name to a set of grants which can be easily reused. A role may be assigned to users, groups, and other roles. For example, consider a system with the following users and groups. + +:: + + <User>: <Groups> + user_all: group1, group2 + user1: group1 + user2: group2 + +Sqoop roles must be created manually before being used, unlike users and groups. Users and groups are managed by the login system (Linux, LDAP or Kerberos). When a user wants to access one resource (connector, link, connector), the Sqoop2 server will determine the username of this user and the groups associated. That information is then used to determine if the user should have access to this resource being requested, by comparing the required privileges of the Sqoop operation to the user privileges using the following rules. + +- User privileges (Has the privilege been granted to the user?) +- Group privileges (Does the user belong to any groups that the privilege has been granted to?) +- Role privileges (Does the user or any of the groups that the user belongs to have a role that grants the privilege?) + +Administrator +------------- + +There is a special user: administrator, which canât be created, deleted by command. The only way to set administrator is to modify the configuration file. Administrator could run management commands to create/delete roles. However, administrator does not implicitly have all privileges. Administrator has to grant privilege to him/her if he/she needs to request the resource. + +Role management commands +------------------------ + +:: + + CREATE ROLE ârole role_name + DROP ROLE ârole role_name + SHOW ROLE + +- Only the administrator has privilege for this. + +Principal management commands +----------------------------- + +:: + + GRANT ROLE --principal-type principal_type --principal principal_name --role role_name + REVOKE ROLE --principal-type principal_type --principal principal_name --role role_name + SHOW ROLE --principal-type principal_type --principal principal_name + SHOW PRINCIPAL --role role_name + +- principal_type: USER | GROUP | ROLE + +Privilege management commands +----------------------------- + +:: + + GRANT PRIVILEGE --principal-type principal_type --principal principal_name --resource-type resource_type --resource resource_name --action action_name [--with-grant] + REVOKE PRIVILEGE --principal-type principal_type --principal principal_name [--resource-type resource_type --resource resource_name --action action_name] [--with-grant] + SHOW PRIVILEGE âprincipal-type principal_type âprincipal principal_name [--resource-type resource_type --resource resource_name --action action_name] + +- principal_type: USER | GROUP | ROLE +- resource_type: CONNECTOR | LINK | JOB +- action_type: ALL | READ | WRITE +- With with-grant in GRANT PRIVILEGE command, this principal could grant his/her privilege to other users. +- Without resource in REVOKE PRIVILEGE command, all privileges on this principal will be revoked. +- With with-grant in REVOKE PRIVILEGE command, only grant privilege on this principal will be removed. This principal has the privilege to access this resource, but he/she could not grant his/her privilege to others. +- Without resource in SHOW PRIVILEGE command, all privileges on this principal will be listed. http://git-wip-us.apache.org/repos/asf/sqoop/blob/1bd26e7f/docs/src/site/sphinx/security/Encryption.rst ---------------------------------------------------------------------- diff --git a/docs/src/site/sphinx/security/Encryption.rst b/docs/src/site/sphinx/security/Encryption.rst new file mode 100644 index 0000000..6471a07 --- /dev/null +++ b/docs/src/site/sphinx/security/Encryption.rst @@ -0,0 +1,102 @@ +.. 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. + + +========== +Encryption +========== + +Sqoop 2 offers an HTTP REST-like API as the mechanism by which clients can +communicate with the Sqoop 2 server. The Sqoop 2 server and the Sqoop 2 shell +have support for TLS/SSL. + +Keystore Generation +=================== + +Sqoop 2 uses the JKS format. Details on how to create JKS files can be found here: +`Generating a KeyStore and TrustStore <https://docs.oracle.com/cd/E19509-01/820-3503/6nf1il6er/index.html>`_ + +Server Configuration +===================== + +All Sqoop 2 server TLS/SSL configuration occurs in the Sqoop configuration file, +normally in ``<Sqoop Folder>/conf/sqoop.properties``. + +First, TLS must be enabled: + +:: + + org.apache.sqoop.security.tls.enabled=true + +A protocol should be specified. Please find a list of options here: +`Standard Algorithm Name Documentation <http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#SSLContext>`_ + +:: + + org.apache.sqoop.security.tls.protocol="TLSv1.2" + + +Configure the path to the JKS keystore: + +:: + + org.apache.sqoop.security.tls.keystore=/Users/abe/mykeystore.jks + +Configure the keystore password and the key manager password: + +:: + + org.apache.sqoop.security.tls.keystore_password=keystorepassword + org.apache.sqoop.security.tls.keymanager_password=keymanagerpassword + +Alternatively, the password can be specified using generators. + +Generators are commands that the Sqoop propess will execute, and then retrieve the +password from standard out. The generator will only be run if no standard password +is configured. + +:: + + org.apache.sqoop.security.tls.keystore_password_generator=echo keystorepassword + org.apache.sqoop.security.tls.keymanager_password=echo keymanagerpassword + +Client/Shell Configuration +-------------------------- + +When using TLS on the Sqoop 2 server, especially with a self-signed certificate, +it may be useful to specify a truststore for the client/shell to use. + +The truststore for the shell is configured via a command. In practice, it may be +useful to put this command inside the system sqoop rc file (``/etc/sqoop2/conf/sqoop2rc``) +or the user's rc file (``~/.sqoop2rc``). + +:: + + sqoop:000> set truststore --truststore /Users/abefine/keystore/node2.truststore + Truststore set successfully + +You may also include a password. Passwords are not required for truststores. + +:: + + sqoop:000> set truststore --truststore /Users/abefine/keystore/node2.truststore --truststore-password changeme + Truststore set successfully + +You may also use a password generator. + +:: + + sqoop:000> set truststore --truststore /Users/abefine/keystore/node2.truststore --truststore-password-generator "echo changeme" + Truststore set successfully \ No newline at end of file http://git-wip-us.apache.org/repos/asf/sqoop/blob/1bd26e7f/docs/src/site/sphinx/security/SecurityGuideOnSqoop2.rst ---------------------------------------------------------------------- diff --git a/docs/src/site/sphinx/security/SecurityGuideOnSqoop2.rst b/docs/src/site/sphinx/security/SecurityGuideOnSqoop2.rst deleted file mode 100644 index 7194d3b..0000000 --- a/docs/src/site/sphinx/security/SecurityGuideOnSqoop2.rst +++ /dev/null @@ -1,239 +0,0 @@ -.. 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. - - -========================= -Security Guide On Sqoop 2 -========================= - -Most Hadoop components, such as HDFS, Yarn, Hive, etc., have security frameworks, which support Simple, Kerberos and LDAP authentication. currently Sqoop 2 provides 2 types of authentication: simple and kerberos. The authentication module is pluggable, so more authentication types can be added. Additionally, a new role based access control is introduced in Sqoop 1.99.6. We recommend to use this capability in multi tenant environments, so that malicious users canât easily abuse your created link and job objects. - -Simple Authentication -===================== - -Configuration -------------- -Modify Sqoop configuration file, normally in <Sqoop Folder>/conf/sqoop.properties. - -:: - - org.apache.sqoop.authentication.type=SIMPLE - org.apache.sqoop.authentication.handler=org.apache.sqoop.security.authentication.SimpleAuthenticationHandler - org.apache.sqoop.anonymous=true - -- Simple authentication is used by default. Commenting out authentication configuration will yield the use of simple authentication. - -Run command ------------ -Start Sqoop server as usual. - -:: - - <Sqoop Folder>/bin/sqoop.sh server start - -Start Sqoop client as usual. - -:: - - <Sqoop Folder>/bin/sqoop.sh client - -Kerberos Authentication -======================= - -Kerberos is a computer network authentication protocol which works on the basis of 'tickets' to allow nodes communicating over a non-secure network to prove their identity to one another in a secure manner. Its designers aimed it primarily at a clientâserver model and it provides mutual authenticationâboth the user and the server verify each other's identity. Kerberos protocol messages are protected against eavesdropping and replay attacks. - -Dependency ----------- -Set up a KDC server. Skip this step if KDC server exists. It's difficult to cover every way Kerberos can be setup (ie: there are cross realm setups and multi-trust environments). This section will describe how to setup the sqoop principals with a local deployment of MIT kerberos. - -- All components which are Kerberos authenticated need one KDC server. If current Hadoop cluster uses Kerberos authentication, there should be a KDC server. -- If there is no KDC server, follow http://web.mit.edu/kerberos/krb5-devel/doc/admin/install_kdc.html to set up one. - -Configure Hadoop cluster to use Kerberos authentication. - -- Authentication type should be cluster level. All components must have the same authentication type: use Kerberos or not. In other words, Sqoop with Kerberos authentication could not communicate with other Hadoop components, such as HDFS, Yarn, Hive, etc., without Kerberos authentication, and vice versa. -- How to set up a Hadoop cluster with Kerberos authentication is out of the scope of this document. Follow the related links like https://hadoop.apache.org/docs/r2.5.0/hadoop-project-dist/hadoop-common/SecureMode.html - -Create keytab and principal for Sqoop 2 via kadmin in command line. - -:: - - addprinc -randkey HTTP/<FQDN>@<REALM> - addprinc -randkey sqoop/<FQDN>@<REALM> - xst -k /home/kerberos/sqoop.keytab HTTP/<FQDN>@<REALM> - xst -k /home/kerberos/sqoop.keytab sqoop/<FQDN>@<REALM> - -- The <FQDN> should be replaced by the FQDN of the server, which could be found via âhostname -fâ in command line. -- The <REALM> should be replaced by the realm name in krb5.conf file generated when installing the KDC server in the former step. -- The principal HTTP/<FQDN>@<REALM> is used in communication between Sqoop client and Sqoop server. Since Sqoop server is an http server, so the HTTP principal is a must during SPNEGO process, and it is case sensitive. -- Http request could be sent from other client like browser, wget or curl with SPNEGO support. -- The principal sqoop/<FQDN>@<REALM> is used in communication between Sqoop server and Hdfs/Yarn as the credential of Sqoop server. - -Configuration -------------- -Modify Sqoop configuration file, normally in <Sqoop Folder>/conf/sqoop.properties. - -:: - - org.apache.sqoop.authentication.type=KERBEROS - org.apache.sqoop.authentication.handler=org.apache.sqoop.security.authentication.KerberosAuthenticationHandler - org.apache.sqoop.authentication.kerberos.principal=sqoop/_HOST@<REALM> - org.apache.sqoop.authentication.kerberos.keytab=/home/kerberos/sqoop.keytab - org.apache.sqoop.authentication.kerberos.http.principal=HTTP/_HOST@<REALM> - org.apache.sqoop.authentication.kerberos.http.keytab=/home/kerberos/sqoop.keytab - org.apache.sqoop.authentication.kerberos.proxyuser=true - -- When _HOST is used as FQDN in principal, it will be replaced by the real FQDN. https://issues.apache.org/jira/browse/HADOOP-6632 -- If parameter proxyuser is set true, Sqoop server will use proxy user mode (sqoop delegate real client user) to run Yarn job. If false, Sqoop server will use sqoop user to run Yarn job. - -Run command ------------ -Set SQOOP2_HOST to FQDN. - -:: - - export SQOOP2_HOST=$(hostname -f). - -- The <FQDN> should be replaced by the FQDN of the server, which could be found via âhostname -fâ in command line. - -Start Sqoop server using sqoop user. - -:: - - sudo âu sqoop <Sqoop Folder>/bin/sqoop.sh server start - -Run kinit to generate ticket cache. - -:: - - kinit HTTP/<FQDN>@<REALM> -kt /home/kerberos/sqoop.keytab - -Start Sqoop client. - -:: - - <Sqoop Folder>/bin/sqoop.sh client - -Verify ------- -If the Sqoop server has started successfully with Kerberos authentication, the following line will be in <@LOGDIR>/sqoop.log: - -:: - - 2014-12-04 15:02:58,038 INFO security.KerberosAuthenticationHandler [org.apache.sqoop.security.authentication.KerberosAuthenticationHandler.secureLogin(KerberosAuthenticationHandler.java:84)] Using Kerberos authentication, principal [sqoop/[email protected]] keytab [/home/kerberos/sqoop.keytab] - -If the Sqoop client was able to communicate with the Sqoop server, the following will be in <@LOGDIR>/sqoop.log : - -:: - - Refreshing Kerberos configuration - Acquire TGT from Cache - Principal is HTTP/<FQDN>@HADOOP.COM - null credentials from Ticket Cache - principal is HTTP/<FQDN>@HADOOP.COM - Will use keytab - Commit Succeeded - -Customized Authentication -========================= - -Users can create their own authentication modules. By performing the following steps: - -- Create customized authentication handler extends abstract class AuthenticationHandler. -- Implement abstract function doInitialize and secureLogin in AuthenticationHandler. - -:: - - public class MyAuthenticationHandler extends AuthenticationHandler { - - private static final Logger LOG = Logger.getLogger(MyAuthenticationHandler.class); - - public void doInitialize() { - securityEnabled = true; - } - - public void secureLogin() { - LOG.info("Using customized authentication."); - } - } - -- Modify configuration org.apache.sqoop.authentication.handler in <Sqoop Folder>/conf/sqoop.properties and set it to the customized authentication handler class name. -- Restart the Sqoop server. - -Authorization -============= - -Users, Groups, and Roles ------------------------- - -At the core of Sqoop's authorization system are users, groups, and roles. Roles allow administrators to give a name to a set of grants which can be easily reused. A role may be assigned to users, groups, and other roles. For example, consider a system with the following users and groups. - -:: - - <User>: <Groups> - user_all: group1, group2 - user1: group1 - user2: group2 - -Sqoop roles must be created manually before being used, unlike users and groups. Users and groups are managed by the login system (Linux, LDAP or Kerberos). When a user wants to access one resource (connector, link, connector), the Sqoop2 server will determine the username of this user and the groups associated. That information is then used to determine if the user should have access to this resource being requested, by comparing the required privileges of the Sqoop operation to the user privileges using the following rules. - -- User privileges (Has the privilege been granted to the user?) -- Group privileges (Does the user belong to any groups that the privilege has been granted to?) -- Role privileges (Does the user or any of the groups that the user belongs to have a role that grants the privilege?) - -Administrator -------------- - -There is a special user: administrator, which canât be created, deleted by command. The only way to set administrator is to modify the configuration file. Administrator could run management commands to create/delete roles. However, administrator does not implicitly have all privileges. Administrator has to grant privilege to him/her if he/she needs to request the resource. - -Role management commands ------------------------- - -:: - - CREATE ROLE ârole role_name - DROP ROLE ârole role_name - SHOW ROLE - -- Only the administrator has privilege for this. - -Principal management commands ------------------------------ - -:: - - GRANT ROLE --principal-type principal_type --principal principal_name --role role_name - REVOKE ROLE --principal-type principal_type --principal principal_name --role role_name - SHOW ROLE --principal-type principal_type --principal principal_name - SHOW PRINCIPAL --role role_name - -- principal_type: USER | GROUP | ROLE - -Privilege management commands ------------------------------ - -:: - - GRANT PRIVILEGE --principal-type principal_type --principal principal_name --resource-type resource_type --resource resource_name --action action_name [--with-grant] - REVOKE PRIVILEGE --principal-type principal_type --principal principal_name [--resource-type resource_type --resource resource_name --action action_name] [--with-grant] - SHOW PRIVILEGE âprincipal-type principal_type âprincipal principal_name [--resource-type resource_type --resource resource_name --action action_name] - -- principal_type: USER | GROUP | ROLE -- resource_type: CONNECTOR | LINK | JOB -- action_type: ALL | READ | WRITE -- With with-grant in GRANT PRIVILEGE command, this principal could grant his/her privilege to other users. -- Without resource in REVOKE PRIVILEGE command, all privileges on this principal will be revoked. -- With with-grant in REVOKE PRIVILEGE command, only grant privilege on this principal will be removed. This principal has the privilege to access this resource, but he/she could not grant his/her privilege to others. -- Without resource in SHOW PRIVILEGE command, all privileges on this principal will be listed.
