Rate and give feedback:  Feedback Received. Thank You!

Rate and give feedback: 

X

This document helped resolve my issue

Yes No

Additional Comments

800 characters remaining

May we contact you if necessary?

Name:  

E-mail: 

Enter a valid Email ID

Need product assistance? Contact Juniper Support

Submit

This site is protected by hCaptcha and its Privacy Policy and Terms of Service apply.

English  

English

libslax Default Extension Libraries: bit, cURL, and xutil

libslax bit Extension Library

version 1.1 ;
ns bit extension = "http://xml.libslax.org/bit";

var $a = 63;
var $b = { expr "10111"; }

match / {
    <out> {
        <bit-and> {
            <a1> bit:and("101100", "100101");
            <a2> bit:and($a, $b);
            <a3> bit:and($a, number($b));
        }
        <bit-or> {
            <a1> bit:or("101100", "100101");
            <a2> bit:or($a, $b);
            <a3> bit:or($a, number($b));
        }
        <bit-mask> {
            <a1> bit:mask(0);
            <a2> bit:mask(8, 32);
        }
        <ops> {
            <a1> bit:to-int("10101");
        }
    }
}

Table 1 lists the functions available in the bit extension library and which are supported in SLAX 1.1 scripts.

libslax cURL Extension Library

• Understanding the cURL Extension Library
• curl:close
• curl:open
• curl:perform
• curl:set
• curl:single
• cURL Examples

Understanding the cURL Extension Library

cURL is a command-line tool that uses the libcurl library and permits data transfers using a number of protocols, including FTP, FTPS, HTTP, HTTPS, SCP, and SMTP. For more information about cURL, see the cURL website at http://curl.haxx.se/.

Call the cURL extension functions using the curl prefix and the function name. cURL operations are directed using a set of elements passed to the cURL extension functions.

Table 2 lists the supported operations in the cURL extension library and includes a description of each function. Table 3 and Table 4 list the supported elements and include the syntax and a description of each element. Table 3 lists elements used for web services operations, and Table 4 lists the elements used for e-mail operations.

The libcurl elements closely mimic the options used by the native C libcurl API in libcurl's curl_easy_setopt() function. Once the options are set, a call to curl_easy_perform() performs the requested transfer. For more information about the curl_easy_setopt() function, see http://curl.haxx.se/libcurl/c/curl_easy_setopt.html .

In the SLAX cURL extension library, the libcurl API options are represented as individual elements. For example, the <url> element is mapped to the CURLOPT_URL option , the <method> element is mapped to the CURLOPT_CUSTOMREQUEST option, and so forth.

• The curl:single() extension function permits a set of options to be used in a single transfer operation with no persistent connection handle.
• The curl:perform() extension function permits a set of options to be used with a persistent connection handle. The handle is returned from the curl:open() extension function and can be closed with the curl:close() extension function.
• The curl:set() extension function records a set of options for a connection handle and keeps those options active for the lifetime of the connection. For example, if the script needs to transfer a number of files, it can record the <username> and <password> options and avoid repeating them in every curl:perform() call.

curl:close

The curl:close() extension function closes an open connection. Further operations cannot be performed over the connection once it is closed.

The argument is the connection handle to close.

curl:open

The curl:open() extension function opens a connection to a remote server, allowing multiple operations over a single connection.

The returned object is a connection handle that can be passed to curl:perform() or curl:close().

curl:perform

The curl:perform() extension function performs simple transfers using a persistent connection handle provided by curl:open().

The arguments are the connection handle and a set of option elements. Supported cURL extension library elements are defined in Table 3 and Table 4.

The returned object is an XML hierarchy containing the results of the transfer. Table 5 lists the possible elements in the reply, and Table 6 lists the possible elements contained within the <header> element.

<header>
    <version>HTTP/1.1</version>
    <code>404</code>
    <message>Not Found</message>
    <field name="Content-Type">text/html</field>
    <field name="Content-Length">345</field>
    <field name="Date">Mon, 08 Aug 2011 03:40:21 GMT</field>
    <field name="Server">lighttpd/1.4.28 juisebox</field>
</header>

curl:set

The curl:set() extension function records a set of parameters that persist for the lifespan of a connection.

The arguments are the connection handle and a set of option elements. Supported cURL extension library elements are defined in Table 3 and Table 4.

curl:single

The curl:single() extension function performs transfer operations without using a persistent connection.

The returned object is identical in structure to the one returned by curl:perform(). Refer to curl:perform for additional information.

cURL Examples

The following examples show SLAX version 1.1 scripts that use the cURL extension library functions to perform operations.

version 1.1;

ns curl extension = "http://xml.libslax.org/curl";

param $url = "https://www.juniper.net";

match / {
    <op-script-results> {
        var $options = {
            <header name="client"> "slaxproc";
            <param name="smokey"> "bandit";
        }
        var $results = curl:single($url, $options);
        message "completed: " _ $results/headers/message;
        <curl> {
            copy-of $results;
        }
    }
}

version 1.1;

ns curl extension = "http://xml.libslax.org/curl";

param $url = "https://www.google.com/accounts/ClientLogin";
param $username;
param $password;

var $auth-params := {
    <url> $url;
    <method> "post";
    <insecure>;
    <param name="Email"> $username;
    <param name="Passwd"> $password;
    <param name="accountType"> "GOOGLE";
    <param name="service"> "wise";
    <param name="source"> "test-app";
}

match / {
    var $curl = curl:open();
    var $auth-cred = curl:perform($curl, $auth-params);

    <options> {
        for-each(slax:break-lines( $auth-cred/raw-data )) {
            if(starts-with(.,"Auth")) { 
                <header name="GData-Version"> "3.0";
                <header name="Authorization"> "GoogleLogin " _ .;
            }
        }
    }
    expr curl:close($curl);
}

version 1.1;

ns curl extension = "http://xml.libslax.org/curl";

param $server;

match / {
    <out> {
        var $info = {
            <method> "email";
            <server> $server;
            <from> "muffin@example.com";
            <to> "phil@example.net";
            <subject> "Testing...";
            <contents> "Hello,
This is an email.
Thanks,
 Phil
";
        }
        var $res = curl:single($info);
        <res> {
            copy-of $res;
        }
    }
}

libslax xutil Extension Library

Call the xutil extension functions using the xutil prefix and the function name. Table 7 lists the functions available in the xutil extension library and which are supported in SLAX 1.1 scripts.