/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ /* * Copyright © 2019 Vilém Hořínek * Copyright © 2022-2024 Jan-Michael Brummer * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General * Public License along with this library; if not, see . */ #include "config.h" #include #include #include #include "goaauthflowbutton.h" #include "goaprovider.h" #include "goaproviderdialog.h" #include "goaprovider-priv.h" #include "goamsgraphprovider.h" #include "goarestproxy.h" #include "goaobjectskeletonutils.h" #include "goautils.h" struct _GoaMsGraphProvider { GoaOAuth2Provider parent_instance; gboolean setup_done; char *client_id; char *redirect_uri; char *authorization_uri; char *token_uri; }; G_DEFINE_TYPE_WITH_CODE (GoaMsGraphProvider, goa_ms_graph_provider, GOA_TYPE_OAUTH2_PROVIDER, goa_provider_ensure_extension_points_registered (); g_io_extension_point_implement (GOA_PROVIDER_EXTENSION_POINT_NAME, g_define_type_id, GOA_MS_GRAPH_NAME, 0)); /* -------------------------------------------------------------------------- */ static const gchar * get_provider_type (GoaProvider *provider) { return GOA_MS_GRAPH_NAME; } static gchar * get_provider_name (GoaProvider *provider, GoaObject *object) { return g_strdup (_("Microsoft 365")); } static GIcon * get_provider_icon (GoaProvider *provider, GoaObject *object) { return g_themed_icon_new_with_default_fallbacks ("goa-account-ms365"); } static GoaProviderGroup get_provider_group (GoaProvider *provider) { return GOA_PROVIDER_GROUP_BRANDED; } static GoaProviderFeatures get_provider_features (GoaProvider *provider) { return GOA_PROVIDER_FEATURE_BRANDED | GOA_PROVIDER_FEATURE_MAIL | GOA_PROVIDER_FEATURE_CALENDAR | GOA_PROVIDER_FEATURE_CONTACTS | GOA_PROVIDER_FEATURE_FILES; } static const gchar * get_authorization_uri (GoaOAuth2Provider *oauth2_provider) { GoaMsGraphProvider *self = GOA_MS_GRAPH_PROVIDER (oauth2_provider); return self->authorization_uri; } static const gchar * get_token_uri (GoaOAuth2Provider *oauth2_provider) { GoaMsGraphProvider *self = GOA_MS_GRAPH_PROVIDER (oauth2_provider); return self->token_uri; } static const gchar * get_redirect_uri (GoaOAuth2Provider *oauth2_provider) { GoaMsGraphProvider *self = GOA_MS_GRAPH_PROVIDER (oauth2_provider); return self->redirect_uri; } static const gchar * get_scope (GoaOAuth2Provider *oauth2_provider) { return "offline_access" \ " calendars.readwrite" \ " calendars.readwrite.shared" \ " contacts.readwrite" \ " contacts.readwrite.shared" \ " files.readwrite" \ " files.readwrite.all" \ " mail.readwrite" \ " mail.readwrite.shared" \ " mail.send" \ " mail.send.shared" \ " mailboxsettings.read" \ " people.read" \ " sites.read.all" \ " sites.readwrite.all" \ " tasks.readwrite" \ " tasks.readwrite.shared" \ " user.read" \ " user.readbasic.all"; } static const gchar * get_client_id (GoaOAuth2Provider *oauth2_provider) { GoaMsGraphProvider *self = GOA_MS_GRAPH_PROVIDER (oauth2_provider); return self->client_id ? self->client_id : GOA_MS_GRAPH_CLIENT_ID; } static const gchar * get_client_secret (GoaOAuth2Provider *oauth2_provider) { return ""; } /* -------------------------------------------------------------------------- */ static gchar * get_identity_sync (GoaOAuth2Provider *oauth2_provider, const gchar *access_token, gchar **out_presentation_identity, GCancellable *cancellable, GError **error) { JsonParser *parser = NULL; JsonObject *json_object = NULL; JsonNode *json_member = NULL; RestProxy *proxy = NULL; RestProxyCall *call = NULL; GError *identity_error = NULL; gchar *authorization = NULL; const char *id = NULL; const char *presentation_identity = NULL; gchar *ret = NULL; authorization = g_strconcat ("Bearer ", access_token, NULL); proxy = goa_rest_proxy_new ("https://graph.microsoft.com/v1.0/me", FALSE); call = rest_proxy_new_call (proxy); rest_proxy_call_set_method (call, "GET"); rest_proxy_call_add_header (call, "Authorization", authorization); if (!goa_rest_proxy_call_sync (call, cancellable, error)) { goto out; } if (rest_proxy_call_get_status_code (call) != 200) { g_set_error (error, GOA_ERROR, GOA_ERROR_FAILED, _("Expected status 200 when requesting your identity, instead got status %d (%s)"), rest_proxy_call_get_status_code (call), rest_proxy_call_get_status_message (call)); goto out; } parser = json_parser_new (); if (!json_parser_load_from_data (parser, rest_proxy_call_get_payload (call), rest_proxy_call_get_payload_length (call), &identity_error)) { g_debug ("json_parser_load_from_data() failed: %s (%s, %d)", identity_error->message, g_quark_to_string (identity_error->domain), identity_error->code); g_set_error (error, GOA_ERROR, GOA_ERROR_FAILED, _("Could not parse response")); goto out; } json_member = json_parser_get_root (parser); if (json_member == NULL || !JSON_NODE_HOLDS_OBJECT (json_member)) { g_debug ("%s(): expected root node to be an object", G_STRFUNC); g_set_error (error, GOA_ERROR, GOA_ERROR_FAILED, _("Could not parse response")); goto out; } json_object = json_node_get_object (json_member); // Prefer "userPrincipalName" then "mail", failing if neither is available, since Gvfs requires // a user and host for the GMountSpec json_member = json_object_get_member (json_object, "userPrincipalName"); if (json_member != NULL && json_node_get_value_type (json_member) == G_TYPE_STRING) { presentation_identity = json_node_get_string (json_member); } // Use the "mail" field as the "Identity" json_member = json_object_get_member (json_object, "mail"); if (json_member != NULL && json_node_get_value_type (json_member) == G_TYPE_STRING) { if (presentation_identity == NULL) { presentation_identity = json_node_get_string (json_member); } id = json_node_get_string (json_member); } if (!presentation_identity || !id) { g_debug ("%s(): expected \"userPrincipalName\" and \"mail\" field holding a string", G_STRFUNC); g_set_error (error, GOA_ERROR, GOA_ERROR_FAILED, _("Could not parse response")); goto out; } ret = g_strdup (id); if (out_presentation_identity != NULL) { *out_presentation_identity = g_strdup (presentation_identity); } out: g_clear_object (&parser); g_clear_error (&identity_error); g_clear_object (&call); g_clear_object (&proxy); g_free (authorization); return ret; } static gboolean build_object (GoaProvider *provider, GoaObjectSkeleton *object, GKeyFile *key_file, const gchar *group, GDBusConnection *connection, gboolean just_added, GError **error) { GoaMsGraphProvider *self = GOA_MS_GRAPH_PROVIDER (provider); GoaAccount *account = NULL; GKeyFile *goa_conf; GoaMail *mail = NULL; const gchar *provider_type; const gchar *identity = NULL; const gchar *presentation_identity = NULL; gboolean files_enabled = FALSE; gboolean calendar_enabled; gboolean contacts_enabled; gboolean mail_enabled; gchar *uri_onedrive = NULL; gboolean ret = FALSE; if (!GOA_PROVIDER_CLASS (goa_ms_graph_provider_parent_class)->build_object (provider, object, key_file, group, connection, just_added, error)) goto out; provider_type = goa_provider_get_provider_type (provider); goa_conf = goa_util_open_goa_conf (); account = goa_object_get_account (GOA_OBJECT (object)); identity = goa_account_get_identity (account); presentation_identity = goa_account_get_presentation_identity (account); /* Files */ files_enabled = goa_util_provider_feature_is_enabled (goa_conf, provider_type, GOA_PROVIDER_FEATURE_FILES) && g_key_file_get_boolean (key_file, group, "FilesEnabled", NULL); uri_onedrive = g_strconcat ("onedrive://", identity, "/", NULL); goa_object_skeleton_attach_files (object, uri_onedrive, files_enabled, FALSE); g_free (uri_onedrive); /* Email */ mail = goa_object_get_mail (GOA_OBJECT (object)); mail_enabled = goa_util_provider_feature_is_enabled (goa_conf, provider_type, GOA_PROVIDER_FEATURE_MAIL) && g_key_file_get_boolean (key_file, group, "MailEnabled", NULL); if (mail_enabled) { if (mail == NULL) { mail = goa_mail_skeleton_new (); g_object_set (G_OBJECT (mail), "email-address", identity, NULL); g_object_set (G_OBJECT (mail), "name", presentation_identity, NULL); goa_object_skeleton_set_mail (object, mail); } } else { if (mail != NULL) goa_object_skeleton_set_mail (object, NULL); } /* Calendar */ calendar_enabled = goa_util_provider_feature_is_enabled (goa_conf, provider_type, GOA_PROVIDER_FEATURE_CALENDAR) && g_key_file_get_boolean (key_file, group, "CalendarEnabled", NULL); goa_object_skeleton_attach_calendar (object, NULL, calendar_enabled, FALSE); /* Contacts */ contacts_enabled = goa_util_provider_feature_is_enabled (goa_conf, provider_type, GOA_PROVIDER_FEATURE_CONTACTS) && g_key_file_get_boolean (key_file, group, "ContactsEnabled", NULL); goa_object_skeleton_attach_contacts (object, NULL, contacts_enabled, FALSE); g_clear_pointer (&goa_conf, g_key_file_free); self->client_id = g_key_file_get_string (key_file, group, "client_id", NULL); self->redirect_uri = g_key_file_get_string (key_file, group, "redirect_uri", NULL); self->authorization_uri = g_key_file_get_string (key_file, group, "authorization_uri", NULL); self->token_uri = g_key_file_get_string (key_file, group, "token_uri", NULL); if (just_added) { goa_account_set_files_disabled (account, !files_enabled); goa_account_set_mail_disabled (account, !mail_enabled); goa_account_set_calendar_disabled (account, !calendar_enabled); goa_account_set_contacts_disabled (account, !contacts_enabled); g_signal_connect (account, "notify::files-disabled", G_CALLBACK (goa_util_account_notify_property_cb), (gpointer) "FilesEnabled"); g_signal_connect (account, "notify::mail-disabled", G_CALLBACK (goa_util_account_notify_property_cb), (gpointer) "MailEnabled"); g_signal_connect (account, "notify::calendar-disabled", G_CALLBACK (goa_util_account_notify_property_cb), (gpointer) "CalendarEnabled"); g_signal_connect (account, "notify::contacts-disabled", G_CALLBACK (goa_util_account_notify_property_cb), (gpointer) "ContactsEnabled"); } ret = TRUE; out: g_clear_object (&mail); g_clear_object (&account); return ret; } static void add_account_key_values (GoaOAuth2Provider *provider, GVariantBuilder *builder) { g_assert (GOA_IS_MS_GRAPH_PROVIDER (provider)); g_assert (builder != NULL); g_variant_builder_add (builder, "{ss}", "FilesEnabled", "true"); g_variant_builder_add (builder, "{ss}", "MailEnabled", "true"); g_variant_builder_add (builder, "{ss}", "CalendarEnabled", "true"); g_variant_builder_add (builder, "{ss}", "ContactsEnabled", "true"); /* The class getter implementations are used, since they handle fallbacks */ g_variant_builder_add (builder, "{ss}", "OAuth2AuthorizationUri", goa_oauth2_provider_get_authorization_uri (provider)); g_variant_builder_add (builder, "{ss}", "OAuth2TokenUri", goa_oauth2_provider_get_token_uri (provider)); g_variant_builder_add (builder, "{ss}", "OAuth2ClientId", goa_oauth2_provider_get_client_id (provider)); g_variant_builder_add (builder, "{ss}", "OAuth2RedirectUri", goa_oauth2_provider_get_redirect_uri (provider)); g_variant_builder_add (builder, "{ss}", "OAuth2ClientSecret", "" /* always empty */); } /* ---------------------------------------------------------------------------------------------------- */ typedef struct { GoaProviderDialog *dialog; GoaClient *client; GoaObject *object; GtkWidget *organization_switch; GtkWidget *client_id_entry; GtkWidget *tenant_id_entry; GtkWidget *copy_button; GoaAuthFlowFlags flags; } AccountData; static void account_data_free (gpointer user_data) { AccountData *data = (AccountData *)user_data; g_clear_object (&data->client); g_clear_object (&data->object); g_free (data); } static void on_entry_changed (GtkEditable *editable, AccountData *data) { GoaDialogState state = GOA_DIALOG_READY; const char *client_id = NULL; const char *tenant_id = NULL; tenant_id = gtk_editable_get_text (GTK_EDITABLE (data->tenant_id_entry)); if (tenant_id == NULL || *tenant_id == '\0') state = GOA_DIALOG_IDLE; /* Ensure there is client ID, since there is no build-system default */ client_id = gtk_editable_get_text (GTK_EDITABLE (data->client_id_entry)); if ((client_id == NULL || *client_id == '\0') && (GOA_MS_GRAPH_CLIENT_ID == NULL || *GOA_MS_GRAPH_CLIENT_ID == '\0')) state = GOA_DIALOG_IDLE; goa_provider_dialog_set_state (data->dialog, state); } static void on_organization_changed (AdwSwitchRow *row, GParamSpec *pspec, AccountData *data) { if (adw_switch_row_get_active (row)) on_entry_changed (NULL, data); else goa_provider_dialog_set_state (data->dialog, GOA_DIALOG_READY); } static void on_copy_activated (GoaAuthflowButton *widget, AccountData *data) { data->flags |= GOA_AUTH_FLOW_DO_NOT_LAUNCH_URI; goa_provider_dialog_set_state (data->dialog, GOA_DIALOG_BUSY); goa_authflow_button_set_active (widget, TRUE); } static void on_link_activated (GoaAuthflowButton *widget, AccountData *data) { goa_provider_dialog_set_state (data->dialog, GOA_DIALOG_BUSY); goa_authflow_button_set_active (widget, TRUE); } static void create_account_details_ui (GoaProvider *provider, AccountData *data, gboolean new_account) { GoaProviderDialog *dialog = GOA_PROVIDER_DIALOG (data->dialog); if (new_account) { GtkWidget *group; GtkWidget *button; goa_provider_dialog_add_page (dialog, NULL, // provider name _("Connect to Microsoft 365 to access email, calendars, contacts and files")); group = goa_provider_dialog_add_group (dialog, NULL); data->organization_switch = g_object_new (ADW_TYPE_SWITCH_ROW, "title", _("Use Organization Account"), "subtitle", _("Connect using details from an organization or developer account"), "active", FALSE, NULL); adw_preferences_group_add (ADW_PREFERENCES_GROUP (group), data->organization_switch); group = goa_provider_dialog_add_group (dialog, NULL); /* Translators: See https://learn.microsoft.com/globalization/reference/microsoft-terminology */ adw_preferences_group_set_description (ADW_PREFERENCES_GROUP (group), _("Enter the details provided by your organization")); data->client_id_entry = goa_provider_dialog_add_entry (dialog, group, _("_Client ID (Optional)")); /* Translators: See https://learn.microsoft.com/globalization/reference/microsoft-terminology */ data->tenant_id_entry = goa_provider_dialog_add_entry (dialog, group, _("_Tenant ID")); goa_provider_dialog_add_description (dialog, data->tenant_id_entry, _("Example ID: 00000000-0000-0000-0000-000000000000")); g_object_bind_property (data->organization_switch, "active", group, "visible", G_BINDING_SYNC_CREATE); g_signal_connect (data->organization_switch, "notify::active", G_CALLBACK (on_organization_changed), data); g_signal_connect (data->client_id_entry, "changed", G_CALLBACK (on_entry_changed), data); g_signal_connect (data->tenant_id_entry, "changed", G_CALLBACK (on_entry_changed), data); on_organization_changed (ADW_SWITCH_ROW (data->organization_switch), NULL, data); /* Auth Flow */ group = goa_provider_dialog_add_group (dialog, NULL); button = goa_authflow_button_new (); gtk_widget_set_valign (button, GTK_ALIGN_END); gtk_widget_set_vexpand (button, TRUE); g_signal_connect (button, "copy-activated", G_CALLBACK (on_copy_activated), data); g_signal_connect (button, "link-activated", G_CALLBACK (on_link_activated), data); adw_preferences_group_add (ADW_PREFERENCES_GROUP (group), button); /* Set the default widget after it's a child of the window */ adw_dialog_set_default_widget (ADW_DIALOG (dialog), button); } } static void add_account_parent_cb (GoaProvider *provider, GAsyncResult *result, gpointer user_data) { g_autoptr(GTask) task = G_TASK (g_steal_pointer (&user_data)); GoaObject *object = NULL; GError *error = NULL; /* The dialog will already be in the %GOA_DIALOG_DONE state, so the task * is completed manually. */ object = goa_provider_add_account_finish (provider, result, &error); if (object != NULL) g_task_return_pointer (task, g_steal_pointer (&object), g_object_unref); else g_task_return_error (task, g_steal_pointer (&error)); } static void add_account_action_cb (GoaProviderDialog *dialog, GParamSpec *pspec, GTask *task) { GoaMsGraphProvider *self = g_task_get_source_object (task); GoaProvider *provider = g_task_get_source_object (task); AccountData *data = g_task_get_task_data (task); GCancellable *cancellable = g_task_get_cancellable (task); const char *client_id; g_autofree char *issuer = NULL; const char *tenant; char *tmp; if (goa_provider_dialog_get_state (data->dialog) != GOA_DIALOG_BUSY) return; /* The OAuth configuration is re-built for each account being added, * so when the provider chains up the parent sees the correct values. */ g_clear_pointer (&self->client_id, g_free); g_clear_pointer (&self->redirect_uri, g_free); g_clear_pointer (&self->authorization_uri, g_free); g_clear_pointer (&self->token_uri, g_free); tenant = gtk_editable_get_text (GTK_EDITABLE (data->tenant_id_entry)); issuer = strlen (tenant) == 0 ? g_strdup ("common") : g_strdup (tenant); tmp = g_uri_escape_string (issuer, NULL, TRUE); self->authorization_uri = g_strdup_printf ("https://login.microsoftonline.com/%s/oauth2/v2.0/authorize", tmp); self->token_uri = g_strdup_printf ("https://login.microsoftonline.com/%s/oauth2/v2.0/token", tmp); g_clear_pointer (&tmp, g_free); /* Check for a custom client ID, then retrieve the effective client ID */ client_id = gtk_editable_get_text (GTK_EDITABLE (data->client_id_entry)); if (client_id != NULL && *client_id != '\0') g_set_str (&self->client_id, client_id); client_id = goa_oauth2_provider_get_client_id (GOA_OAUTH2_PROVIDER (self)); self->redirect_uri = g_strdup_printf ("goa-oauth2://localhost/%s", client_id); /* With the provider configured for the client, we chain-up to authorize */ g_object_set_data (G_OBJECT (data->dialog), "goa-auth-flow-flags", GUINT_TO_POINTER (data->flags)); GOA_PROVIDER_CLASS (goa_ms_graph_provider_parent_class)->add_account (provider, data->client, GTK_WIDGET (data->dialog), cancellable, (GAsyncReadyCallback)add_account_parent_cb, g_object_ref (task)); } static void add_account (GoaProvider *provider, GoaClient *client, GtkWidget *parent, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data) { AccountData *data; g_autoptr(GTask) task = NULL; data = g_new0 (AccountData, 1); data->dialog = goa_provider_dialog_new_full (provider, client, parent, 480, 460); data->client = g_object_ref (client); task = g_task_new (provider, cancellable, callback, user_data); g_task_set_check_cancellable (task, FALSE); g_task_set_source_tag (task, add_account); g_task_set_task_data (task, data, account_data_free); create_account_details_ui (provider, data, TRUE); g_signal_connect_object (data->dialog, "notify::state", G_CALLBACK (add_account_action_cb), task, G_CONNECT_DEFAULT); goa_provider_task_run_in_dialog (task, data->dialog); // We chain-up in add_account_parent_cb() once the user input is confirmed } static gboolean get_use_pkce (GoaOAuth2Provider *oauth2_provider) { return TRUE; } /* -------------------------------------------------------------------------- */ static void goa_ms_graph_provider_init (GoaMsGraphProvider *self) { self->setup_done = FALSE; } static guint get_credentials_generation (GoaProvider *provider) { return 2; } static void goa_ms_graph_provider_class_init (GoaMsGraphProviderClass *klass) { GoaProviderClass *provider_class; GoaOAuth2ProviderClass *oauth2_class; provider_class = GOA_PROVIDER_CLASS (klass); provider_class->get_provider_type = get_provider_type; provider_class->get_provider_name = get_provider_name; provider_class->get_provider_icon = get_provider_icon; provider_class->get_provider_group = get_provider_group; provider_class->get_provider_features = get_provider_features; provider_class->build_object = build_object; provider_class->add_account = add_account; provider_class->get_credentials_generation = get_credentials_generation; oauth2_class = GOA_OAUTH2_PROVIDER_CLASS (klass); oauth2_class->get_authorization_uri = get_authorization_uri; oauth2_class->get_client_id = get_client_id; oauth2_class->get_client_secret = get_client_secret; oauth2_class->get_identity_sync = get_identity_sync; oauth2_class->get_redirect_uri = get_redirect_uri; oauth2_class->get_scope = get_scope; oauth2_class->get_use_pkce = get_use_pkce; oauth2_class->get_token_uri = get_token_uri; oauth2_class->add_account_key_values = add_account_key_values; }