epoc32/include/authserver/aspubsubdefs.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
/*
williamr@4
     2
* Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     3
* All rights reserved.
williamr@4
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of the License "Eclipse Public License v1.0"
williamr@4
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     8
*
williamr@4
     9
* Initial Contributors:
williamr@4
    10
* Nokia Corporation - initial contribution.
williamr@4
    11
*
williamr@4
    12
* Contributors:
williamr@4
    13
*
williamr@4
    14
* Description: 
williamr@4
    15
* Authserver publish and subscribe properties.  
williamr@4
    16
*
williamr@4
    17
*/
williamr@4
    18
williamr@4
    19
williamr@4
    20
/**
williamr@4
    21
 @file  
williamr@4
    22
 @publishedAll
williamr@4
    23
 @released
williamr@4
    24
*/
williamr@4
    25
williamr@4
    26
#ifndef ASPUBSUBDEFS_H
williamr@4
    27
#define ASPUBSUBDEFS_H
williamr@4
    28
williamr@4
    29
namespace AuthServer
williamr@4
    30
{
williamr@4
    31
/**
williamr@4
    32
 * Used to write to and read from the publish and subscribe property
williamr@4
    33
 * KUidAuthServerLastAuth. 
williamr@4
    34
 *
williamr@4
    35
 * @see KUidAuthServerLastAuth
williamr@4
    36
 **/
williamr@4
    37
NONSHARABLE_STRUCT(TLastAuth)
williamr@4
    38
	{
williamr@4
    39
	TLastAuth() { Mem::FillZ(this, sizeof(TLastAuth)); }
williamr@4
    40
	/// The identities id number or KUnknownIdentity
williamr@4
    41
	TIdentityId iId;
williamr@4
    42
	/// The time of the authentication, 0 if unknown 
williamr@4
    43
	TTime       iAuthTime;
williamr@4
    44
	/// The highest number of combinations of the authentication methods
williamr@4
    45
	/// used
williamr@4
    46
	TEntropy    iMaxCombinations;
williamr@4
    47
	/// the lowest false positive rate of the methods used
williamr@4
    48
	TPercentage iFalsePositiveRate;
williamr@4
    49
	/// the lowest false negative rate of the methods used
williamr@4
    50
	TPercentage iFalseNegativeRate;
williamr@4
    51
	/// the number of factors (i.e. plugins) combined to make the
williamr@4
    52
	/// authentication
williamr@4
    53
	TInt32      iNumFactors;
williamr@4
    54
	};
williamr@4
    55
williamr@4
    56
/**
williamr@4
    57
 * This is the publish and subscribe property used by the Authentication
williamr@4
    58
 * Server to publish the details of the last authentication. The
williamr@4
    59
 * value is of type TLastAuth and can be retrieved using code such as:
williamr@4
    60
 * <code>
williamr@4
    61
 * TLastAuth lastAuth;
williamr@4
    62
 * TPckg<TLastAuth> authPkg(lastAuth);
williamr@4
    63
 * RProperty::Get(KAuthServerSecureId, KUidAuthServerLastAuth, authPkg);
williamr@4
    64
 * </code>
williamr@4
    65
 *
williamr@4
    66
 * The property is published each time an authentication or deauthentication
williamr@4
    67
 * is made, even if the same identity is authenticated. To be notified only
williamr@4
    68
 * when the identity changes, subscribe to KUidAuthServerAuthChangeEvent.
williamr@4
    69
 *
williamr@4
    70
 */
williamr@4
    71
const TUint KUidAuthServerLastAuth = { 0x10281843 };
williamr@4
    72
williamr@4
    73
williamr@4
    74
/**
williamr@4
    75
 * This is the publish and subscribe property used by the Authentication
williamr@4
    76
 * Server to notify subscribers of a change of authenticated identity.  The
williamr@4
    77
 * published value is of type TUint and will contain the id number of the last
williamr@4
    78
 * identity authenticated.
williamr@4
    79
 *
williamr@4
    80
 * The property is published only when the identity changes, reauthentication
williamr@4
    81
 * with a different method will not result in notification.
williamr@4
    82
 *
williamr@4
    83
 */
williamr@4
    84
const TUint KUidAuthServerAuthChangeEvent = { 0x10281845 };
williamr@4
    85
williamr@4
    86
}
williamr@4
    87
williamr@4
    88
#endif /*ASPUBSUBDEFS_H*/
williamr@4
    89