Файл конфигурации android Microsoft Authentication Library

Android Microsoft Authentication Library (MSAL) поставляется с JSON-файлом конфигурации по умолчанию, который вы настраиваете для определения поведения общедоступного клиентского приложения для таких вещей, как центр по умолчанию, который вы будете использовать, и т. д.

В этой статье вы узнаете о различных параметрах в файле конфигурации и о том, как указать файл конфигурации, используемый в приложении на основе MSAL.

Параметры конфигурации

Общие параметры

client_id

Идентификатор клиента или идентификатор приложения, созданный при регистрации приложения.

redirect_uri (URI перенаправления)

URI перенаправления, зарегистрированный при регистрации приложения. Если URI перенаправления относится к приложению брокера, обратитесь к URI перенаправления для общедоступных клиентских приложений , чтобы убедиться, что для приложения брокера используется правильный формат URI перенаправления.

broker_redirect_uri_registered

Если вы хотите использовать проверку подлинности с брокером, broker_redirect_uri_registered свойство должно иметь значение true. Если приложение не имеет правильного формата для взаимодействия с брокером, как описано в URI перенаправления для общедоступных клиентских приложений, приложение проверяет URI перенаправления и создает исключение при запуске.

authorities

Список известных и доверенных вами органов. Помимо перечисленных здесь властей MSAL также запрашивает Microsoft получить список облаков и властей, известных Microsoft. В этом списке органов укажите тип центра и дополнительные дополнительные параметры, такие как, которые "audience"должны соответствовать аудитории вашего приложения на основе регистрации приложения. Ниже приведен пример списка властей:

// Example AzureAD and Personal Microsoft Account
{
    "type": "AAD",
    "audience": {
        "type": "AzureADandPersonalMicrosoftAccount"
    },
    "default": true // Indicates that this is the default to use if not provided as part of the acquireToken call
},
// Example AzureAD My Organization
{
    "type": "AAD",
    "audience": {
        "type": "AzureADMyOrg",
        "tenant_id": "contoso.com" // Provide your specific tenant ID here
    }
},
// Example AzureAD Multiple Organizations
{
    "type": "AAD",
    "audience": {
        "type": "AzureADMultipleOrgs"
    }
},
//Example PersonalMicrosoftAccount
{
    "type": "AAD",
    "audience": {
        "type": "PersonalMicrosoftAccount"
    }
}

Сопоставление Microsoft Entra центра и аудитории с платформа удостоверений Майкрософт конечными точками

Свойства центра

Свойства аудитории

authorization_user_agent

Указывает, следует ли использовать внедренное веб-представление или браузер по умолчанию на устройстве при входе в учетную запись или авторизацию доступа к ресурсу.

Возможные значения:

• DEFAULT: предпочитает системный браузер. Использует внедренное веб-представление, если браузер недоступен на устройстве.
• WEBVIEW: используйте внедренное веб-представление.
• BROWSER: использует браузер по умолчанию на устройстве.

multiple_clouds_supported

Для клиентов, поддерживающих несколько национальных облаков, укажите true. Затем платформа удостоверений Майкрософт автоматически перенаправляется в правильное национальное облако во время авторизации и активации маркера. Вы можете определить национальное облако учетной записи, вошедшего в систему, проверив полномочия, связанные с этим AuthenticationResult. Обратите внимание, что AuthenticationResult не предоставляет адрес конечной точки для конкретной облачной среды ресурса, для которого запрашивается маркер.

broker_redirect_uri_registered

Логическое значение, указывающее, используется ли брокер удостоверений Microsoft, совместимый с URI перенаправления в брокере. false Установите значение, если вы не хотите использовать брокер в приложении.

Если вы используете центр Microsoft Entra с набором "MicrosoftPersonalAccount"аудиторий, брокер не будет использоваться.

HTTP

Настройте глобальные параметры для времени ожидания HTTP, например:

лесозаготовка

Для ведения журнала используются следующие глобальные параметры:

account_mode

Указывает, сколько учетных записей можно использовать в приложении за раз. Возможны следующие значения:

• MULTIPLE (по умолчанию)
• SINGLE

Создание PublicClientApplication режима учетной записи, не соответствующего этому параметру, приведет к исключению.

Дополнительные сведения о различиях между одной и несколькими учетными записями см. в разделе "Одно и несколько приложений учетной записи".

browser_safelist

Список разрешенных браузеров, совместимых с MSAL. Эти браузеры правильно обрабатывают перенаправления в пользовательские намерения. Вы можете добавить в этот список. Значение по умолчанию указано в конфигурации по умолчанию, показанной ниже. ``

Файл конфигурации MSAL по умолчанию

Конфигурация MSAL по умолчанию, которая поставляется с MSAL, показана ниже. Последняя версия отображается на GitHub.

Эта конфигурация дополняется указанными значениями. Указанные значения переопределяют значения по умолчанию.

