private async Task RunAsync()
{
// Do the background task activity. First, get the authentication context.
Debug.WriteLine("Getting event details");
if (!HotspotAuthenticationContext.TryGetAuthenticationContext(_details.EventToken, out _context))
{
// The event is not targetting this application. There is no further processing to do.
Debug.WriteLine("Failed to get event context");
return;
}
byte[] ssid = _context.WirelessNetworkId;
Debug.WriteLine("SSID: " + System.Text.UTF8Encoding.UTF8.GetString(ssid, 0, ssid.Length));
if (ConfigStore.UseNativeWISPr)
{
// Following code can be used if using native WISPr implementation. Please note that
// following HotspotAuthenticationContext properties only work on windows and not on windows phone.
// On Windows Phone they return un-useful strings
// Developers are expected to implement their own WISPr implementation on Phone
Debug.WriteLine("AuthenticationUrl: " + _context.AuthenticationUrl.OriginalString);
Debug.WriteLine("RedirectMessageUrl: " + _context.RedirectMessageUrl.OriginalString);
Debug.WriteLine("RedirectMessageXml: " + _context.RedirectMessageXml.GetXml());
// In this sample, the AuthenticationUrl is always checked in the background task handler
// to avoid launching the foreground app in case the authentication host is not trusted.
if (ConfigStore.AuthenticationHost != _context.AuthenticationUrl.Host)
{
// Hotspot is not using the trusted authentication server.
// Abort authentication and disconnect.
Debug.WriteLine("Authentication server is untrusted");
_context.AbortAuthentication(ConfigStore.MarkAsManualConnect);
return;
}
}
// Run the appropriate scenario selected by the foreground app.
if (ConfigStore.AuthenticateThroughBackgroundTask)
{
await AuthenticateInBackgroundAsync();
}
else
{
ContinueAuthenticationInForeground();
}
return;
}
/// <summary>
/// Query authentication token from application storage and upate the UI.
/// The token gets passed from the background task handler.
/// </summary>
private void InitializeForegroundAppAuthentication()
{
string token = ConfigStore.AuthenticationToken;
if (token == "")
{
return; // no token found
}
if (!HotspotAuthenticationContext.TryGetAuthenticationContext(token, out authenticationContext))
{
rootPage.NotifyUser("TryGetAuthenticationContext failed", NotifyType.ErrorMessage);
return;
}
AuthenticateButton.IsEnabled = true;
SkipButton.IsEnabled = true;
AbortButton.IsEnabled = true;
}
// The Run method is the entry point of a background task.
public async void Run(IBackgroundTaskInstance taskInstance)
{
Debug.WriteLine("Background " + taskInstance.Task.Name + " starting...");
// Associate a cancelation handler with the background task for handlers
// that may take a considerable time to complete.
taskInstance.Canceled += new BackgroundTaskCanceledEventHandler(OnCanceled);
// Do the background task activity. First, get the authentication context.
Debug.WriteLine("Getting event details");
var details = taskInstance.TriggerDetails as HotspotAuthenticationEventDetails;
HotspotAuthenticationContext context;
if (!HotspotAuthenticationContext.TryGetAuthenticationContext(details.EventToken, out context))
{
// The event is not targetting this application. There is no further processing to do.
Debug.WriteLine("Failed to get event context");
return;
}
byte[] ssid = context.WirelessNetworkId;
Debug.WriteLine("SSID: " + System.Text.UTF8Encoding.UTF8.GetString(ssid, 0, ssid.Length));
// Get configuration from application storage.
bool markAsManualConnect = ConfigStore.MarkAsManualConnect;
if (ConfigStore.UseNativeWISPr)
{
// Following code can be used if using native WISPr implementation. Please note that
// following HotspotAuthenticationContext properties only work on windows and not on windows phone.
// On Windows Phone they return un-useful strings
// Developers are expected to implement their own WISPr implementation on Phone
Debug.WriteLine("AuthenticationUrl: " + context.AuthenticationUrl.OriginalString);
Debug.WriteLine("RedirectMessageUrl: " + context.RedirectMessageUrl.OriginalString);
Debug.WriteLine("RedirectMessageXml: " + context.RedirectMessageXml.GetXml());
// In this sample, the AuthenticationUrl is always checked in the background task handler
// to avoid launching the foreground app in case the authentication host is not trusted.
if (ConfigStore.AuthenticationHost != context.AuthenticationUrl.Host)
{
// Hotspot is not using the trusted authentication server.
// Abort authentication and disconnect.
Debug.WriteLine("Authentication server is untrusted");
context.AbortAuthentication(markAsManualConnect);
return;
}
}
// Check if authentication is handled by foreground app.
if (!ConfigStore.AuthenticateThroughBackgroundTask)
{
Debug.WriteLine("Triggering foreground application");
// Pass event token to application
ConfigStore.AuthenticationToken = details.EventToken;
// Trigger notification
// Since TriggerAttentionRequired function throws NotImplementedException on phone we will be using
// regular Toast Notification to notify user about the authentication, Tapping on the notification will
// launch the application where user can complete the authentication
if (ConfigStore.UseNativeWISPr)
{
context.TriggerAttentionRequired(_foregroundAppId, "");
}
else
{
var toastXml = ToastNotificationManager.GetTemplateContent(ToastTemplateType.ToastText01);
toastXml.GetElementsByTagName("text")[0].AppendChild(toastXml.CreateTextNode("Auth by foreground"));
IXmlNode toastNode = toastXml.SelectSingleNode("/toast");
((XmlElement)toastNode).SetAttribute("launch", "AuthByForeground");
dynamic toast = new ToastNotification(toastXml);
Type typeofToastNotification = toast.GetType();
PropertyInfo tagProperty = typeofToastNotification.GetRuntimeProperty("Tag");
PropertyInfo groupProperty = typeofToastNotification.GetRuntimeProperty("Group");
if (tagProperty != null)
{
toast.Tag = "AuthByForeground";
}
if (groupProperty != null)
{
toast.Group = "HotspotAuthAPI";
}
var notification = ToastNotificationManager.CreateToastNotifier();
notification.Show(toast);
}
return;
}
// Handle authentication in background task.
// In case this handler performs more complex tasks, it may get canceled at runtime.
// Check if task was canceled by now.
if (_cancelRequested)
{
// In case the task handler takes too long to generate credentials and gets canceled,
// the handler should terminate the authentication by aborting it
Debug.WriteLine("Aborting authentication");
context.AbortAuthentication(markAsManualConnect);
return;
}
// Before calling an asynchronous API from the background task,
// get the deferral object from the task instance.
_deferral = taskInstance.GetDeferral();
if (ConfigStore.UseNativeWISPr)
{
// The most common way of handling an authentication attempt is by providing WISPr credentials
// through the IssueCredentialsAsync API.
// If the task doesn't take any actions for authentication failures, it can use the
// IssueCredentials API to just provide credenstials.
// Alternatively, an application could run its own business logic to authentication with the
// hotspot. In this case it should call the SkipAuthentication API. Note that it should call
// SkipAuthentication after it has authenticated to allow Windows to refresh the network connectivity
// state instantly.
Debug.WriteLine("Issuing credentials");
HotspotCredentialsAuthenticationResult result = await context.IssueCredentialsAsync(
ConfigStore.UserName, ConfigStore.Password, ConfigStore.ExtraParameters, ConfigStore.MarkAsManualConnect);
if (result.ResponseCode == HotspotAuthenticationResponseCode.LoginSucceeded)
{
Debug.WriteLine("Issuing credentials succeeded");
Uri logoffUrl = result.LogoffUrl;
if (logoffUrl != null)
{
Debug.WriteLine("The logoff URL is: " + logoffUrl.OriginalString);
}
}
else
{
Debug.WriteLine("Issuing credentials failed");
}
}
else
{
//TODO: Please perform any authentication that is required by your particular scenario
// Finally call SkipAuthentication to indicate that we are not doing native WISPr authentication
// This call also serves the purpose of indicating a successful authentication.
context.SkipAuthentication();
}
_deferral.Complete();
Debug.WriteLine("Background " + taskInstance.Task.Name + " completed");
}
// The Run method is the entry point of a background task.
public async void Run(IBackgroundTaskInstance taskInstance)
{
Debug.WriteLine("Background " + taskInstance.Task.Name + " starting...");
// Associate a cancelation handler with the background task for handlers
// that may take a considerable time to complete.
taskInstance.Canceled += new BackgroundTaskCanceledEventHandler(OnCanceled);
// Do the background task activity. First, get the authentication context.
Debug.WriteLine("Getting event details");
var details = taskInstance.TriggerDetails as HotspotAuthenticationEventDetails;
HotspotAuthenticationContext context;
if (!HotspotAuthenticationContext.TryGetAuthenticationContext(details.EventToken, out context))
{
// The event is not targetting this application. There is no further processing to do.
Debug.WriteLine("Failed to get event context");
return;
}
byte[] ssid = context.WirelessNetworkId;
Debug.WriteLine("SSID: " + System.Text.UTF8Encoding.UTF8.GetString(ssid, 0, ssid.Length));
Debug.WriteLine("AuthenticationUrl: " + context.AuthenticationUrl.OriginalString);
Debug.WriteLine("RedirectMessageUrl: " + context.RedirectMessageUrl.OriginalString);
Debug.WriteLine("RedirectMessageXml: " + context.RedirectMessageXml.GetXml());
// Get configuration from application storage.
bool markAsManualConnect = ConfigStore.MarkAsManualConnect;
// In this sample, the AuthenticationUrl is always checked in the background task handler
// to avoid launching the foreground app in case the authentication host is not trusted.
if (ConfigStore.AuthenticationHost != context.AuthenticationUrl.Host)
{
// Hotspot is not using the trusted authentication server.
// Abort authentication and disconnect.
Debug.WriteLine("Authentication server is untrusted");
context.AbortAuthentication(markAsManualConnect);
return;
}
// Check if authentication is handled by foreground app.
if (!ConfigStore.AuthenticateThroughBackgroundTask)
{
Debug.WriteLine("Triggering foreground application");
// Pass event token to application
ConfigStore.AuthenticationToken = details.EventToken;
// Trigger application
context.TriggerAttentionRequired(_foregroundAppId, "");
return;
}
// Handle authentication in background task.
// In case this handler performs more complex tasks, it may get canceled at runtime.
// Check if task was canceled by now.
if (_cancelRequested)
{
// In case the task handler takes too long to generate credentials and gets canceled,
// the handler should terminate the authentication by aborting it
Debug.WriteLine("Aborting authentication");
context.AbortAuthentication(markAsManualConnect);
return;
}
// Before calling an asynchronous API from the background task,
// get the deferral object from the task instance.
_deferral = taskInstance.GetDeferral();
// The most common way of handling an authentication attempt is by providing WISPr credentials
// through the IssueCredentialsAsync API.
// If the task doesn't take any actions for authentication failures, it can use the
// IssueCredentials API to just provide credenstials.
// Alternatively, an application could run its own business logic to authentication with the
// hotspot. In this case it should call the SkipAuthentication API. Note that it should call
// SkipAuthentication after it has authenticated to allow Windows to refresh the network connectivity
// state instantly.
Debug.WriteLine("Issuing credentials");
HotspotCredentialsAuthenticationResult result = await context.IssueCredentialsAsync(
ConfigStore.UserName, ConfigStore.Password, ConfigStore.ExtraParameters, ConfigStore.MarkAsManualConnect);
if (result.ResponseCode == HotspotAuthenticationResponseCode.LoginSucceeded)
{
Debug.WriteLine("Issuing credentials succeeded");
Uri logoffUrl = result.LogoffUrl;
if (logoffUrl != null)
{
Debug.WriteLine("The logoff URL is: " + logoffUrl.OriginalString);
}
}
else
{
Debug.WriteLine("Issuing credentials failed");
}
_deferral.Complete();
Debug.WriteLine("Background " + taskInstance.Task.Name + " completed");
}
// The Run method is the entry point of a background task.
public void Run(IBackgroundTaskInstance taskInstance)
{
Debug.WriteLine("Background " + taskInstance.Task.Name + " starting...");
// Associate a cancelation handler with the background task for handlers
// that may take a considerable time to complete.
taskInstance.Canceled += new BackgroundTaskCanceledEventHandler(OnCanceled);
// Do the background task activity. First, get the authentication context.
Debug.WriteLine("Getting event details");
var details = taskInstance.TriggerDetails as HotspotAuthenticationEventDetails;
HotspotAuthenticationContext context;
if (!HotspotAuthenticationContext.TryGetAuthenticationContext(details.EventToken, out context))
{
// The event is not targetting this application. There is no further processing to do.
Debug.WriteLine("Failed to get event context");
return;
}
// If the event targets this application, the event handler must ensure that it always
// handles the event even in case of an internal error.
// A try-catch block can be used to handle unexpected errors.
// Default value in case the configuration cannot be loaded.
bool markAsManualConnect = false;
bool handleUnexpectedError = false;
try
{
byte[] ssid = context.WirelessNetworkId;
Debug.WriteLine("SSID: " + System.Text.UTF8Encoding.UTF8.GetString(ssid, 0, ssid.Length));
Debug.WriteLine("AuthenticationUrl: " + context.AuthenticationUrl.OriginalString);
Debug.WriteLine("RedirectMessageUrl: " + context.RedirectMessageUrl.OriginalString);
Debug.WriteLine("RedirectMessageXml: " + context.RedirectMessageXml.GetXml());
// Get configuration from application storage.
markAsManualConnect = ConfigStore.MarkAsManualConnect;
// In this sample, the AuthenticationUrl is always checked in the background task handler
// to avoid launching the foreground app in case the authentication host is not trusted.
if (ConfigStore.AuthenticationHost != context.AuthenticationUrl.Host)
{
// Hotspot is not using the trusted authentication server.
// Abort authentication and disconnect.
Debug.WriteLine("Authentication server is untrusted");
context.AbortAuthentication(markAsManualConnect);
return;
}
// Check if authentication is handled by foreground app.
if (!ConfigStore.AuthenticateThroughBackgroundTask)
{
Debug.WriteLine("Triggering foreground application");
// Pass event token to application
ConfigStore.AuthenticationToken = details.EventToken;
// Trigger application
context.TriggerAttentionRequired(_foregroundAppId, "");
return;
}
// Handle authentication in background task.
// In case this handler performs more complex tasks, it may get canceled at runtime.
// Check if task was canceled by now.
if (_cancelRequested)
{
// In case the task handler takes too long to generate credentials and gets canceled,
// the handler should terminate the authentication by aborting it
Debug.WriteLine("Aborting authentication");
context.AbortAuthentication(markAsManualConnect);
}
else
{
// The most common way of handling an authentication attempts is by providing WISPr credentials
// through the IssueCredentials API.
// Alternatively, an application could run its own business logic to authentication with the
// hotspot. In this case it should call the SkipAuthentication API. Note that it should call
// SkipAuthentication after it has authenticated to allow Windows to refresh the network connectivity
// state instantly.
Debug.WriteLine("Issuing credentials");
context.IssueCredentials(ConfigStore.UserName, ConfigStore.Password, ConfigStore.ExtraParameters, markAsManualConnect);
}
}
catch (Exception e)
{
Debug.WriteLine("Unhandled expection: " + e.ToString());
handleUnexpectedError = true;
}
// The background task handler should always handle the authentication context.
if (handleUnexpectedError)
{
try
{
context.AbortAuthentication(markAsManualConnect);
}
catch (Exception e)
{
Debug.WriteLine("Unhandled expection: " + e.ToString());
}
}
Debug.WriteLine("Background " + taskInstance.Task.Name + " completed");
}
