import repository from arizona
[raven.git] / webpage / tpfile.html
1  <html>
2 <head>
3 <title> Stork Project </title>
4 <LINK href="stork.css" rel="stylesheet" type="text/css">
5
6 </head>
7
8 <body>
9
10
11 <div class="display" align="center">
12         <table border="0">
13         <tr>
14                 <td width="170" valign="top">
15
16                                 <br/>
17                                 <table cellpadding="3" width="170" id="links" class="links">
18                                         <tr>
19                                                 <td align="right">
20
21                                                         <ul class="links">
22
23                                                                 <a href = "index.html"><h3>Stork</h3></a>
24                                                                 <li class="links"><a href="tutmain.html">Stork Tutorial</a></li>
25
26                                                                 <li class="links"><a href="advanced.html">Advanced Usage</a></li>
27                                                                 <li class="links"><a href="arch.html">Stork Architecture</a></li>
28                                                                 <li class="links"><a href="filelist.html">Stork File List</a></li>
29                                                                 <li class="links"><a href="about.html">About Us</a></li>
30                                                                 <li class="links"><a href="apps.html">Related Links</a></li>
31                                                                 <li class="links"><a href="contact.html">Contact Stork</a></li>
32                                                                 <h4>Links</h4>
33                                                                 <li class="links"><a href="http://appmanager.berkeley.intel-research.net/plcontrol/apps.php?appid=1029">
34                                                                 Slice Status</a></li>
35                                                                 <li class="links"><a href="https://stork-repository.cs.arizona.edu">Stork Repository</a></li>
36                                                         </ul>
37
38                                                  </td>
39                                         </tr>
40                                 </table>
41                                 <br/>
42                 </td>
43
44                 <td valign="top">
45                 <table class="info" cellpadding="0" width="700" >
46                 <tr  height="75"><td colspan="3"><img style="margin-left: -0px;" src="images/stork-header.png" alt="stork logo"/></td></tr>
47                 <tr  bgcolor="#444444" class="headerrow" width="100%" height="2">
48
49                         <th colspan="2"> Using Stork </th>
50
51                 </tr>
52                 <tr valign="top" align="left">
53
54                         <td>
55                                 <table cellpadding="8" id="content" class="content">
56                                         <tr>
57                                                 <td>
58
59                                                         <h1><a name = "top"></a>The TPFile</h1>
60 The following shows how to manually modify a simple TPFile created through storkutil.
61
62 <p>The first step is to extract your TPFile. To do this, use the command:
63 <code>./storkutil.py extract USERNAME.<i>publickey</i>.tpfile NEWFILE</code>
64 <br>Where NEWFILE is the file that will be created. This newfile contains your
65 TPFile. You can now edit this file using any text editor. The following shows the breakdown of the
66 extracted TPFile:
67
68
69 <p><table cellspacing=0  cellpadding=5 border=5 bordercolor="orange"><tr>
70 <td width="100%" align="left" valign="top" bgcolor="FFFF99">
71 <span style="color: black; font-size:16; ">
72 <p><code>&lt;&#63;xml version=&quot;1.0&quot; encoding="ISO-8859-1" standalone="yes" ?&gt;
73 <p><code>&lt;TRUSTEDPACKAGES&gt;
74 <p><code>&lt;USER PATTERN="mypackage.tar.gz" USERNAME="who" PUBLICKEY="MFwwDQYJKoZIhv cNAQEBBQADS wAwSAJ BALACAiS4s Yg_6tdinzwIt0 RT3l6 U699 vPiA3wqgHjF4qlQa JdzCZ6Vg8h d2tDH5Lucs7KF3s+yDWj fq+XYaOVUCAwEAAQ" ORDER-BY="default" ACTION="ALLOW"/&gt;
75
76 <p><code>&lt;FILE PATTERN="mypackage2.tar.gz" HASH="eb12b&#x200B;9d24fef30fce7&#x200B;3a393896&#x200B;3abfef9b245e5a" TIMESTAMP="1173298131.66" TAGS="" ACTION="ALLOW"/&gt;
77 <p><code>&lt;FILE PATTERN="mypackage.tar.gz" HASH="1cd77e04ac5e&#x200B;8546833d1&#x200B;86cb40d5f4&#x200B;0d4ffdeff" TIMESTAMP="1172370481.15" TAGS="" ACTION="DENY"/&gt;
78 <p><code>&lt;USER PATTERN="*" USERNAME="default" PUBLICKEY="MFwwDQYJKoZIhvc&#x200B;NAQEBBQADSwAwSAJ&#x200B;BAKgZCjfKDl9ISoclf&#x200B;BuZsQze6bXtu+QYF6&#x200B;4TLQlI9fgEg2CDyGQ&#x200B;VOsZ2CaX1ZEZ_O69A&#x200B;YZp8nj+YJLIJM3+W&#x200B;3DMCAwEAAQ" ACTION="ALLOW"/&gt;
79 <p><code>&lt;/TRUSTEDPACKAGES&gt;
80 </code>
81 </span></td></tr></table>
82
83
84 <p>We can look at this TPFile piece by piece.
85
86 <p>XML information:
87 <br><b><code>&lt;?xml version="1.0" encoding="ISO-8859-1" standalone="yes" ?&gt;</b></code>
88
89 <p>The start of the trusted packages list:
90 <br><b><code>&lt;TRUSTEDPACKAGES&gt;
91 </b>
92 <p>The &quot;USER PATTERN=&quot; part of this file used for the <adduser> command. It lists a user, the user's publickey, the action
93 which we have decided for the user (ALLOW, DENY, ANY) and the packages to which this action applies.
94 <br><b><code>&lt;USER PATTERN=&quot;mypackage.tar.gz&quot; USERNAME=&quot;who&quot; PUBLICKEY=&quot;MFwwDQYJKo ZIhvcNAQEBBQ ADSwAwSAJBAL ACAiS4sYg_6t dinzwIt0RT 3l6U699vPi A3wqgHjF4ql QaJdzC Z6Vg8h ad2tD H5Lucs7KF3s+yDWjfq+XYaOVUCAwEAAQ&quot; ORDER-BY=&quot;default&quot; ACTION=&quot;ALLOW&quot;/&gt;
95 </b>
96 <p>The following two lines are nearly the same as above, but for a <code>addfile</code> command instead of <code>adduser</code>.
97 The lines list first the file to be trusted, and then the file's hashcode and timestamp (in case of an invalid file with the same name as a trusted
98 one). The action, like in the <code>adduser</code> case, lists whether we ALLOW, DENY or ANY the package. The <code>TAGS</code> portion of the line
99 is used to attach tags to packages. For more information on tags, please see the <b><a href="tptags.html">using tags</a></b> page.
100 <br><b><code>&lt;FILE PATTERN=&quot;mypackage2.tar.gz&quot; HASH=&quot;eb12b9d24fef30fce73a3938963abfef9b245e5a&quot; TIMESTAMP=&quot;1173298131.66&quot; TAGS=&quot;&quot; ACTION=&quot;ALLOW&quot;/&gt;
101 <p><code>&lt;FILE PATTERN=&quot;mypackage.tar.gz&quot; HASH=&quot;1cd77e04ac5e8546833d186cb40d5f40d4ffdeff&quot; TIMESTAMP=&quot;1172370481.15&quot; TAGS=&quot;&quot; ACTION=&quot;DENY&quot;/&gt;
102 </b>
103
104 <p>The final line is the line that should be present in all new TPFiles. If this line is not present, it means that stork
105 could not find the default.publickey file (which is included in the enduser tarball) when the TPFile was generated. You will need to trust the default user
106 in order to accept packages from Stork and PlanetLab.
107 <p><b><code>&lt;USER PATTERN="*" USERNAME="default" PUBLICKEY="MFwwDQYJKoZIhvc&#x200B;NAQEBBQADSwAwSAJ&#x200B;BAKgZCjfKDl9ISoclf&#x200B;BuZsQze6bXtu+QYF6&#x200B;4TLQlI9fgEg2CDyGQ&#x200B;VOsZ2CaX1ZEZ_O69A&#x200B;YZp8nj+YJLIJM3+W&#x200B;3DMCAwEAAQ" ACTION="ALLOW"/&gt;</code></b>
108 <p>We then have the end of the trusted packages list:
109 <br><b><code>&lt;/TRUSTEDPACKAGES&gt;</b>
110
111 <p>After you finish modifying your TPFile, you can then use the <code>storkutil.py sign newFile</code> command to sign your extracted file. Once
112 your file has been signed, you can either manually rename the file <i>username.publickey.</i>tpfile, or you can use the <code>pubkeyembed</code>
113 command to automatically rename your file:
114 <p><b><code>storkutil.py pubkeyembed newFile</b>
115 <br><code>File 'newFile' has been copied to ' newFile.<i>publickey</i>'</code>
116 <p>Note that you will need to add the .tpfile to the end of this filename.
117
118
119
120
121
122                                                         <center><a href = "index.html">Home</a>     <a href = "#top">Top</a></center>
123
124
125                                                 </td>
126                                         </tr>
127                                 </table>
128                         </td>
129                 </tr>
130
131        </table>
132        </td>
133
134      </tr>
135      <tr>
136         <td></td>
137         <td>
138                 <a href="http://www.planet-lab.org"><img style="border: 0px; border-style: none;" src="images/powered_by_pl_grey.png" alt="powered by planetlab"></a>
139
140                                         <a href="http://www.cs.arizona.edu"><img style="position:relative; left: 20px; border: 0px; border-style: none;" src="images/template_logo_small_grey.png" alt="University of Arizona, Computer Science logo"></a>
141
142
143
144
145
146         </td>
147      </tr>
148
149 </table>
150
151 </div>
152
153
154 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
155 </script>
156 <script type="text/javascript">
157 _uacct = "UA-1868232-1";
158 urchinTracker();
159 </script>
160 </body>
161 </html>
162
163
164
165