{
  "authorities": [
    {
      "type": "AAD",
      "audience": {
        "type": "AzureADandPersonalMicrosoftAccount"
      },
      "default": true
    }
  ],
  "authorization_user_agent": "DEFAULT",
  "multiple_clouds_supported": false,
  "broker_redirect_uri_registered": false,
  "http": {
    "connect_timeout": 10000,
    "read_timeout": 30000
  },
  "logging": {
    "pii_enabled": false,
    "log_level": "WARNING",
    "logcat_enabled": false
  },
  "shared_device_mode_supported": false,
  "account_mode": "MULTIPLE",
  "browser_safelist": [
    {
      "browser_package_name": "com.android.chrome",
      "browser_signature_hashes": [
        "7fmdu...2NDJg=="
      ],
      "browser_use_customTab" : true,
      "browser_version_lower_bound": "45"
    },
    {
      "browser_package_name": "com.android.chrome",
      "browser_signature_hashes": [
        "7fmdu...2NDJg=="
      ],
      "browser_use_customTab" : false
    },
    {
      "browser_package_name": "org.mozilla.firefox",
      "browser_signature_hashes": [
        "2gCe6...idpVQ=="
      ],
      "browser_use_customTab" : false
    },
    {
      "browser_package_name": "org.mozilla.firefox",
      "browser_signature_hashes": [
        "2gCe6...idpVQ=="
      ],
      "browser_use_customTab" : true,
      "browser_version_lower_bound": "57"
    },
    {
      "browser_package_name": "com.sec.android.app.sbrowser",
      "browser_signature_hashes": [
        "ABi2f...4O1Xgg=="
      ],
      "browser_use_customTab" : true,
      "browser_version_lower_bound": "4.0"
    },
    {
      "browser_package_name": "com.sec.android.app.sbrowser",
      "browser_signature_hashes": [
        "ABi2f...O1Xgg=="
      ],
      "browser_use_customTab" : false
    },
    {
      "browser_package_name": "com.cloudmosa.puffinFree",
      "browser_signature_hashes": [
        "1WqG8...Mn8Ag=="
      ],
      "browser_use_customTab" : false
    },
    {
      "browser_package_name": "com.duckduckgo.mobile.android",
      "browser_signature_hashes": [
        "S5Av4...jAi4Q=="
      ],
      "browser_use_customTab" : false
    },
    {
      "browser_package_name": "com.explore.web.browser",
      "browser_signature_hashes": [
        "BzDzB...YHCag=="
      ],
      "browser_use_customTab" : false
    },

    {
      "browser_package_name": "com.ksmobile.cb",
      "browser_signature_hashes": [
        "lFDYx...7nouw=="
      ],
      "browser_use_customTab" : false
    },

    {
      "browser_package_name": "com.microsoft.emmx",
      "browser_signature_hashes": [
        "Ivy-R...A6fVQ=="
      ],
      "browser_use_customTab" : false
    },

    {
      "browser_package_name": "com.opera.browser",
      "browser_signature_hashes": [
        "FIJ3I...jWJWw=="
      ],
      "browser_use_customTab" : false
    },

    {
      "browser_package_name": "com.opera.mini.native",
      "browser_signature_hashes": [
        "TOTyH...mmUYQ=="
      ],
      "browser_use_customTab" : false
    },

    {
      "browser_package_name": "mobi.mgeek.TunnyBrowser",
      "browser_signature_hashes": [
        "RMVoX...bkyyQ=="
      ],
      "browser_use_customTab" : false
    },

    {
      "browser_package_name": "org.mozilla.focus",
      "browser_signature_hashes": [
        "L72dT...q0oYA=="
      ],
      "browser_use_customTab" : false
    }
  ]
}

Пример базовой конфигурации

В следующем примере показана базовая конфигурация, указывающая идентификатор клиента, URI перенаправления, зарегистрирован ли перенаправление брокера и список центров.

{
  "client_id" : "00001111-aaaa-2222-bbbb-3333cccc4444",
  "redirect_uri" : "msauth://com.microsoft.identity.client.sample.local/1wIqXSqBj7w%2Bh11ZifsnqwgyKrY%3D",
  "broker_redirect_uri_registered": true,
  "authorities" : [
    {
      "type": "AAD",
      "audience": {
        "type": "AzureADandPersonalMicrosoftAccount"
      }
      "default": true
    }
  ]
}

Использование файла конфигурации

1. Создайте файл конфигурации. Рекомендуется создать пользовательский файл конфигурации в res/raw/auth_config.json. Но вы можете положить его в любом месте, что вы хотите.

2. Сообщите MSAL, где следует искать конфигурацию при создании PublicClientApplication. Рассмотрим пример.

   //On Worker Thread
   IMultipleAccountPublicClientApplication sampleApp = null; 
   sampleApp = new PublicClientApplication.createMultipleAccountPublicClientApplication(getApplicationContext(), R.raw.auth_config);