Xcapclient

Version 19 (Adrian Georgescu, 04/13/2009 10:55 am)

1 14 Adrian Georgescu
== xcapclient ==
2 1 Adrian Georgescu
3 16 Adrian Georgescu
[[TOC(SipTesting*, sip_*, xcap*,depth=2)]]
4 16 Adrian Georgescu
5 19 Adrian Georgescu
To use this script you must to have a valid [wiki:SipConfigOld configuration file]. This script must be migrated to the new configuration framework.
6 19 Adrian Georgescu
7 14 Adrian Georgescu
=== Description ===
8 1 Adrian Georgescu
9 18 Adrian Georgescu
[[Image(http://www.openxcap.org/chrome/site/SIMPLE-XCAP-client.png)]]
10 8 Adrian Georgescu
11 9 Adrian Georgescu
XCAP protocol, defined in RFC 4825, allows a client to read, write, and
12 9 Adrian Georgescu
modify application configuration data stored in XML format on a server. XCAP
13 9 Adrian Georgescu
maps XML document sub-trees and element attributes to HTTP URIs, so that
14 9 Adrian Georgescu
these components can be directly accessed by HTTP. An XCAP server used by
15 9 Adrian Georgescu
XCAP clients to store data like presence policy in combination with a SIP
16 9 Adrian Georgescu
Presence server that supports PUBLISH/SUBSCRIBE/NOTIFY SIP methods can
17 9 Adrian Georgescu
provide a complete SIP SIMPLE solution.
18 9 Adrian Georgescu
19 10 Adrian Georgescu
This XCAP  client is part of python-xcaplib package provided by [http://openxcap.org OpenXCAP] server. If you have installed bash_completion.d/xcapclient  you can use TAB completion to browse through the content of the XCAP server documents/nodes/atributes. For more information read the documentation that comes with the package.
20 1 Adrian Georgescu
21 1 Adrian Georgescu
{{{
22 1 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -h
23 1 Adrian Georgescu
24 1 Adrian Georgescu
  xcapclient: Client for managing full or partial XML documents on XCAP servers (RFC 4825)
25 1 Adrian Georgescu
  xcapclient [OPTIONS] --app AUID ACTION [NODE-SELECTOR]
26 1 Adrian Georgescu
27 1 Adrian Georgescu
  ACTION is an operation to perform: get, replace, insert, put or delete.
28 1 Adrian Georgescu
  Presence of NODE-SELECTOR indicates that action is to be performed on an
29 1 Adrian Georgescu
  element or an attribute.
30 1 Adrian Georgescu
31 1 Adrian Georgescu
Options:
32 1 Adrian Georgescu
  -h, --help             show this help message and exit
33 1 Adrian Georgescu
  -a NAME, --account-name=NAME
34 1 Adrian Georgescu
                         the account name from which to read account settings.
35 1 Adrian Georgescu
                         Corresponds to section Account_NAME in the
36 1 Adrian Georgescu
                         configuration file. If not supplied, the section
37 1 Adrian Georgescu
                         [Account] will be read.
38 1 Adrian Georgescu
  --show-config          show options from the configuration file; use
39 1 Adrian Georgescu
                         together with --account-name
40 1 Adrian Georgescu
  --xcap-root=XCAP_ROOT  XCAP root, e.g. https://xcap.example.com/xcap-root
41 1 Adrian Georgescu
  --sip-address=SIP_ADDRESS
42 1 Adrian Georgescu
                         SIP address of the user in the form username@domain
43 1 Adrian Georgescu
  -p PASSWORD, --password=PASSWORD
44 1 Adrian Georgescu
                         password to use if authentication is required. If not
45 1 Adrian Georgescu
                         supplied will be asked interactively
46 1 Adrian Georgescu
  --app=AUID             Application Unique ID. There's no default value;
47 1 Adrian Georgescu
                         however, it may be guessed from NODE-SELECTOR or from
48 1 Adrian Georgescu
                         the input file. Known apps: watchers, pidf-
49 1 Adrian Georgescu
                         manipulation, rls-services, resource-lists, xcap-
50 1 Adrian Georgescu
                         caps, pres-rules, test-app
51 1 Adrian Georgescu
  --filename=FILENAME    
52 1 Adrian Georgescu
  -c CONTEXT, --context=CONTEXT
53 1 Adrian Georgescu
                         document context, users or global; default is users
54 1 Adrian Georgescu
                         for everything except xcap-caps
55 1 Adrian Georgescu
  --etag=ETAG            perform a conditional operation
56 1 Adrian Georgescu
  -i INPUT_FILENAME      source file for the PUT request; default is <stdin>
57 1 Adrian Georgescu
  -o OUTPUT_FILENAME     output file for the body of the server response
58 1 Adrian Georgescu
                         (successful or not); default is <stdout>
59 1 Adrian Georgescu
  -d, --dump             print HTTP traffic to stderr
60 2 Adrian Georgescu
}}}
61 2 Adrian Georgescu
62 2 Adrian Georgescu
63 14 Adrian Georgescu
=== Example for XCAP server capabilities (xcap-caps)  === 
64 6 Adrian Georgescu
{{{
65 6 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice --app xcap-caps GET
66 6 Adrian Georgescu
get https://xcap.sipthor.net/xcap-root/xcap-caps/global/index
67 6 Adrian Georgescu
etag: "ab12efdd1aff88296deee1aa195b823e"
68 6 Adrian Georgescu
content-type: application/xcap-caps+xml
69 6 Adrian Georgescu
content-length: 826
70 6 Adrian Georgescu
<?xml version='1.0' encoding='UTF-8'?>
71 6 Adrian Georgescu
<xcap-caps xmlns='urn:ietf:params:xml:ns:xcap-caps'>
72 6 Adrian Georgescu
<auids>
73 6 Adrian Georgescu
<auid>watchers</auid>
74 6 Adrian Georgescu
<auid>org.openmobilealliance.pres-rules</auid>
75 6 Adrian Georgescu
<auid>rls-services</auid>
76 6 Adrian Georgescu
<auid>pidf-manipulation</auid>
77 6 Adrian Georgescu
<auid>xcap-caps</auid>
78 6 Adrian Georgescu
<auid>test-app</auid>
79 6 Adrian Georgescu
<auid>resource-lists</auid>
80 6 Adrian Georgescu
<auid>pres-rules</auid>
81 6 Adrian Georgescu
</auids>
82 6 Adrian Georgescu
<extensions>
83 6 Adrian Georgescu
</extensions>
84 6 Adrian Georgescu
<namespaces>
85 6 Adrian Georgescu
<namespace>http://openxcap.org/ns/watchers</namespace>
86 6 Adrian Georgescu
<namespace>urn:ietf:params:xml:ns:pres-rules</namespace>
87 6 Adrian Georgescu
<namespace>urn:ietf:params:xml:ns:rls-services</namespace>
88 6 Adrian Georgescu
<namespace>urn:ietf:params:xml:ns:pidf</namespace>
89 6 Adrian Georgescu
<namespace>urn:ietf:params:xml:ns:xcap-caps</namespace>
90 6 Adrian Georgescu
<namespace>test-app</namespace>
91 6 Adrian Georgescu
<namespace>urn:ietf:params:xml:ns:resource-lists</namespace>
92 6 Adrian Georgescu
<namespace>urn:ietf:params:xml:ns:pres-rules</namespace>
93 6 Adrian Georgescu
</namespaces>
94 6 Adrian Georgescu
</xcap-caps>
95 6 Adrian Georgescu
}}}
96 6 Adrian Georgescu
97 14 Adrian Georgescu
=== Example for pres-rules XCAP document ===
98 1 Adrian Georgescu
99 14 Adrian Georgescu
==== PUT ====
100 3 Adrian Georgescu
101 2 Adrian Georgescu
{{{
102 2 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice PUT -i work/python-xcaplib/examples/pres-rules.xml 
103 2 Adrian Georgescu
put https://xcap.sipthor.net/xcap-root/pres-rules/users/sip:alice@example.com/index
104 2 Adrian Georgescu
201 Created
105 2 Adrian Georgescu
etag: "345ba7c1ce125b2ff2438c19b25b4077"
106 2 Adrian Georgescu
content-type: application/auth-policy+xml
107 2 Adrian Georgescu
}}}
108 1 Adrian Georgescu
109 2 Adrian Georgescu
110 14 Adrian Georgescu
==== GET ====
111 2 Adrian Georgescu
112 2 Adrian Georgescu
{{{
113 2 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice --app pres-rules get 
114 2 Adrian Georgescu
get https://xcap.sipthor.net/xcap-root/pres-rules/users/sip:alice@example.com/index
115 2 Adrian Georgescu
etag: "345ba7c1ce125b2ff2438c19b25b4077"
116 2 Adrian Georgescu
content-type: application/auth-policy+xml
117 2 Adrian Georgescu
content-length: 939
118 2 Adrian Georgescu
<?xml version="1.0" encoding="UTF-8"?>
119 2 Adrian Georgescu
<ruleset xmlns="urn:ietf:params:xml:ns:common-policy" xmlns:pr="urn:ietf:params:xml:ns:pres-rules" xmlns:cp="www.counterpath.com/privacy-lists">
120 2 Adrian Georgescu
<rule id="pres_whitelist">
121 2 Adrian Georgescu
<conditions>
122 2 Adrian Georgescu
<identity>
123 2 Adrian Georgescu
<one id="sip:bob@example.com"/>
124 2 Adrian Georgescu
<one id="sip:alice@example.com"/>
125 2 Adrian Georgescu
<many domain="ag-projects.com">
126 2 Adrian Georgescu
</many>
127 2 Adrian Georgescu
</identity>
128 2 Adrian Georgescu
</conditions>
129 2 Adrian Georgescu
<actions>
130 2 Adrian Georgescu
<pr:sub-handling>allow</pr:sub-handling>
131 2 Adrian Georgescu
</actions>
132 2 Adrian Georgescu
<transformations>
133 2 Adrian Georgescu
<pr:provide-services>
134 2 Adrian Georgescu
<pr:all-services/>
135 2 Adrian Georgescu
</pr:provide-services>
136 2 Adrian Georgescu
<pr:provide-persons>
137 2 Adrian Georgescu
<pr:all-persons/>
138 2 Adrian Georgescu
</pr:provide-persons>
139 2 Adrian Georgescu
<pr:provide-devices>
140 2 Adrian Georgescu
<pr:all-devices/>
141 2 Adrian Georgescu
</pr:provide-devices>
142 2 Adrian Georgescu
<pr:provide-all-attributes/>
143 2 Adrian Georgescu
</transformations>
144 2 Adrian Georgescu
</rule>
145 2 Adrian Georgescu
<rule id="pres_blacklist">
146 2 Adrian Georgescu
<conditions>
147 2 Adrian Georgescu
<identity>
148 2 Adrian Georgescu
<one id="sip:40316600024@abc.com"/>
149 2 Adrian Georgescu
</identity>
150 2 Adrian Georgescu
</conditions>
151 2 Adrian Georgescu
<actions>
152 2 Adrian Georgescu
<pr:sub-handling>block</pr:sub-handling>
153 2 Adrian Georgescu
</actions>
154 2 Adrian Georgescu
<transformations/>
155 2 Adrian Georgescu
</rule>
156 1 Adrian Georgescu
</ruleset>
157 2 Adrian Georgescu
}}}
158 2 Adrian Georgescu
159 14 Adrian Georgescu
==== DELETE ====
160 2 Adrian Georgescu
161 2 Adrian Georgescu
{{{
162 2 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice --app pres-rules DELETE
163 1 Adrian Georgescu
delete https://xcap.sipthor.net/xcap-root/pres-rules/users/sip:alice@example.com/index
164 1 Adrian Georgescu
200 OK
165 1 Adrian Georgescu
content-type: application/auth-policy+xml
166 3 Adrian Georgescu
}}}
167 3 Adrian Georgescu
168 3 Adrian Georgescu
169 14 Adrian Georgescu
=== Example for resource-lists XCAP document ===
170 3 Adrian Georgescu
171 14 Adrian Georgescu
==== PUT ====
172 3 Adrian Georgescu
173 3 Adrian Georgescu
{{{
174 3 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice PUT -i work/python-xcaplib/examples/resource-lists.xml 
175 3 Adrian Georgescu
put https://xcap.sipthor.net/xcap-root/resource-lists/users/sip:alice@example.com/index
176 3 Adrian Georgescu
201 Created
177 3 Adrian Georgescu
etag: "f8c47352d61b5b256ee80d964e03efd6"
178 3 Adrian Georgescu
content-type: application/resource-lists+xml
179 3 Adrian Georgescu
}}}
180 3 Adrian Georgescu
181 14 Adrian Georgescu
==== GET ====
182 3 Adrian Georgescu
183 3 Adrian Georgescu
{{{
184 3 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice --app resource-lists GET
185 3 Adrian Georgescu
get https://xcap.sipthor.net/xcap-root/resource-lists/users/sip:alice@example.com/index
186 3 Adrian Georgescu
etag: "f8c47352d61b5b256ee80d964e03efd6"
187 3 Adrian Georgescu
content-type: application/resource-lists+xml
188 3 Adrian Georgescu
content-length: 991
189 3 Adrian Georgescu
<?xml version="1.0" encoding="UTF-8"?>
190 3 Adrian Georgescu
   <resource-lists xmlns="urn:ietf:params:xml:ns:resource-lists"
191 3 Adrian Georgescu
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
192 3 Adrian Georgescu
    <list name="friends">
193 3 Adrian Georgescu
     <entry uri="sip:bill@example.com">
194 3 Adrian Georgescu
      <display-name>Bill Doe</display-name>
195 3 Adrian Georgescu
     </entry>
196 3 Adrian Georgescu
     <entry-ref ref="resource-lists/users/sip:bill@example.com/index/~~/resource-lists/list%5b@name=%22list1%22%5d/entry%5b@uri=%22sip:petri@example.com%22%5d"/>
197 3 Adrian Georgescu
     <list name="close-friends">
198 3 Adrian Georgescu
      <display-name>Close Friends</display-name>
199 3 Adrian Georgescu
      <entry uri="sip:joe@example.com">
200 3 Adrian Georgescu
       <display-name>Joe Smith</display-name>
201 3 Adrian Georgescu
      </entry>
202 3 Adrian Georgescu
      <entry uri="sip:nancy@example.com">
203 3 Adrian Georgescu
       <display-name>Nancy Gross</display-name>
204 3 Adrian Georgescu
      </entry>
205 3 Adrian Georgescu
      <external anchor="http://xcap.example.org/resource-lists/users/sip:a@example.org/index/~~/resource-lists/list%5b@name=%22mkting%22%5d">
206 3 Adrian Georgescu
        <display-name>Marketing</display-name>
207 3 Adrian Georgescu
       </external>
208 3 Adrian Georgescu
     </list>
209 3 Adrian Georgescu
    </list>
210 3 Adrian Georgescu
   </resource-lists>
211 3 Adrian Georgescu
}}}
212 3 Adrian Georgescu
213 14 Adrian Georgescu
==== DELETE ====
214 3 Adrian Georgescu
215 3 Adrian Georgescu
{{{
216 3 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice --app resource-lists DELETE
217 3 Adrian Georgescu
delete https://xcap.sipthor.net/xcap-root/resource-lists/users/sip:alice@example.com/index
218 3 Adrian Georgescu
200 OK
219 3 Adrian Georgescu
content-type: application/resource-lists+xml
220 3 Adrian Georgescu
adigeo@ag-imac3:~$
221 1 Adrian Georgescu
}}}
222 4 Adrian Georgescu
223 14 Adrian Georgescu
=== Example for rls-services XCAP document ===
224 4 Adrian Georgescu
225 14 Adrian Georgescu
==== PUT ====
226 4 Adrian Georgescu
227 4 Adrian Georgescu
{{{
228 4 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice PUT -i work/python-xcaplib/examples/rls-services.xml 
229 4 Adrian Georgescu
put https://xcap.sipthor.net/xcap-root/rls-services/users/sip:alice@example.com/index
230 4 Adrian Georgescu
201 Created
231 4 Adrian Georgescu
etag: "44f5fca1b08352815ee12f1a0c32d812"
232 4 Adrian Georgescu
content-type: application/rls-services+xml
233 4 Adrian Georgescu
}}}
234 4 Adrian Georgescu
235 14 Adrian Georgescu
==== GET ====
236 4 Adrian Georgescu
237 4 Adrian Georgescu
{{{
238 4 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice --app rls-services GET
239 4 Adrian Georgescu
get https://xcap.sipthor.net/xcap-root/rls-services/users/sip:alice@example.com/index
240 4 Adrian Georgescu
etag: "44f5fca1b08352815ee12f1a0c32d812"
241 4 Adrian Georgescu
content-type: application/rls-services+xml
242 4 Adrian Georgescu
content-length: 797
243 4 Adrian Georgescu
<?xml version="1.0" encoding="UTF-8"?>
244 4 Adrian Georgescu
   <rls-services xmlns="urn:ietf:params:xml:ns:rls-services"
245 4 Adrian Georgescu
      xmlns:rl="urn:ietf:params:xml:ns:resource-lists"
246 4 Adrian Georgescu
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
247 4 Adrian Georgescu
    <service uri="sip:mybuddies@example.com">
248 4 Adrian Georgescu
     <resource-list>https://xcap.example.com/xcap-root/resource-lists/users/sip:alice@example.com/index/~~/resource-lists/list%5b@name=%22l1%22%5d</resource-list>
249 4 Adrian Georgescu
     <packages>
250 4 Adrian Georgescu
      <package>presence</package>
251 4 Adrian Georgescu
     </packages>
252 4 Adrian Georgescu
    </service>
253 4 Adrian Georgescu
    <service uri="sip:marketing@example.com">
254 4 Adrian Georgescu
      <list name="marketing">
255 4 Adrian Georgescu
        <rl:entry uri="sip:joe@example.com"/>
256 4 Adrian Georgescu
        <rl:entry uri="sip:sudhir@example.com"/>
257 4 Adrian Georgescu
      </list>
258 4 Adrian Georgescu
      <packages>
259 4 Adrian Georgescu
        <package>presence</package>
260 4 Adrian Georgescu
      </packages>
261 4 Adrian Georgescu
    </service>
262 4 Adrian Georgescu
   </rls-services>
263 4 Adrian Georgescu
}}}
264 4 Adrian Georgescu
265 14 Adrian Georgescu
==== DELETE ====
266 4 Adrian Georgescu
267 4 Adrian Georgescu
{{{
268 4 Adrian Georgescu
adigeo@ag-imac3:~$xcapclient -a alice --app rls-services DELETE
269 4 Adrian Georgescu
delete https://xcap.sipthor.net/xcap-root/rls-services/users/sip:alice@example.com/index
270 4 Adrian Georgescu
200 OK
271 4 Adrian Georgescu
content-type: application/rls-services+xml
272 4 Adrian Georgescu
}}}