Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/secureclient_8cpp_source.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: examples/Base/IPC/secureserver/secureclient.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<h1>examples/Base/IPC/secureserver/secureclient.cpp</h1><a href="secureclient_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).</span>
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
<a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
<a name="l00004"></a>00004 <span class="comment">// under the terms of &quot;Eclipse Public License v1.0&quot;</span>
<a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
<a name="l00006"></a>00006 <span class="comment">// at the URL &quot;http://www.eclipse.org/legal/epl-v10.html&quot;.</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
<a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// Description:</span>
<a name="l00014"></a>00014 <span class="comment">// This client executable has all required capabilities to modify a file.</span>
<a name="l00015"></a>00015 <span class="comment">// Demonstrates all functionalities provided by the client side interface of the server.</span>
<a name="l00016"></a>00016 <span class="comment">//</span>
<a name="l00017"></a>00017 
<a name="l00018"></a>00018 
<a name="l00019"></a>00019 
<a name="l00023"></a>00023 <span class="preprocessor">#include &quot;<a class="code" href="secureclientandserver_8h.html">secureclientandserver.h</a>&quot;</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &quot;<a class="code" href="secureclient_8h.html">secureclient.h</a>&quot;</span>
<a name="l00025"></a>00025 
<a name="l00026"></a>00026 LOCAL_D CConsoleBase* console;
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="keywordtype">void</span> DoExampleL()
<a name="l00029"></a>00029         {
<a name="l00030"></a>00030         console-&gt;Printf(KTxtTestingCountServer);
<a name="l00031"></a>00031         
<a name="l00032"></a>00032         <span class="comment">// Create a session.</span>
<a name="l00033"></a>00033         <a class="code" href="class_r_secure_session.html">RSecureSession</a> countserv;
<a name="l00034"></a>00034         User::LeaveIfError(countserv.<a class="code" href="class_r_secure_session.html#aacec76ae20ca1a96380f33b82e85b271">Connect</a>());
<a name="l00035"></a>00035         
<a name="l00036"></a>00036         <span class="comment">// Create a sub session.</span>
<a name="l00037"></a>00037         <a class="code" href="class_r_secure_sub_session.html">RSecureSubSession</a> counterA;
<a name="l00038"></a>00038         counterA.Open(countserv);
<a name="l00039"></a>00039 
<a name="l00040"></a>00040         <span class="comment">// The user can choose to initialise the counter from the counter.dat file.</span>
<a name="l00041"></a>00041         console-&gt;Printf(KTxtInitCounterAWith);
<a name="l00042"></a>00042         console-&gt;Printf(KTxtOption);
<a name="l00043"></a>00043         TUint8 inpOption = console-&gt;Getch();
<a name="l00044"></a>00044         <span class="keywordflow">if</span>(inpOption == <span class="charliteral">&#39;1&#39;</span>)
<a name="l00045"></a>00045                 {
<a name="l00046"></a>00046                 <span class="comment">// This call will fail if the client executable does not have required file read capability.</span>
<a name="l00047"></a>00047                 counterA.SetCounterFromFileL();
<a name="l00048"></a>00048                 console-&gt;Printf(KTxtInitFromFile,counterA.CounterValueL());
<a name="l00049"></a>00049                 }
<a name="l00050"></a>00050         <span class="keywordflow">else</span>
<a name="l00051"></a>00051                 {
<a name="l00052"></a>00052                 <span class="comment">// This is an invalid initialisation string. Hence, the counter will be initialised to zero.</span>
<a name="l00053"></a>00053                 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtValueString,<span class="stringliteral">&quot;a2&quot;</span>);
<a name="l00054"></a>00054                 console-&gt;Printf(KTxtValueString);
<a name="l00055"></a>00055                 <span class="comment">// Set counter from the KTxtValueString string</span>
<a name="l00056"></a>00056                 TInt err = counterA.SetFromString(KTxtValueString);
<a name="l00057"></a>00057                 <span class="keywordflow">if</span> (err == <a class="code" href="secureclientandserver_8h.html#ac31a03d737c6ab16ba55ceab73d57b71ae3a6b8e17c25d02a3ae9ca7362ba4d0c">ENonNumericString</a>)
<a name="l00058"></a>00058                         {
<a name="l00059"></a>00059                         <span class="comment">// Print an error message as the initialisation string, KTxtValueString is invalid (non numeric format).</span>
<a name="l00060"></a>00060                         console-&gt;Printf(KTxtInitCounterFailed);
<a name="l00061"></a>00061                         }
<a name="l00062"></a>00062                 <span class="keywordflow">else</span>
<a name="l00063"></a>00063                         {
<a name="l00064"></a>00064                         <span class="comment">// Initialisation from string succeeded.</span>
<a name="l00065"></a>00065                         console-&gt;Printf(KTxtInitCounterSucceeded);
<a name="l00066"></a>00066                         }
<a name="l00067"></a>00067                 }
<a name="l00068"></a>00068         <a class="code" href="class_r_secure_sub_session.html">RSecureSubSession</a> counterB;
<a name="l00069"></a>00069 
<a name="l00070"></a>00070         <span class="comment">// Create a sub session.</span>
<a name="l00071"></a>00071         counterB.<a class="code" href="class_r_secure_sub_session.html#a490095bd4d40f65ea15f14d5fe481b71">Open</a>(countserv);
<a name="l00072"></a>00072 
<a name="l00073"></a>00073         <span class="comment">// The user can choose to initialise the counter from the counter.dat file.</span>
<a name="l00074"></a>00074         console-&gt;Printf(KTxtInitCounterBWith);
<a name="l00075"></a>00075         console-&gt;Printf(KTxtOption);
<a name="l00076"></a>00076         inpOption = console-&gt;Getch();
<a name="l00077"></a>00077         <span class="keywordflow">if</span>(inpOption == <span class="charliteral">&#39;1&#39;</span>)
<a name="l00078"></a>00078                 {
<a name="l00079"></a>00079                 <span class="comment">// This call will fail if the client executable does not have required file read capability.</span>
<a name="l00080"></a>00080                 counterB.<a class="code" href="class_r_secure_sub_session.html#ab9758c1131b23ed928fadee2a959e23e">SetCounterFromFileL</a>();
<a name="l00081"></a>00081                 console-&gt;Printf(KTxtInitFromFile,counterB.<a class="code" href="class_r_secure_sub_session.html#af205b880df310c24f47ce91ca6261a1d">CounterValueL</a>());
<a name="l00082"></a>00082                 }
<a name="l00083"></a>00083         <span class="keywordflow">else</span>
<a name="l00084"></a>00084                 {
<a name="l00085"></a>00085                 <span class="comment">// A valid numeric string.</span>
<a name="l00086"></a>00086                 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtLegalString,<span class="stringliteral">&quot;100&quot;</span>);
<a name="l00087"></a>00087                 console-&gt;Printf(KTxtLegalString);
<a name="l00088"></a>00088                 <span class="comment">// Set counter from the KTxtLegalString string.</span>
<a name="l00089"></a>00089                 TInt err = counterB.<a class="code" href="class_r_secure_sub_session.html#af5aeec70e2056cbbeb64141573ff8f2c">SetFromString</a>(KTxtLegalString);
<a name="l00090"></a>00090                 <span class="keywordflow">if</span> (err == <a class="code" href="secureclientandserver_8h.html#ac31a03d737c6ab16ba55ceab73d57b71ae3a6b8e17c25d02a3ae9ca7362ba4d0c">ENonNumericString</a>)
<a name="l00091"></a>00091                         {
<a name="l00092"></a>00092                         <span class="comment">// Print an error message as the initialisation string, KTxtValueString is invalid (non numeric format).</span>
<a name="l00093"></a>00093                         console-&gt;Printf(KTxtInitCounterFailed);
<a name="l00094"></a>00094                         }
<a name="l00095"></a>00095                 <span class="keywordflow">else</span>
<a name="l00096"></a>00096                         {
<a name="l00097"></a>00097                         <span class="comment">// Initialisation from string succeeded.</span>
<a name="l00098"></a>00098                         <span class="comment">// Counter is initialised to 100.</span>
<a name="l00099"></a>00099                         console-&gt;Printf(KTxtInitCounterSucceeded);
<a name="l00100"></a>00100                         }
<a name="l00101"></a>00101                 }
<a name="l00102"></a>00102         
<a name="l00103"></a>00103         <span class="comment">// Wait for a key press.</span>
<a name="l00104"></a>00104         console-&gt;Printf(KMsgPressAnyKey);
<a name="l00105"></a>00105         console-&gt;Getch();
<a name="l00106"></a>00106         console-&gt;ClearScreen();
<a name="l00107"></a>00107 
<a name="l00108"></a>00108         <span class="comment">// Print values of both counters.</span>
<a name="l00109"></a>00109         console-&gt;Printf(KTxtGetCounterAValue,counterA.CounterValueL());
<a name="l00110"></a>00110         console-&gt;Printf(KTxtGetCounterBValue,counterB.<a class="code" href="class_r_secure_sub_session.html#af205b880df310c24f47ce91ca6261a1d">CounterValueL</a>());
<a name="l00111"></a>00111 
<a name="l00112"></a>00112         <span class="comment">// Wait for a key press.</span>
<a name="l00113"></a>00113         console-&gt;Printf(KMsgPressAnyKey);
<a name="l00114"></a>00114         console-&gt;Getch();
<a name="l00115"></a>00115         console-&gt;ClearScreen();
<a name="l00116"></a>00116 
<a name="l00117"></a>00117         <span class="comment">// Increase the counter value by 1 and print it.</span>
<a name="l00118"></a>00118         <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxt1,<span class="stringliteral">&quot;\nIncrease counterA by default value (i.e. 1)..\n&quot;</span>);
<a name="l00119"></a>00119         console-&gt;Printf(KTxt1);
<a name="l00120"></a>00120         counterA.Increase();
<a name="l00121"></a>00121         console-&gt;Printf(KTxtGetCounterAValue,counterA.CounterValueL());
<a name="l00122"></a>00122 
<a name="l00123"></a>00123         <span class="comment">// Increase the counter by a value greater than 1 and print it.</span>
<a name="l00124"></a>00124         <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxt2,<span class="stringliteral">&quot;\nIncrease counterA by 2..\n&quot;</span>);
<a name="l00125"></a>00125         console-&gt;Printf(KTxt2);
<a name="l00126"></a>00126         <span class="comment">// IncreaseByL operation undergoes a custom security check.</span>
<a name="l00127"></a>00127         <span class="comment">// If the value is greater than 10 and the SID is greater than 0x70fffff5, it fails.</span>
<a name="l00128"></a>00128         counterA.IncreaseByL(2);
<a name="l00129"></a>00129         console-&gt;Printf(KTxtGetCounterAValue,counterA.CounterValueL());
<a name="l00130"></a>00130 
<a name="l00131"></a>00131         <span class="comment">// Increase the counter value by 1 and print it.</span>
<a name="l00132"></a>00132         <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxt3,<span class="stringliteral">&quot;\nIncrease counterB by default value (i.e. 1)..\n&quot;</span>);
<a name="l00133"></a>00133         console-&gt;Printf(KTxt3);
<a name="l00134"></a>00134         counterB.<a class="code" href="class_r_secure_sub_session.html#aa33648763c953202fb21f037b2d413e9">Increase</a>();
<a name="l00135"></a>00135         console-&gt;Printf(KTxtGetCounterBValue,counterB.<a class="code" href="class_r_secure_sub_session.html#af205b880df310c24f47ce91ca6261a1d">CounterValueL</a>());
<a name="l00136"></a>00136 
<a name="l00137"></a>00137         <span class="comment">// Increase the counter by a value greater than 1 and print it.</span>
<a name="l00138"></a>00138         <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxt4,<span class="stringliteral">&quot;\nIncrease counterA by 17..\n&quot;</span>);
<a name="l00139"></a>00139         console-&gt;Printf(KTxt4);
<a name="l00140"></a>00140         <span class="comment">// Fails if the SID is greater than 0x70fffff5</span>
<a name="l00141"></a>00141         counterA.IncreaseByL(17);
<a name="l00142"></a>00142         console-&gt;Printf(KTxtGetCounterAValue,counterA.CounterValueL());
<a name="l00143"></a>00143 
<a name="l00144"></a>00144         <span class="comment">// Wait for a key press.</span>
<a name="l00145"></a>00145         console-&gt;Printf(KMsgPressAnyKey);
<a name="l00146"></a>00146         console-&gt;Getch();
<a name="l00147"></a>00147         console-&gt;ClearScreen();
<a name="l00148"></a>00148 
<a name="l00149"></a>00149         <span class="comment">// Increase the counter by a value greater than 1 and print it.</span>
<a name="l00150"></a>00150         <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxt5,<span class="stringliteral">&quot;\nIncrease counterB by 5..\n&quot;</span>);
<a name="l00151"></a>00151         console-&gt;Printf(KTxt5);
<a name="l00152"></a>00152         counterB.<a class="code" href="class_r_secure_sub_session.html#a9342022cfba8bec8db374364fc08fab6">IncreaseByL</a>(5);
<a name="l00153"></a>00153         console-&gt;Printf(KTxtGetCounterBValue,counterB.<a class="code" href="class_r_secure_sub_session.html#af205b880df310c24f47ce91ca6261a1d">CounterValueL</a>());
<a name="l00154"></a>00154 
<a name="l00155"></a>00155         <span class="comment">// Decrease the counter value by 1 and print it.</span>
<a name="l00156"></a>00156         <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxt6,<span class="stringliteral">&quot;\nDecrease counterA..\n&quot;</span>);
<a name="l00157"></a>00157         console-&gt;Printf(KTxt6);
<a name="l00158"></a>00158         counterA.Decrease();
<a name="l00159"></a>00159         console-&gt;Printf(KTxtGetCounterAValue,counterA.CounterValueL());
<a name="l00160"></a>00160 
<a name="l00161"></a>00161         <span class="comment">// Decrease the counter by a value greater than 1 and print it.</span>
<a name="l00162"></a>00162         <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxt7,<span class="stringliteral">&quot;\nDecrease counterB by 3..\n&quot;</span>);
<a name="l00163"></a>00163         console-&gt;Printf(KTxt7);
<a name="l00164"></a>00164         console-&gt;Printf(KTxtGetCounterBValue,counterB.<a class="code" href="class_r_secure_sub_session.html#af205b880df310c24f47ce91ca6261a1d">CounterValueL</a>());
<a name="l00165"></a>00165         <span class="comment">// DecreaseByL operation undergoes a custom security check.</span>
<a name="l00166"></a>00166         <span class="comment">// If the value is greater than 10 and the SID is greater than 0x70fffff5, it fails.</span>
<a name="l00167"></a>00167         counterB.<a class="code" href="class_r_secure_sub_session.html#a1cc1a1a8ecfb898713f681cfe76701cb">DecreaseByL</a>(3);
<a name="l00168"></a>00168 
<a name="l00169"></a>00169         <span class="comment">// Print the resource count of the server.</span>
<a name="l00170"></a>00170         <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxt8,<span class="stringliteral">&quot;\nResource count is.. %d \n&quot;</span>);
<a name="l00171"></a>00171         console-&gt;Printf(KTxt8,countserv.<a class="code" href="class_r_secure_session.html#a5ad87a05e485af49ed9b599d420c81ef">ResourceCountL</a>());
<a name="l00172"></a>00172 
<a name="l00173"></a>00173         <span class="comment">// The user can save the counter value to a file.</span>
<a name="l00174"></a>00174         console-&gt;Printf(KTxtSaveToFile);
<a name="l00175"></a>00175         TUint8 sel = console-&gt;Getch();
<a name="l00176"></a>00176         <span class="keywordflow">if</span>(sel == <span class="charliteral">&#39;a&#39;</span>)
<a name="l00177"></a>00177                 {
<a name="l00178"></a>00178                 <span class="comment">// Save the value of the counter A.</span>
<a name="l00179"></a>00179                 console-&gt;Printf(KTxtSelectCounter,sel);
<a name="l00180"></a>00180                 console-&gt;Printf(KTxtSaveCounter);
<a name="l00181"></a>00181                 <span class="comment">// This call will fail if the client executable does not have required file write capability.</span>
<a name="l00182"></a>00182                 counterA.SaveCounterL();
<a name="l00183"></a>00183                 }
<a name="l00184"></a>00184         <span class="keywordflow">else</span> <span class="keywordflow">if</span>(sel == <span class="charliteral">&#39;b&#39;</span>)
<a name="l00185"></a>00185                 {
<a name="l00186"></a>00186                 <span class="comment">// Save the value of the counter B.</span>
<a name="l00187"></a>00187                 console-&gt;Printf(KTxtSelectCounter,sel);
<a name="l00188"></a>00188                 console-&gt;Printf(KTxtSaveCounter);
<a name="l00189"></a>00189                 <span class="comment">// This call will fail if the client executable does not have required file write capability.</span>
<a name="l00190"></a>00190                 counterB.<a class="code" href="class_r_secure_sub_session.html#a97d7a09b2347f1ef4f476feaaaa5f781">SaveCounterL</a>();
<a name="l00191"></a>00191                 }
<a name="l00192"></a>00192 
<a name="l00193"></a>00193         <span class="comment">// Close both sub sessions and the main session.</span>
<a name="l00194"></a>00194         <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxt9,<span class="stringliteral">&quot;\nClosing counterA and then CounterB..\n&quot;</span>);
<a name="l00195"></a>00195         console-&gt;Printf(KTxt9);
<a name="l00196"></a>00196         counterA.Close();
<a name="l00197"></a>00197         counterB.<a class="code" href="class_r_secure_sub_session.html#aac12680343af53cd4737699847905cb9">Close</a>();
<a name="l00198"></a>00198         countserv.<a class="code" href="class_r_secure_session.html#a8c3903876a6e715f94bc6d4f762e3fa1">Close</a>();
<a name="l00199"></a>00199         }
<a name="l00200"></a>00200 
<a name="l00201"></a><a class="code" href="secureclient_8cpp.html#a0f358e9c4355138f629b8c4f37310295">00201</a> GLDEF_C TInt E32Main()
<a name="l00202"></a>00202         {
<a name="l00203"></a>00203         __UHEAP_MARK;
<a name="l00204"></a>00204         CTrapCleanup* cleanup = CTrapCleanup::New();
<a name="l00205"></a>00205 
<a name="l00206"></a>00206         TRAPD(createError, console = Console::NewL(KTextConsoleTitle, TSize(KConsFullScreen,KConsFullScreen)));
<a name="l00207"></a>00207         <span class="keywordflow">if</span> (createError)
<a name="l00208"></a>00208                 <span class="keywordflow">return</span> createError;
<a name="l00209"></a>00209 
<a name="l00210"></a>00210         TRAPD(mainError, DoExampleL());
<a name="l00211"></a>00211         <span class="keywordflow">if</span> (mainError)
<a name="l00212"></a>00212                 console-&gt;Printf(KTextFailed, mainError);
<a name="l00213"></a>00213         console-&gt;Printf(KTextPressAnyKey);
<a name="l00214"></a>00214         console-&gt;Getch();
<a name="l00215"></a>00215 
<a name="l00216"></a>00216         <span class="keyword">delete</span> console;
<a name="l00217"></a>00217         <span class="keyword">delete</span> cleanup;
<a name="l00218"></a>00218         __UHEAP_MARKEND;
<a name="l00219"></a>00219         <span class="keywordflow">return</span> KErrNone;
<a name="l00220"></a>00220         }
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>