2 * ra_svn.h : private declarations for the ra_svn module
4 * ====================================================================
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements. See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership. The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License. You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied. See the License for the
19 * specific language governing permissions and limitations
21 * ====================================================================
31 #endif /* __cplusplus */
33 #include <apr_network_io.h>
34 #include <apr_file_io.h>
35 #include <apr_thread_proc.h>
37 #include "svn_ra_svn.h"
39 #include "private/svn_ra_svn_private.h"
41 /* Callback function that indicates if a svn_ra_svn__stream_t has pending
44 typedef svn_boolean_t (*ra_svn_pending_fn_t)(void *baton);
46 /* Callback function that sets the timeout value for a svn_ra_svn__stream_t. */
47 typedef void (*ra_svn_timeout_fn_t)(void *baton, apr_interval_time_t timeout);
49 /* A stream abstraction for ra_svn.
51 * This is different from svn_stream_t in that it provides timeouts and
52 * the ability to check for pending data.
54 typedef struct svn_ra_svn__stream_st svn_ra_svn__stream_t;
56 /* Handler for blocked writes. */
57 typedef svn_error_t *(*ra_svn_block_handler_t)(svn_ra_svn_conn_t *conn,
61 /* The default "user agent". */
62 #define SVN_RA_SVN__DEFAULT_USERAGENT "SVN/" SVN_VER_NUMBER\
63 " (" SVN_BUILD_TARGET ")"
65 /* The size of our per-connection read and write buffers. */
66 #define SVN_RA_SVN__PAGE_SIZE 4096
67 #define SVN_RA_SVN__READBUF_SIZE (4 * SVN_RA_SVN__PAGE_SIZE)
68 #define SVN_RA_SVN__WRITEBUF_SIZE (4 * SVN_RA_SVN__PAGE_SIZE)
70 /* Create forward reference */
71 typedef struct svn_ra_svn__session_baton_t svn_ra_svn__session_baton_t;
73 /* This structure is opaque to the server. The client pokes at the
74 * first few fields during setup and cleanup. */
75 struct svn_ra_svn_conn_st {
78 char write_buf[SVN_RA_SVN__WRITEBUF_SIZE];
79 char read_buf[SVN_RA_SVN__READBUF_SIZE];
84 svn_ra_svn__stream_t *stream;
85 svn_ra_svn__session_baton_t *session;
87 /* Although all reads and writes go through the svn_ra_svn__stream_t
88 interface, SASL still needs direct access to the underlying socket
89 for stuff like IP addresses and port numbers. */
91 svn_boolean_t encrypted;
94 /* abortion check control */
95 apr_size_t written_since_error_check;
96 apr_size_t error_check_interval;
97 svn_boolean_t may_check_for_error;
101 const char *repos_root;
103 /* TX block notification target */
104 ra_svn_block_handler_t block_handler;
107 /* server settings */
108 apr_hash_t *capabilities;
109 int compression_level;
110 apr_size_t zero_copy_limit;
112 /* who's on the other side of the connection? */
116 svn_delta_shim_callbacks_t *shim_callbacks;
122 struct svn_ra_svn__session_baton_t {
124 svn_ra_svn_conn_t *conn;
125 svn_boolean_t is_tunneled;
128 const char *hostname; /* The remote hostname. */
129 const char *realm_prefix;
130 const char **tunnel_argv;
131 const svn_ra_callbacks2_t *callbacks;
132 void *callbacks_baton;
133 apr_off_t bytes_read, bytes_written; /* apr_off_t's because that's what
134 the callback interface uses */
135 const char *useragent;
138 /* Set a callback for blocked writes on conn. This handler may
139 * perform reads on the connection in order to prevent deadlock due to
140 * pipelining. If callback is NULL, the connection goes back to
141 * normal blocking I/O for writes.
143 void svn_ra_svn__set_block_handler(svn_ra_svn_conn_t *conn,
144 ra_svn_block_handler_t callback,
147 /* Return true if there is input waiting on conn. */
148 svn_boolean_t svn_ra_svn__input_waiting(svn_ra_svn_conn_t *conn,
151 /* CRAM-MD5 client implementation. */
152 svn_error_t *svn_ra_svn__cram_client(svn_ra_svn_conn_t *conn, apr_pool_t *pool,
153 const char *user, const char *password,
154 const char **message);
156 /* Return a pointer to the error chain child of ERR which contains the
157 * first "real" error message, not merely one of the
158 * SVN_ERR_RA_SVN_CMD_ERR wrapper errors. */
159 svn_error_t *svn_ra_svn__locate_real_error_child(svn_error_t *err);
161 /* Return an error chain based on @a params (which contains a
162 * command response indicating failure). The error chain will be
163 * in the same order as the errors indicated in @a params. Use
164 * @a pool for temporary allocations. */
165 svn_error_t *svn_ra_svn__handle_failure_status(const apr_array_header_t *params,
168 /* Returns a stream that reads/writes from/to SOCK. */
169 svn_ra_svn__stream_t *svn_ra_svn__stream_from_sock(apr_socket_t *sock,
172 /* Returns a stream that reads from IN_FILE and writes to OUT_FILE. */
173 svn_ra_svn__stream_t *svn_ra_svn__stream_from_files(apr_file_t *in_file,
174 apr_file_t *out_file,
177 /* Create an svn_ra_svn__stream_t using READ_CB, WRITE_CB, TIMEOUT_CB,
178 * PENDING_CB, and BATON.
180 svn_ra_svn__stream_t *svn_ra_svn__stream_create(void *baton,
181 svn_read_fn_t read_cb,
182 svn_write_fn_t write_cb,
183 ra_svn_timeout_fn_t timeout_cb,
184 ra_svn_pending_fn_t pending_cb,
187 /* Write *LEN bytes from DATA to STREAM, returning the number of bytes
190 svn_error_t *svn_ra_svn__stream_write(svn_ra_svn__stream_t *stream,
191 const char *data, apr_size_t *len);
193 /* Read *LEN bytes from STREAM into DATA, returning the number of bytes
196 svn_error_t *svn_ra_svn__stream_read(svn_ra_svn__stream_t *stream,
197 char *data, apr_size_t *len);
199 /* Read the command word from CONN, return it in *COMMAND and skip to the
200 * end of the command. Allocate data in POOL.
202 svn_error_t *svn_ra_svn__read_command_only(svn_ra_svn_conn_t *conn,
204 const char **command);
206 /* Set the timeout for operations on STREAM to INTERVAL. */
207 void svn_ra_svn__stream_timeout(svn_ra_svn__stream_t *stream,
208 apr_interval_time_t interval);
210 /* Return whether or not there is data pending on STREAM. */
211 svn_boolean_t svn_ra_svn__stream_pending(svn_ra_svn__stream_t *stream);
213 /* Respond to an auth request and perform authentication. Use the Cyrus
214 * SASL library for mechanism negotiation and for creating authentication
217 svn_ra_svn__do_cyrus_auth(svn_ra_svn__session_baton_t *sess,
218 const apr_array_header_t *mechlist,
219 const char *realm, apr_pool_t *pool);
221 /* Same as svn_ra_svn__do_cyrus_auth, but uses the built-in implementation of
222 * the CRAM-MD5, ANONYMOUS and EXTERNAL mechanisms. Return the error
223 * SVN_ERR_RA_SVN_NO_MECHANSIMS if we cannot negotiate an authentication
224 * mechanism with the server. */
226 svn_ra_svn__do_internal_auth(svn_ra_svn__session_baton_t *sess,
227 const apr_array_header_t *mechlist,
228 const char *realm, apr_pool_t *pool);
230 /* Having picked a mechanism, start authentication by writing out an
231 * auth response. MECH_ARG may be NULL for mechanisms with no
232 * initial client response. */
233 svn_error_t *svn_ra_svn__auth_response(svn_ra_svn_conn_t *conn,
235 const char *mech, const char *mech_arg);
237 /* Looks for MECH as a word in MECHLIST (an array of svn_ra_svn_item_t). */
238 svn_boolean_t svn_ra_svn__find_mech(const apr_array_header_t *mechlist,
241 /* Initialize the SASL library. */
242 svn_error_t *svn_ra_svn__sasl_init(void);
247 #endif /* __cplusplus */
249 #endif /* RA_SVN_H */