1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/security/cryptomgmtlibs/securitycommonutils/inc/scscommon.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,243 @@
1.4 +/*
1.5 +* Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of the License "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +* Information shared between SCS client and server implementations,
1.19 +* and with the subclass implementations, but not with the client API user.
1.20 +*
1.21 +*/
1.22 +
1.23 +
1.24 +/**
1.25 + @file
1.26 + @internalTechnology
1.27 + @released
1.28 +*/
1.29 +
1.30 +#ifndef SCSCOMMON_H
1.31 +#define SCSCOMMON_H
1.32 +
1.33 +#include <e32std.h>
1.34 +
1.35 +#ifndef BULLSEYE_OFF
1.36 +#ifdef _BullseyeCoverage
1.37 +#define BULLSEYE_OFF "BullseyeCoverage save off";
1.38 +#define BULLSEYE_RESTORE "BullseyeCoverage restore";
1.39 +#else
1.40 +#define BULLSEYE_OFF
1.41 +#define BULLSEYE_RESTORE
1.42 +#endif
1.43 +#endif
1.44 +
1.45 +namespace ScsImpl
1.46 + {
1.47 + /**
1.48 + Bit position of SCS code in function code.
1.49 +
1.50 + Do not change - Some of the codes based off this definition
1.51 + ARE public.
1.52 + */
1.53 + const TInt KScsFunctionPos = 24;
1.54 +
1.55 + /**
1.56 + Mask used to extract SCS commands.
1.57 +
1.58 + Do not change - Some of the codes based off this definition
1.59 + ARE public.
1.60 + */
1.61 + const TInt KScsFunctionMask = 0xFF000000;
1.62 +
1.63 + enum TScsFunction
1.64 + /**
1.65 + Bits 31:24 of the function code are reserved for SCS fields.
1.66 + The values below should be or'd into the code that is sent to
1.67 + the server, on the client side.
1.68 +
1.69 + The recognized values intentionally exclude zero, to ensure
1.70 + that a field is added on the client side.
1.71 + */
1.72 + {
1.73 + /**
1.74 + Function should be handled by session's DoServiceL.
1.75 +
1.76 + This value is effectively PUBLIC because the range used is
1.77 + described by defines in scsserver.h (used for configuring
1.78 + server security).
1.79 + */
1.80 + ECallSessionFunc = 1 << KScsFunctionPos,
1.81 +
1.82 + /**
1.83 + The SCS sends the lower bits of the function code to the subsession's
1.84 + (not the session's) ServiceL implementation.
1.85 +
1.86 + The session's implementation of [Do]ServiceL is not involved.
1.87 +
1.88 + This value is effectively PUBLIC because the range used is
1.89 + described by defines in scsserver.h (used for configuring
1.90 + server security).
1.91 + */
1.92 + ECallSubsessionFunc = 2 << KScsFunctionPos,
1.93 +
1.94 + /**
1.95 + This message is send with no function identifier or
1.96 + IPC arguments just before the session is closed. Although
1.97 + not necessary, it will cancel any outstanding requests on
1.98 + the session or its subsessions with KErrCancel, so if the
1.99 + client has any outstanding requests they will still get
1.100 + completed.
1.101 + */
1.102 + EPreCloseSession = 3 << KScsFunctionPos,
1.103 +
1.104 + /**
1.105 + Cancel an asynchronous session-relative function. The low
1.106 + bits of the function code should be the same as the original
1.107 + function code. E.g. if the function was set up with
1.108 + ENoScsFunction | X then it would be cancelled with ECancelSessionFunction | X.
1.109 +
1.110 + The session's implementation of [Do]ServiceL is not involved.
1.111 + */
1.112 + ECancelSessionFunc = 4 << KScsFunctionPos,
1.113 +
1.114 + /**
1.115 + Tells the server that this function will create a new subsession.
1.116 + The low bits can be interpreted by the implementation to indicate
1.117 + a type of subsession.
1.118 + */
1.119 + ECreateSubsession = 5 << KScsFunctionPos,
1.120 + /**
1.121 + This SCS code should be used on its own. Any information in the
1.122 + lower bits will be ignored.
1.123 + */
1.124 + ECloseSubsession = 6 << KScsFunctionPos,
1.125 +
1.126 + /**
1.127 + Similar to ECancelSessionFunction, this cancels an asynchronous
1.128 + request on a subsession object. The request will be completed with
1.129 + KErrCancel.
1.130 +
1.131 + The subsession's implementation of ServiceL is not involved.
1.132 +
1.133 + @see ECancelSessionFunction
1.134 + */
1.135 + ECancelSubsessionFunc = 7 << KScsFunctionPos,
1.136 +
1.137 + /**
1.138 + Only supported in debug builds, this function starts a server-side
1.139 + heap mark with __UHEAP_MARK and sets a deterministic failure rate.
1.140 + This function should only be used by RScsClientBase::SetServerHeapFail.
1.141 +
1.142 + @see EUHeapResetFail
1.143 + @see RScsClientBase::SetServerHeapFail
1.144 + */
1.145 + EUHeapSetFail = 8 << KScsFunctionPos,
1.146 +
1.147 + /**
1.148 + Only supported in debug builds, this function ends the server-side
1.149 + heap mark set up with EUHeapSetFail, with __UHEAP_MARKEND, and resets
1.150 + the heap failure rate. This function should only be used by
1.151 + RScsClientBase::ResetServerHeapFail.
1.152 +
1.153 + @see EUHeapSetFail
1.154 + @see RScsClientBase::ResetServerHeapFail
1.155 + */
1.156 + EUHeapResetFail = 9 << KScsFunctionPos,
1.157 +
1.158 + /**
1.159 + Intended for debug use, but also present in production builds.
1.160 +
1.161 + Returns the PID of the server. This is a number, not a
1.162 + handle, so does not impact security.
1.163 +
1.164 + */
1.165 + EGetServerPid = 10 << KScsFunctionPos,
1.166 +
1.167 + /**
1.168 + Intended for debug use, but also present in production builds.
1.169 +
1.170 + This call causes a server which has an inactivity shutdown
1.171 + timer to shutdown immediately the next time it is
1.172 + idle. This is just adjusts the timing of existing
1.173 + functionality, so is not believed to impact security.
1.174 +
1.175 + If the server has a shutdown timer, then a flag is set
1.176 + which causes the server to immediately exit the next time
1.177 + it becomes idle.
1.178 +
1.179 + If the server does not have a shutdown timer, then the
1.180 + calls fails with KErrNotSupported.
1.181 + */
1.182 + EShutdownAsap = 11 << KScsFunctionPos,
1.183 +
1.184 + /**
1.185 + This value is not used by the server implementation. It is provided
1.186 + for test code to confirm the server handles an uncrecognized instruction
1.187 + correctly, by failing with KErrNotSupported.
1.188 + */
1.189 + EScsUnused = 0x20 << KScsFunctionPos
1.190 + };
1.191 +
1.192 + inline void ExtractScsAndImplFunctions(const RMessage2& aMessage, TScsFunction* aScsFunc, TInt* aImplFunc);
1.193 + inline TBool ScsFieldUsed(TInt aFunction);
1.194 +
1.195 + /**
1.196 + SCS clients are panicked with this category when invalid
1.197 + input to the server is detected.
1.198 +
1.199 + @see TClientPanic
1.200 + */
1.201 + _LIT(KScsClientPanicCat, "SCS-Client");
1.202 +
1.203 + enum TScsClientPanic
1.204 + /**
1.205 + Reasons why the SCS server might panic its clients.
1.206 +
1.207 + @see KScsClientPanicCat
1.208 + */
1.209 + {
1.210 + EScsClBadDesc = 0, ///< Client provided a bad descriptor as an IPC argument.
1.211 + EScsClBadHandle = 1, ///< Client passed a bad subsession handle.
1.212 + EScsClAsyncAlreadyQueued = 2, ///< Client attempted to requeue an outstanding request.
1.213 +
1.214 + /** No-arg session-relative function identifier used reserved SCS bits. */
1.215 + EScsClNoArgsSessUsedScs = 4,
1.216 +
1.217 + /** Arg session-relative function identifier used reserved SCS bits. */
1.218 + EScsClArgsSessUsedScs = 5,
1.219 +
1.220 + /** Arg session-relative async function identifier used reserved SCS bits. */
1.221 + EScsClArgsSessAsyncUsedScs = 6,
1.222 +
1.223 + /** Session-relative cancel function identifier used reserved SCS bits. */
1.224 + EScsClCancelSessUsedScs = 7,
1.225 +
1.226 + /** No-arg subsession-relative function identifier used reserved SCS bits. */
1.227 + EScsClNoArgsSubsessUsedScs = 16,
1.228 +
1.229 + /** Arg subsession-relative function identifier used reserved SCS bits. */
1.230 + EScsClArgsSubsessUsedScs = 17,
1.231 +
1.232 + /** Arg subsession-relative async function identifier used reserved SCS bits. */
1.233 + EScsClArgsSubsessAsyncUsedScs = 18,
1.234 +
1.235 + /* Subsesion-relative cancel function identifier used reserved SCS bits. */
1.236 + EScsClCancelSubsessUsedScs = 19
1.237 + };
1.238 +
1.239 + // defined only in client-side implementation
1.240 + void ClientSidePanic(ScsImpl::TScsClientPanic aReason);
1.241 + } // namespace ScsImpl
1.242 +
1.243 +#include <scs/scscommon.inl>
1.244 +
1.245 +#endif // #ifndef SCSCOMMON_H
1.246 +