Changes between Version 30 and Version 37 of Help/Dialog/OAuthAuthorisationWizard
- Timestamp:
- (multiple changes)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Help/Dialog/OAuthAuthorisationWizard
v30 v37 1 [[TranslatedPages]] 2 = OAuth Authorisation Wizard = 3 [[TOC(inline)]] 1 [[TranslatedPages(outdated=The Authorization Wizard was removed from JOSM with the deprecation of OAuth 1.0a. This page still exist mainly for historical reasons.)]] 2 3 = OAuth Authorization Wizard = 4 [[PageOutline(2-10,Table of Contents)]] 4 5 5 6 == OAuth in a nutshell == 6 [http://oauth.net/ OAuth] is an open protocol to allow secure API authori sation in a simple and standard method from desktop and web applications.7 [https://oauth.net/ OAuth] is an open protocol to allow secure API authorization in a simple and standard method from desktop and web applications. 7 8 8 9 === Standard use case - keep your OSM password private === … … 11 12 OAuth has two major advantages over Basic Authentication: 12 13 1. Your OSM password doesn't have to be saved in clear text in the JOSM preferences file. 13 1. Your OSM password has to be transferred '''only once'''over the Internet on a'''secure connection''', in contrast to basic authentication where your OSM password is transferred as part of every request sent from JOSM to the OSM server in clear text.14 1. Your OSM password has to be transferred **only once** over the Internet on a **secure connection**, in contrast to basic authentication where your OSM password is transferred as part of every request sent from JOSM to the OSM server in clear text. 14 15 15 In OAuth terminology, a JOSM user authori ses JOSM to access the OSM server on the user's behalf. During the authorisation process the OSM password never needs to be entered into a JOSM dialog if the user doesn't fully trust JOSM (unless wanting to for convenience reasons [wiki:/Help/Dialog/OAuthAuthorisationWizard#FullyAutomaticAuthorisation see here]). Rather, the OSM server issues an Access Token which JOSM presents to the OSM server when it uploads data on behalf of the user. Access Tokens don't reveal the user's password and they can be revoked at any time.16 In OAuth terminology, a JOSM user authorizes JOSM to access the OSM server on the user's behalf. During the authorization process the OSM password never needs to be entered into a JOSM dialog if the user doesn't fully trust JOSM (unless wanting to for convenience reasons [wikitr:/Help/Dialog/OAuthAuthorisationWizard#FullyAutomaticAuthorisation see here]). Rather, the OSM server issues an Access Token which JOSM presents to the OSM server when it uploads data on behalf of the user. Access Tokens don't reveal the user's password and they can be revoked at any time. 16 17 17 18 === Advanced use case - delegate access to other mappers === … … 21 22 22 23 23 == The OAuth Authorisation Wizard == 24 The Oauth authorisation wizard is located in the preferences under [Preferences/Connection Connection settings]. 25 === What does authentication/authorisation mean? === 26 When you upload geodata to the OSM server you have to tell the server who you are. The OSM server will '''identify''' every uploading mapper by asking for an OSM username. The OSM server furthermore needs to '''authenticate''' this identity, i.e. to reliably determine whether the mapper is indeed the claimed user. For this purpose, it asks for a password in addition to the username. The server's assumption is that whoever knows the secret password for username xyz is reliably authenticated to ''be'' xyz. A mapper logged in with an authenticated username and password is entitled to run a broad range of operations on the server. The mapper is '''authorised''' to upload data, to create changesets, to close changesets, to upload GPS traces, to read and changes personal preferences on the server, to invite others as friends, to send emails to other accounts, etc. Currently, it isn't possible to create an OSM account with an OSM username and a password with restricted rights, i.e. an account that would only be able to upload GPS traces, but not map data. Whoever has successfully '''authenticated''' with an OSM username and an OSM password is '''fully authorised''' to do everything an OSM user can normally do on the server. 24 == The OAuth Authorization Wizard == 25 The Oauth authorization wizard is located in the preferences under [wikitr:/Help/Preferences/Connection OSM Server preferences]. 27 26 28 This is where OAuth comes into play: OAuth allows you to '''authorise''' somebody else to act in a restricted way on your behalf. Instead of giving away your OSM username and your OSM password, which would fully entitle the recipient to act on your behalf at the OSM server, you only give away a "ticket" on which the granted rights are listed. This ticket is called an '''Access Token'''. Restrictions applied to an Access Token include: 27 === What does authentication/authorization mean? === 28 When you upload geodata to the OSM server you have to tell the server who you are. The OSM server will **identify** every uploading mapper by asking for an OSM username. The OSM server furthermore needs to **authenticate** this identity, i.e. to reliably determine whether the mapper is indeed the claimed user. For this purpose, it asks for a password in addition to the username. The server's assumption is that whoever knows the secret password for username xyz is reliably authenticated to ''be'' xyz. A mapper logged in with an authenticated username and password is entitled to run a broad range of operations on the server. The mapper is ***authorized** to upload data, to create changesets, to close changesets, to upload GPS traces, to read and changes personal preferences on the server, to invite others as friends, to send emails to other accounts, etc. Currently, it isn't possible to create an OSM account with an OSM username and a password with restricted rights, i.e. an account that would only be able to upload GPS traces, but not map data. Whoever has successfully **authenticated** with an OSM username and an OSM password is **fully authorized** to do everything an OSM user can normally do on the server. 29 30 This is where OAuth comes into play: OAuth allows you to **authorize** somebody else to act in a restricted way on your behalf. Instead of giving away your OSM username and your OSM password, which would fully entitle the recipient to act on your behalf at the OSM server, you only give away a "ticket" on which the granted rights are listed. This ticket is called an **Access Token**. Restrictions applied to an Access Token include: 29 31 * an Access Token is only valid for a specific client (called a Consumer in OAuth terminology), i.e. only for JOSM, but not for OpenStreetBugs 30 32 * an Access Token is only valid for specific operations, i.e. only for uploading GPS traces, but not for uploading map data 31 33 * an Access Token could only be valid for a certain time, i.e. only today, but this is not yet supported by the OSM server 32 34 33 In addition to username/password pairs, the OSM server also accepts OAuth Access Tokens to authenticate and authori se a user. More specifically, it accepts requests ''signed with such a token'', but this is beyond of the scope of this online help.35 In addition to username/password pairs, the OSM server also accepts OAuth Access Tokens to authenticate and authorize a user. More specifically, it accepts requests ''signed with such a token'', but this is beyond of the scope of this online help. 34 36 35 The OAuth Authori sation Wizard allows you to receive a valid OAuth Access Token, provided that you have an OSM username and OSM password, or to enter and use an OAuth Access Token in JOSM, provided that you got one from somebody else who has an OSM username and an OSM password.37 The OAuth Authorization Wizard allows you to receive a valid OAuth Access Token, provided that you have an OSM username and OSM password, or to enter and use an OAuth Access Token in JOSM, provided that you got one from somebody else who has an OSM username and an OSM password. 36 38 37 === Fully automatic authori sation process ===#FullyAutomaticAuthorisation39 === Fully automatic authorization process ===#FullyAutomaticAuthorisation 38 40 The easiest way to get an Access Token is to let JOSM fully automatically retrieve one from the OSM server. 39 41 40 1. '''Step 1/3'''- Open the preferences dialog42 1. **Step 1/3** - Open the preferences dialog 41 43 42 Click on the '''Preferences'''button in the toolbar. In the dialog, select the [wiki:Help/Preferences/Connection Connection Setting] tab.44 Click on the **Preferences** button in the toolbar. In the dialog, select the [wikitr:/Help/Preferences/Connection Connection Setting] tab. 43 45 44 2. '''Step 2/3'''- Get the Access Token46 2. **Step 2/3** - Get the Access Token 45 47 46 Enter your OSM username and your OSM password and click on '''Authorise now'''.48 Enter your OSM username and your OSM password and click on **Authorize now**. 47 49 48 [[Image(fully-authomatic-1.png)]] 50 [[Image(fully-authomatic-1.png,link=)]] 49 51 50 3. '''Step 3/3'''- Accept the Access Token52 3. **Step 3/3** - Accept the Access Token 51 53 52 54 JOSM displays the retrieved Access Token. 53 55 54 [[Image(fully-authomatic-2.png)]] 56 [[Image(fully-authomatic-2.png,link=)]] 55 57 56 58 * Deselect the checkbox Save to preferences if you don't want to save the Access Token in the JOSM preferences. If you don't save it the Access Token will be lost when you close JOSM. If you later startup JOSM again you will have to retrieve a new Access Token to work with OAuth based authentication again. 57 * Click on ''Test Access Token"to test the token58 * Click on '''Accept Access Token'''to accept it.59 * Click on **Test Access Token** to test the token 60 * Click on **Accept Access Token** to accept it. 59 61 60 62 ==== Restricting the granted privileges ==== 61 When JOSM fully-automatically requests and authori ses an Access Token, it grants itfiveprivileges:63 When JOSM fully-automatically requests and authorizes an Access Token, it grants it six privileges: 62 64 * the right to upload data to the OSM server 63 65 * the right to upload GPS traces to the OSM server … … 65 67 * the right to read the preferences stored on the OSM server 66 68 * the right to write preferences stored on the OSM server 69 * the right to modify notes stored on the OSM server 67 70 68 71 These are the default settings. If you want to restrict the granted privileges: 69 72 70 1. Click the tab '''Granted rights'''73 1. Click the tab **Granted rights** 71 74 1. Deselect each privilege which should not be granted to the requested Access Token 72 75 73 [[Image(fully-authomatic-privileges.png)]] 76 [[Image(fully-authomatic-privileges.png,link=)]] 74 77 75 78 ==== Advanced OAuth parameters ==== #FullyAutomaticAdvanced … … 80 83 In order to edit the Advanced OAuth parameters 81 84 82 1. Click the tab '''Advanced OAuth parameters'''83 1. Deselect the checkbox '''Use default settings'''84 1. Enter your values for the fiveOAuth parameters85 1. Click the tab **Advanced OAuth parameters** 86 1. Deselect the checkbox **Use default settings** 87 1. Enter your values for the seven OAuth parameters 85 88 86 [[Image(fully-automatic-advanced.png)]] 89 [[Image(fully-automatic-advanced.png,link=)]] 87 90 88 === Semi-automatic authori sation process ===89 You can also retrieve an Access Token semi-automatically. If you use this process you have to use both dialogs in JOSM and the OSM website launched in an external browser to create and authori se the Access Token. In contrast to the fully automatic process you never have to enter your OSM username or your OSM password into a JOSM dialog. This process is therefore suitable for a user which - for whatever reason - never wants to use their OSM password outside of the secure login page of the OSM website. The fully automatic process runs exactly the same steps that would run manually in the semi-automatic process, just without your intervention.91 === Semi-automatic authorization process ===#Semi-automaticauthorisationprocess 92 You can also retrieve an Access Token semi-automatically. If you use this process you have to use both dialogs in JOSM and the OSM website launched in an external browser to create and authorize the Access Token. In contrast to the fully automatic process you never have to enter your OSM username or your OSM password into a JOSM dialog. This process is therefore suitable for a user which - for whatever reason - never wants to use their OSM password outside of the secure login page of the OSM website. The fully automatic process runs exactly the same steps that would run manually in the semi-automatic process, just without your intervention. 90 93 94 1. **Step 1/3** - Get the Request Token 91 95 92 1. '''Step 1/3''' - Get the Request Token 96 Click on **Retrieve Request Token** to retrieve an OAuth Request Token. 97 98 [[Image(semi-automatic-step-1.png,link=)]] 93 99 94 Click on '''Retrieve Request Token''' to retrieve an OAuth Request Token. 100 2. **Step 2/3** - Authorize the Request Token in an external browser 101 102 JOSM now launches an external browser with the OSM website. Please login and follow the instructions. Then switch back to the OAuth Authorization Wizard and click on **Retrieve Access Token**. 95 103 96 [[Image(semi-automatic-step- 1.png)]]104 [[Image(semi-automatic-step-2.png,link=)]] 97 105 98 2. '''Step 2/3''' - Authorise the Request Token in an external browser 106 3. **Step 3/3** - Accept the Access Token 99 107 100 JOSM now launches an external browser with the OSM website. Please login and follow the instructions. Then switch back to the OAuth Authorisation Wizard and click on '''Retrieve Access Token'''.108 JOSM displays the retrieved Access Token. Click on **Accept Access Token** to accept it. 101 109 102 [[Image(semi-automatic-step-2.png)]] 103 104 3. '''Step 3/3''' - Accept the Access Token 105 106 JOSM displays the retrieved Access Token. Click on '''Accept Access Token''' to accept it. 107 108 [[Image(semi-automatic-step-3.png)]] 110 [[Image(semi-automatic-step-3.png,link=)]] 109 111 110 112 111 113 ==== Advanced OAuth parameters ==== #AdvancedOAuthparameters 112 When JOSM semi-automatically requests and authori ses an Access Token, it uses default values for the OAuth parameters. Advanced users may want to change these parameters114 When JOSM semi-automatically requests and authorizes an Access Token, it uses default values for the OAuth parameters. Advanced users may want to change these parameters: 113 115 * in order to use a different Consumer Token (consisting of a Consumer Key and a Consumer Secret). This allows you to create your own Consumer Token for JOSM and then use it in JOSM. 114 116 * in order to use it on a different than the standard OSM server. For instance, this allows users to use OAuth with an OSM development server or with a local installation of the OSM server application. … … 116 118 In order to edit the Advanced OAuth parameters 117 119 118 '''Display Advanced OAuth Parameters'''119 fiveOAuth parameters120 1. Select the checkbox **Display Advanced OAuth Parameters** 121 1. Enter your values for the seven OAuth parameters 120 122 121 [[Image(semi-automatic-advanced.png)]] 123 [[Image(semi-automatic-advanced.png,link=)]] 122 124 123 === Manual authori sation process ===124 The manual authori sation process allows you to enter an arbitrary Access Token. You can use this process125 === Manual authorization process === 126 The manual authorization process allows you to enter an arbitrary Access Token. You can use this process: 125 127 126 128 * to enter an Access Token you have kept in a secure place, for instance in a secure store for credentials 127 129 * to enter an Access Token you have received from somebody else, for instance from another mapper who granted you restricted account access 128 130 129 1. '''Step 1/1'''- Enter the Access Token and accept it131 1. **Step 1/1** - Enter the Access Token and accept it 130 132 131 Enter the Access Token and click on '''Accept Access Token'''.133 Enter the Access Token and click on **Accept Access Token**. 132 134 133 [[Image(manual.png)]] 135 [[Image(manual.png,link=)]] 134 136 135 137 136 138 ==== Advanced OAuth parameters ==== 137 * See [wiki:/Help/Dialog/OAuthAuthorisationWizard#FullyAutomaticAdvanced advanced preferences in the fully automatic process]. 139 * See [wikitr:/Help/Dialog/OAuthAuthorisationWizard#FullyAutomaticAdvanced advanced preferences in the fully automatic process]. 138 140 139 141 == Troubleshooting == 140 * If you are working on a university or corporate network, a firewall may prevent the OAuth authenti fication request.[[BR]]142 * If you are working on a university or corporate network, a firewall may prevent the OAuth authentication request. \\ 141 143 Please check the corresponding connection with your network engineer. 142 144 ---- 143 Back to [wiki:/Help/Preferences/Connection Connection settings][[Br]]144 Back to [wiki :Help Main Help]145 Back to [wikitr:/Help/Preferences/Connection OSM Server preferences] \\ 146 Back to [wikitr:/Help Main Help]
