summaryrefslogtreecommitdiffstats
path: root/libcsoap/soap-xmlsec.h
blob: 99434981d689609b61adaa5c5b1b4bd31c135216 (plain)
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
/******************************************************************
 *  $Id: soap-xmlsec.h,v 1.3 2006/11/28 23:45:57 m0gg Exp $
 *
 * CSOAP Project:  A SOAP client/server library in C
 * Copyright (C) 2006 Heiko Ronsdorf
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA  02111-1307, USA.
 * 
 * Email: hero@persua.de
 ******************************************************************/
#ifndef __csoap_xmlsec_h
#define __csoap_xmlsec_h

/** @file
 *
 * Web Services Security
 *
 * This module is implemented using the xmlsec1 library.
 *
 * @author	H. Ronsdorf
 * @version	$Revision: 1.3 $
 *
 * @see http://www.w3.org/TR/SOAP-dsig/,
 *      http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=wss,
 *      http://www.aleksey.com/xmlsec/
 *
 */

#define SOAP_SECURITY_NAMESPACE	"http://schemas.xmlsoap.org/soap/security/2000-12"
#define SOAP_SECURITY_PREFIX	"SOAP-SEC"

/**
 *
 * Commandline argument to enabled WS-Security.
 *
 */
#define CSOAP_ENABLE_XMLSEC	"-CSOAPxmlsec"

/**
 *
 * Commandline argument to set the keyfile. If this argument is not specified a
 * random key will be used.
 *
 */
#define CSOAP_XMLSEC_KEYFILE	"-CSOAPkeyfile"

/**
 *
 * Commandline argument to set the password of the key.
 *
 */
#define CSOAP_XMLSEC_PASSWORD	"-CSOAPpassword"

/**
 *
 * Commandline argument to set a file of certificates.
 *
 */
#define CSOAP_XMLSEC_CERTFILE	"-CSOAPcertfile"

#ifdef __cplusplus
extern "C" {
#endif

/**
 *
 * Initializes the WS-Security subsystem.
 *
 * @param argc commandline arg count
 * @param argv commandline arg vector
 *
 * @return H_OK on success
 *
 */
extern herror_t soap_xmlsec_server_init_args(int argc, char **argv);

/**
 *
 * Initializes the WS-Security subsystem.
 *
 * @param argc commandline arg count
 * @param argv commandline arg vector
 *
 * @return H_OK on success
 *
 */
extern herror_t soap_xmlsec_client_init_args(int argc, char **argv);

/**
 *
 * Sign a XML document contained in a SOAP Envelope. The key specified on the
 * commandline is used for signating the document.
 *
 * @param envelope The SOAP envelope to be signed.
 *
 * @return H_OK on success
 *
 */
extern herror_t soap_xmlsec_sign(struct SoapCtx *context);

/**
 *
 * Verify a XML documents signature contained in a SOAP Envelope.
 *
 * @param envelope The SOAP envelope to be verified.
 *
 * @return H_OK on success
 *
 */
extern herror_t soap_xmlsec_verify(struct SoapCtx *context);

/**
 *
 * Encrypt a XML document contained in a SOAP envelope.
 *
 * @param envelope The SOAP envelope to be encrypted.
 *
 * @return H_OK on success
 *
 */
extern herror_t soap_xmlsec_encrypt(struct SoapCtx *context);

/**
 *
 * Decrupt a XML document contained in a SOAP envelope.
 *
 * @param envelope The SOAP envelope to be decrypted.
 *
 * @return H_OK on success
 *
 */
extern herror_t soap_xmlsec_decrypt(struct SoapCtx *context);


/**
 *
 * Frees the resources needed by the XML security subsystem.
 *
 */
extern void soap_xmlsec_destroy(void);

#ifdef __cplusplus
}
#endif

#endif