docs(ed2k): say that aMule enables SUI by default - #208
Merged
Merged
Conversation
The page read as if Secure User Identification were opt-in: the intro said it "can be enabled in Preferences -> Security" and a closing section walked the reader through switching it on. Neither mentioned that it is already on, which led to amule-org/amule#1308 asking for it to be made the default. It has been the default since 2007: the preference is registered with a true default and the Preferences checkbox is created ticked, so a fresh profile writes UseSecIdent=1 and generates cryptkey.dat on first start. Say that up front, and replace the enabling walkthrough with how to check it is working (the key file and the log line that announces it, the Verified - OK state in Client Details), plus the two things worth knowing: keep cryptkey.dat, because losing it means losing the identity peers credited, and turning the option off stops peers crediting your uploads.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes the wording that prompted amule-org/amule#1308.
The page presented SUI as opt-in: the intro said it "can be enabled in Preferences → Security", and a closing Enabling SUI section walked the reader through switching it on. Neither said it is already on, so a reader reasonably concluded aMule ships with it off and asked for it to be made the default.
It has been the default since 2007.
Cfg_Bool("/ExternalConnect/UseSecIdent", s_SecIdent, true)insrc/Preferences.cpp, the Preferences checkbox is created ticked insrc/muuli_wdr.cpp, and there is no build-time switch. Verified on a fresh profile with current master rather than from the code alone: an empty config directory getsUseSecIdent=1inamule.conf, the log lineNo 'cryptkey.dat' file found, creating., and a 365-bytecryptkey.dat.Two changes:
Verified - OKidentification line in the Client Details dialog. Plus the two things a user actually needs to know, neither of which the page said before - keepcryptkey.dat, because deleting it creates a new identity that no peer has credited, and turning the option off stops peers crediting your uploads.The wording for the identification state is taken from the source (
ClientRef.cpprendersVerified - OK/Failed/Not complete/Bad Guy) rather than from memory of the UI.This page has no
i18n/mirrors yet, so only the English source changes and no translation files are touched.