Safely authenticate Microsoft and Mojang accounts in development environments.
Versions | Module | Supported |
---|---|---|
1.14 - 1.18.2 fabric | fabric |
✅ |
1.8.9 - 1.12.2 forge | forge-legacy |
✅ |
1.14 - 1.18.2 forge | forge-latest |
✅ |
DevAuth can be used either by placing a jar in your mods folder or addding a maven dependency. Details about the two methods follow.
Download a DevAuth jar from the releases, place it in your mods folder and configure it using the configuration section below.
Add the DevAuth repository
repositories {
maven { url = "https://pkgs.dev.azure.com/djtheredstoner/DevAuth/_packaging/public/maven/v1" }
}
Add the DevAuth dependency
dependencies {
// moduleName is based on your mod loader and minecraft version, see the table above
// version is the DevAuth version you are adding, check releases on GitHub or the badge below
// With loom use the modRuntimeOnly configuration
// With archloom and the forge-legacy module use the runtimeOnly configuration to avoid warnings
// With ForgeGradle 5, use the runtimeOnly configuration
// With ForgeGradle 2, use the implementation configuration as runtimeOnly appears to be broken
modRuntimeOnly("me.djtheredstoner:DevAuth-${moduleName}:${version}")
}
If you use gg.essential.loom
and the forge-legacy
module, you must use version
0.10.0.2
or newer of gg.essential.loom
You can now enable and configure DevAuth. See the section below for details on how to do this.
DevAuth is configured through JVM properties and a configuration file.
JVM Properties can be by adding -D<propertyName>=<value>
to your JVM arguments
or by using System.setProperty
before DevAuth is initialized
(fabric preLaunch
entrypoint for example).
Property | Description | Default |
---|---|---|
devauth.enabled |
Enables DevAuth | false |
devauth.configDir |
Selects the config directory | .devauth folder in home directory |
devauth.account |
Select the account to log into | none |
NEW: The devauth.enabled
property now defaults to false and a default configuration wil not be created
until DevAuth has been enabled once. Then you can set the defaultEnabled
config property to make DevAuth
active by default in every project.
The configuration file is called config.toml
and is located in your DevAuth config
folder (defaults to .devauth
in home directory, C:\Users\<user>\.devauth
for Windows users).
# chose if DevAuth should be on by default in new projects
defaultEnabled = true
# choose which account to use when devauth.account property is not specified
defaultAccount = "main"
# a mojang account
[accounts.main]
type = "mojang"
username = "example@example.com"
password = "hunter12"
# a microsoft account
# note that setting username and password IS NOT required and does nothing
[accounts.alt]
type = "microsoft"
When the devauth.account
property is specified it takes precedence over the
defaultAccount
config option.
A default config will be automatically created when DevAuth is first enabled.
When logging in with a microsoft account for the first time, you will be given a
link to open in a browser to complete OAuth, after that the token will be stored
in a file called microsoft_accounts.json
in your config directory. Future logins
will use and refresh the stored tokens as necessary. You will be prompted to go through
OAuth again once your refresh token expires (my research leads me to believe it should last 90 days)
or is revoked.
I like to think of DevAuth as safe and somewhat secure. Yes, Mojang account passwords are
stored in plain text, however they will soon be are now deprecated, so I decided investing time and effort
into encrypting them would be silly. The Microsoft account tokens stored locally in microsoft_accounts.json
only provide limited access to your account and can be revoked by removing the DevAuth app here.
If you don't think this is secure enough, make an issue or pull request.