Add the new doc about security in the toc.json
Project: http://git-wip-us.apache.org/repos/asf/ant-ivyde/repo Commit: http://git-wip-us.apache.org/repos/asf/ant-ivyde/commit/ed330e92 Tree: http://git-wip-us.apache.org/repos/asf/ant-ivyde/tree/ed330e92 Diff: http://git-wip-us.apache.org/repos/asf/ant-ivyde/diff/ed330e92 Branch: refs/heads/master Commit: ed330e92ff346fdb996a347f1b0638a3a9fc4a6c Parents: fc1eb9d Author: Nicolas LaleveÌe <nicolas.lale...@hibnet.org> Authored: Tue Jul 11 22:41:42 2017 +0200 Committer: Nicolas LaleveÌe <nicolas.lale...@hibnet.org> Committed: Tue Jul 11 22:41:42 2017 +0200 ---------------------------------------------------------------------- doc/src/credentialsExtension.adoc | 92 ---------------------------------- doc/src/security.adoc | 88 ++++++++++++++++++++++++++++++++ doc/src/toc.json | 7 +++ 3 files changed, 95 insertions(+), 92 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/ed330e92/doc/src/credentialsExtension.adoc ---------------------------------------------------------------------- diff --git a/doc/src/credentialsExtension.adoc b/doc/src/credentialsExtension.adoc deleted file mode 100644 index efaf6c4..0000000 --- a/doc/src/credentialsExtension.adoc +++ /dev/null @@ -1,92 +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]]Security - -This preference section allows you to manage credentials, which the ivy dependency manager needs to access protected repositories. The credentials are directly stored into the Eclipse Secure storage and loaded during the ivyDE-plugin's startup. This preference page allows you to manage your ivy credentials safely without the need to "publish" them in plain-text inside your build-files. - -== [[general]]General workflow - -The ivyDE credentials extension allows you - as already mentioned - to protect your ivy credentials by using the Eclipse Secure storage. The credential entries are only maintained by the Eclipse secure storage itself: Every operation (add/edit/remove) is directly performed on the Eclipse secure storage without any intermediate caches. At the ivyDE plugin's startup, the Eclipse Secure storage is accessed (this operation requires you to insert your password if your Eclipse Secure storage is password-protected) and all the credential entries - which are related to the ivy dependency manager - are loaded and copied to the internal ivy credential manager (where ivy looks for credentials in case of protected repositories). - -Please note that this "credential-copying" is directly done after the ivyDE plugin's startup. If your ivy-configuration files, respectively, your build-files also contain credentials pointing to the same repository (same host@realm combination as already stored in the Eclipse Secure storage), the credentials inside the Eclipse Secure storage may be overwritten due to the fact, that credentials specified within the mentioned alternative locations may be added to the internal ivy credential manager after the "credential-copying" was performed. - -.General: - -== [[credentialsOverview]]Overview - -In this view all your credentials related to the ivy dependency manager are listed. The credentials consist of: - -* Host: The host of your protected repository. - -* Realm: The realm of your protected repository. - -* Username: The username which grants access to the protected repository. - -* Pwd: The password to identify yourself. - -You can either add new credentials or edit/remove existing ones (see next sections). - -image::images/sec_security_preferences.png[] - -== [[addCredentials]]Add new credentials - -Click on the "Add..." button to add new credentials: - -image::images/sec_add_credentials_empty.png[] - -A new dialog appears where you can insert a new credential entry. The properties "Host" and "Realm" are required because they are used to identify an artifact-repository and thus also a credential entry within the Eclipse secure storage. The property "Id" is read-only and shows you the repository's identifier (host@realm). - -image::images/sec_add_credentials_filled.png[] - -If the inserted host@realm combination is unique and not already existing, the credential entry can be saved (stored directly to the Eclipse Secure storage). Press "OK" to save, "Cancel" otherwise. - -The added credential entry is now visible within the overview and can be edited or removed: - -image::images/sec_add_credentials_overview.png[] - -Adding a new credential entry having the same identifier is not permitted (as mentioned before): - -image::images/sec_add_credentials_duplicate.png[] - -The ivy dependency manager allows multiple repositories for the same host, but their realm has to be unique on that host: - -image::images/sec_add_credentials_duplicate_resolved.png[] - -== [[editCredentials]]Edit existing credentials - -Once credentials are added to the Eclipse Secure storage, they can be edited. To edit a credential entry, select the desired entry (row) listed in the overview and press "Edit...": - -image::images/sec_edit_credentials_init.png[] - -Afterwards the edit dialog appears. Press "OK" to save your changes or "Cancel" to discard your changes: - -image::images/sec_edit_credentials_completed.png[] - -If you saved your changes, the credential entry inside the Eclipse Secure storage is updated and the credential overview is refreshed: - -image::images/sec_edit_credentials_overview.png[] - -== [[editCredentials]]Remove existing credentials - -In the credentials overview press "Remove" to delete the selected credential entry. Press "OK" to confirm or "Cancel" to abort the operation: - -image::images/sec_remove_credentials.png[] - -Please note that the internal ivyDE credentials manager (currently) does not permit to delete credentials once they are loaded at startup. If you delete credentials entries, the corresponding entries in the internal ivyDE credentials manager are invalidated (password and username are nulled). After Eclipse is restarted, the the internal ivyDE credentials manager is rebuild. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/ed330e92/doc/src/security.adoc ---------------------------------------------------------------------- diff --git a/doc/src/security.adoc b/doc/src/security.adoc new file mode 100644 index 0000000..c8d3e8c --- /dev/null +++ b/doc/src/security.adoc @@ -0,0 +1,88 @@ +//// + 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. +//// + +This preference section allows you to manage credentials, which the ivy dependency manager needs to access protected repositories. The credentials are directly stored into the Eclipse Secure storage and loaded during the ivyDE-plugin's startup. This preference page allows you to manage your ivy credentials safely without the need to "publish" them in plain-text inside your build-files. + +== [[general]]General workflow + +The ivyDE credentials extension allows you - as already mentioned - to protect your ivy credentials by using the Eclipse Secure storage. The credential entries are only maintained by the Eclipse secure storage itself: Every operation (add/edit/remove) is directly performed on the Eclipse secure storage without any intermediate caches. At the ivyDE plugin's startup, the Eclipse Secure storage is accessed (this operation requires you to insert your password if your Eclipse Secure storage is password-protected) and all the credential entries - which are related to the ivy dependency manager - are loaded and copied to the internal ivy credential manager (where ivy looks for credentials in case of protected repositories). + +Please note that this "credential-copying" is directly done after the ivyDE plugin's startup. If your ivy-configuration files, respectively, your build-files also contain credentials pointing to the same repository (same host@realm combination as already stored in the Eclipse Secure storage), the credentials inside the Eclipse Secure storage may be overwritten due to the fact, that credentials specified within the mentioned alternative locations may be added to the internal ivy credential manager after the "credential-copying" was performed. + +== [[credentialsOverview]]Overview + +In this view all your credentials related to the ivy dependency manager are listed. The credentials consist of: + +* Host: The host of your protected repository. + +* Realm: The realm of your protected repository. + +* Username: The username which grants access to the protected repository. + +* Pwd: The password to identify yourself. + +You can either add new credentials or edit/remove existing ones (see next sections). + +image::images/sec_security_preferences.png[] + +== [[addCredentials]]Add new credentials + +Click on the "Add..." button to add new credentials: + +image::images/sec_add_credentials_empty.png[] + +A new dialog appears where you can insert a new credential entry. The properties "Host" and "Realm" are required because they are used to identify an artifact-repository and thus also a credential entry within the Eclipse secure storage. The property "Id" is read-only and shows you the repository's identifier (host@realm). + +image::images/sec_add_credentials_filled.png[] + +If the inserted host@realm combination is unique and not already existing, the credential entry can be saved (stored directly to the Eclipse Secure storage). Press "OK" to save, "Cancel" otherwise. + +The added credential entry is now visible within the overview and can be edited or removed: + +image::images/sec_add_credentials_overview.png[] + +Adding a new credential entry having the same identifier is not permitted (as mentioned before): + +image::images/sec_add_credentials_duplicate.png[] + +The ivy dependency manager allows multiple repositories for the same host, but their realm has to be unique on that host: + +image::images/sec_add_credentials_duplicate_resolved.png[] + +== [[editCredentials]]Edit existing credentials + +Once credentials are added to the Eclipse Secure storage, they can be edited. To edit a credential entry, select the desired entry (row) listed in the overview and press "Edit...": + +image::images/sec_edit_credentials_init.png[] + +Afterwards the edit dialog appears. Press "OK" to save your changes or "Cancel" to discard your changes: + +image::images/sec_edit_credentials_completed.png[] + +If you saved your changes, the credential entry inside the Eclipse Secure storage is updated and the credential overview is refreshed: + +image::images/sec_edit_credentials_overview.png[] + +== [[editCredentials]]Remove existing credentials + +In the credentials overview press "Remove" to delete the selected credential entry. Press "OK" to confirm or "Cancel" to abort the operation: + +image::images/sec_remove_credentials.png[] + +Please note that the internal ivyDE credentials manager (currently) does not permit to delete credentials once they are loaded at startup. If you delete credentials entries, the corresponding entries in the internal ivyDE credentials manager are invalidated (password and username are nulled). After Eclipse is restarted, the the internal ivyDE credentials manager is rebuild. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/ed330e92/doc/src/toc.json ---------------------------------------------------------------------- diff --git a/doc/src/toc.json b/doc/src/toc.json index f1d47b6..74dc35f 100644 --- a/doc/src/toc.json +++ b/doc/src/toc.json @@ -162,6 +162,13 @@ ] }, { + "id":"security", + "title":"Security", + "children": [ + + ] + }, + { "id":"console", "title":"Ivy Console", "children": [
