1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
---
layout: default
title: Bindings
---
<div class="hgroup">
<div class="hgroup-inline">
<div class="panel">
<h1 id="bindings">Bindings</h1>
</div>
<div style="clear: both"></div>
</div>
</div>
<div class="hgroup">
<div class="hgroup-inline">
<div class="panel">
<p>
If you don't want to invoke the <tt>jsonnet</tt> commandline utility to evaluate Jsonnet,
there are also official libraries for Python, Go, and C. The C library wraps the C++
implementation, hiding all the C++ to make it easy to use Jsonnet from C. In turn, there is
a C++ wrapper around the C library to make it easy to use from client C++ code (surprisingly
enough, this actually makes sense)! There are also various unofficial bindings built on the
C API.
</p>
</div>
<div style="clear: both"></div>
</div>
</div>
<div class="hgroup">
<div class="hgroup-inline">
<div class="panel">
<h2 id="server_side">A Warning On Server-Side Evaluation</h2>
</div>
<div style="clear: both"></div>
</div>
</div>
<div class="hgroup">
<div class="hgroup-inline">
<div class="panel">
<p>
If you are creating an API server that will evaluate untrusted Jsonnet code in the same
process that handles other requests, be aware of your exposure to denial of service attacks.
Since Jsonnet allows expressing programs that take unreasonable amounts of CPU time and RAM,
it is possible for a malicious request to cause its host API server to exceed its OS
resources and crash. Such a crash would affect concurrently running handlers for other
users, and decrease your capacity until the server is restarted. A simple remedy for this
situation is to <tt>exec</tt> the Jsonnet commandline binary in a <tt>ulimit</tt> child
process where the CPU and RAM can be tightly bounded for the specific request.
Communication to and from the commandline binary could be via temporary files or pipes.
Thus, only the malicious request fails.
</p>
<p>
Linking Jsonnet as a library is more appropriate for client-side applications or situations
where the input configuration can be trusted.
</p>
</div>
<div style="clear: both"></div>
</div>
</div>
<div class="hgroup">
<div class="hgroup-inline">
<div class="panel">
<h2 id="c_api">C API</h2>
</div>
<div style="clear: both"></div>
</div>
</div>
<div class="hgroup">
<div class="hgroup-inline">
<div class="panel">
<p>
The C API simply wraps the C++ implementation to hide C++ language features like templates,
classes, overloading, etc. This makes it easier to bind to other languages, as C is
typically the lowest common denominator across all systems.
</p>
<p>
The API is documented in <a
href="http://github.com/google/jsonnet/blob/master/include/libjsonnet.h">libjsonnet.h</a>.
It is built with 'make libjsonnet.so'. It is used by the python bindings, the Jsonnet
commandline tool, as well as a couple of simpler tests. Search for #include "libjsonnet.h".
</p>
<p>
To use the API, create a JsonnetVM object, set various options, then tell it to evaluate a
filename or snippet. To avoid leaking memory, the result of execution (JSON or error
message) and the JsonnetVM object itself must be cleaned up using the provided
<tt>jsonnet_realloc</tt> and the <tt>jsonnet_destroy</tt> functions, respectively.
</p>
<div style="clear: both"></div>
</div>
</div>
<div class="hgroup">
<div class="hgroup-inline">
<div class="panel">
<h2 id="python_api">Python API</h2>
</div>
<div style="clear: both"></div>
</div>
</div>
<div class="hgroup">
<div class="hgroup-inline">
<div class="panel">
<p>
The Python API wraps the C API in a straightforward way. It can be installed with <tt>pip
install jsonnet</tt> or built directly with <tt>setup.py</tt>. It supports Python 2.7 and
Python 3.
</p>
<p>
The Python module provides two functions, <tt>evaluate_file(filename)</tt> and
<tt>evaluate_snippet(filename, expr)</tt>. In the latter case, the parameter
<tt>filename</tt> is used in stack traces, because all errors are given with the "filename"
containing the code.
</p>
<p>
Keyword arguments to these functions are used to control the virtual machine. They are:
</p>
<ul>
<li><tt>max_stack</tt> (number)</li>
<li><tt>gc_min_objects</tt> (number)</li>
<li><tt>gc_growth_trigger</tt> (number)</li>
<li><tt>ext_vars</tt> (dict: string to string)</li>
<li><tt>ext_codes</tt> (dict string to string)</li>
<li><tt>tla_vars</tt> (dict string to string)</li>
<li><tt>tla_codes</tt> (dict string to string)</li>
<li><tt>max_trace</tt> (number)</li>
<li><tt>import_callback</tt> (see example in python/)</li>
<li><tt>native_callbacks</tt> (see example in python/)</li>
</ul>
<p>
The argument <tt>import_callback</tt> can be used to pass a callable, to trap the Jsonnet
<code>import</code> and <code>importstr</code> constructs. This allows, e.g., reading files
out of archives or implementing library search paths. The argument <tt>native_callback</tt>
is used to allow execution of arbitrary Python code via <code>std.native(...)</code>. This
is useful so Jsonnet code can access pure functions in the Python ecosystem, such as
compression, encryption, encoding, etc.
</p>
<p>
If an error is raised during the evaluation of the Jsonnet code, it is formed into a stack
trace and thrown as a python RuntimeError. Otherwise, the JSON string is returned. To
convert this into objects for easy interpretation in Python, use the <a
href="https://docs.python.org/2/library/json.html">json</a> module. An example:
</p>
<pre>import json
import _jsonnet
jsonnet_str = '''
{
person1: {
name: "Alice",
welcome: "Hello " + self.name + "!",
},
person2: self.person1 {
name: std.extVar("OTHER_NAME"),
},
}
'''
json_str = _jsonnet.evaluate_snippet(
"snippet", jsonnet_str,
ext_vars={'OTHER_NAME': 'Bob'})
json_obj = json.loads(json_str)
for person_id, person in json_obj.iteritems():
print '%s is %s, greeted by "%s"' % (
person_id,
person['name'],
person['welcome'])</pre>
<div style="clear: both"></div>
</div>
</div>
<div class="hgroup">
<div class="hgroup-inline">
<div class="panel">
<h2 id="third_party_apis">Unofficial Third Party APIs</h2>
</div>
<div style="clear: both"></div>
</div>
</div>
<div class="hgroup">
<div class="hgroup-inline">
<div class="panel">
<p>
There are unofficial bindings available for other languages. These are not supported by
Google and may be some versions behind the latest release.
</p>
<ul>
<li>
<a href="https://github.com/strickyak/jsonnet_cgo">Go</a> but please first consider the
<a href="https://github.com/google/go-jsonnet">native port</a>
</li>
<li>
<a href="https://github.com/yuduanchen/luajit-jsonnet">LuaJIT (FFI)</a>
</li>
<li>
<a href="https://github.com/yosuke-furukawa/node-jsonnet">Node.js</a>
</li>
<li>
<a href="https://github.com/Neeke/Jsonnet-PHP">PHP</a>
</li>
<li>
<a href="https://github.com/yugui/ruby-jsonnet">Ruby</a>
</li>
<li>
<a href="https://github.com/anguslees/rust-jsonnet">Rust</a>
</li>
<li>
<a href="https://github.com/yuduanchen/rust-jsonnet">Rust (less comprehensive, older)</a>
</li>
</ul>
<div style="clear: both"></div>
</div>
</div>
|
