www.openlinksw.com
docs.openlinksw.com

Book Home

Contents
Preface

Virtuoso Functions Guide

Administration
Aggregate Functions
Array Manipulation
BPEL APIs
Backup
Compression
Cursor
Date & Time Manipulation
Debug
Dictionary Manipulation
Encoding & Decoding
File Manipulation
Free Text
Hashing / Cryptographic
LDAP
Locale
Mail
Miscellaneous
Number
Phrases
RDF data
Remote SQL Data Source
Replication
SOAP
SQL
String
Transaction
Type Mapping
UDDI
User Defined Types & The CLR
VAD
Virtuoso Java PL API
Virtuoso Server Extension Interface (VSEI)
Web & Internet
dav add & update fun...
dav lock manipulatio...
dav manipulation fun...
dav search functions
dav_exp
lfs_exp
serv_queue_top
urlrewrite_create_re...
user_key_load
vhost_define
vhost_remove
webdav users & group...
client_attr
connection_get
connection_id
connection_is_dirty
connection_set
connection_vars
connection_vars_set
dbname
ftp_get
ftp_ls
ftp_put
get_certificate_info
get_keyword
get_keyword_ucase
http
http_acl_get
http_acl_remove
http_acl_set
http_body_read
http_client
http_client_ext
http_client_ip
http_debug_log
http_enable_gz
http_file
http_flush
http_get
http_header
http_header_get
http_kill
http_listen_host
http_lock
http_map_get
http_map_table
http_param
http_path
http_pending_req
http_physical_path
http_proxy
http_request_get
http_request_header
http_request_status
http_rewrite
http_root
http_unlock
http_url
http_value
http_xslt
json_parse
ses_connect
ses_disconnect
ses_read_line
ses_write
tcpip_gethostbyaddr
tcpip_gethostbyname
vsp_calculate_digest
wsdl_import_udt
XML
XPATH & XQUERY

Functions Index

USER_KEY_LOAD

Register and existing key.
USER_KEY_LOAD (in key_name varchar, in key_value any, in key_type varchar, in key_format varchar, in key_passwd varchar, [in key_pkey any]);
Description

This function is used to register and persist an existing key in the Virtuoso server. This is needs to be made once per key/certificate, and does not need to be repeated after server restart, unless the key is erased and has to be redefined.

Parameters
key_name – The key reference, as a 'Sample Key' or 'file:keys/srv.pem'
key_value – When the key is an internal reference i.e. non 'file:', the content of a key. The default value is NULL.
key_type – The key algorithm, possible values are "3DES", "RSA", "DSA", "X.509", "AES".
key_format – The format of the key content storage, possible values are "DER", "PEM", "PKCS12".
key_passwd – The password for opening the key if required, this can be NULL to indicate no password required.
key_pkey – When an X.509 certificate is imported, this can be supplied to load the corresponding private key also. This is optional. Note that when the PKCS#12 format is used to import an X.509 certificate, the private key is in the 'key_value', hence this parameter in such case must be omitted.
Return Types

None.

Example

To load and persist an X.509 certificate contained in the file wss.pfx in the server working directory one can use:

USER_KEY_LOAD ('file:wss.pfx', NULL, 'X.509', 'PKCS12', 'virt');

To load and persist a shared secret:

USER_KEY_LOAD ('WSDK Sample Symmetric Key', 'EE/uaFF5N3ZNJWUTR8DYe+OEbwaKQnso', '3DES', 'DER', null);

To load a DSA key contained in a file dsa.der:

USER_KEY_LOAD ('file:dsa.der', NULL, 'DSA', 'DER', null);