This file is indexed.

/usr/include/Netxx/TLS/Stream.h is in libnetxx-dev 0.3.2-2ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
/*
 * Copyright (C) 2001-2003 Peter J Jones (pjones@pmade.org)
 * All Rights Reserved
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of the Author nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

/** @file
 * This file contains the definition of the Netxx::TLS::Stream class.
**/

#ifndef _Netxx_TLS_Stream_h_
#define _Netxx_TLS_Stream_h_

// Netxx includes
#include <Netxx/Types.h>
#include <Netxx/StreamBase.h>
#include <Netxx/TLS/Context.h>

namespace Netxx {
    // forward declarations
    class ProbeInfo;
    
namespace TLS {
    // forward declaration
    class Certificate;
    struct tls_pimpl;
	
/**
 * The Netxx::TLS::Stream class is used to send and receive data on a
 * connected TLS socket. It has two constructors, one that connects to the
 * given address and another that uses an already connected socket.
 *
 * When using the constructor that can take a socket descriptor you must
 * specifiy whether the TLS::Stream should operate in server or client mode.
 * This is due to the TLS protocol being a little different for a client
 * than it is for a server.
**/
class Stream : public Netxx::StreamBase {
public:
    /**
     * The connection mode for the Netxx::TLS::Stream
     */
    enum Mode {
	mode_client, ///< This Netxx::TLS::Stream should act as a TLS client.
	mode_server  ///< This Netxx::TLS::Stream shoudl act as a TLS server.
    };

    //####################################################################
    /** 
     * Construct a new Netxx::TLS::Stream object. This constructor will
     * connect to the peer given in the Netxx::Address class.
     *
     * @param context The context to use for this stream.
     * @param address The address to connect to.
     * @param timeout The timeout to use for the connect and stream operations.
     * @author Peter Jones
    **/
    //####################################################################
    explicit Stream (Context &context, const Address &address, const Timeout &timeout=Timeout());

    //####################################################################
    /** 
     * Construct a new Netxx::TLS::Stream object. This constructor will
     * connect to the given address. The given address string is passed to a
     * Netxx::Address class.
     *
     * @param context The contect to use for this stream.
     * @param addr The address to connect to.
     * @param default_port The port to connect to if one is not given in addr.
     * @param timeout The timeout to use for the connect and stream operations.
     * @author Peter Jones
    **/
    //####################################################################
    Stream (Context &context, const char *addr, port_type default_port, const Timeout &timeout=Timeout());

    //####################################################################
    /** 
     * Construct a new Netxx::TLS::Stream object and start TLS on the given
     * socket file descriptor. This object will then own the socket file
     * descriptor and will close it when it is done with it.
     *
     * A mode is needed so that the Netxx::TLS::Stream will know what parts
     * of the TLS protocol to use, client or server. Default is client.
     *
     * @param context The TLS::Context to use for this stream.
     * @param socketfd The socket file descriptor to use.
     * @param mode Is this a TLS server or client?
     * @param timeout The Timeout to use for stream operations.
     * @author Peter Jones
    **/
    //####################################################################
    Stream (Context &context, socket_type socketfd, Mode mode=mode_client, const Timeout &timeout=Timeout());

    //####################################################################
    /** 
     * Netxx::TLS::Stream destructor. Shutdown the TLS connection if
     * necessary and clean things up.
     *
     * @author Peter Jones
    **/
    //####################################################################
    ~Stream (void);

    //####################################################################
    /** 
     * Read data from the TLS connection and place it into the given buffer.
     * If an error occures this function will throw an exception.
     *
     * @param buffer The buffer to store the read data into.
     * @param length The size of the given buffer.
     * @return Greater than 0: The number of bytes stored in the buffer.
     * @return 0: The connected peer closed the connection.
     * @return -1: A timeout occured.
     * @author Peter Jones
    **/
    //####################################################################
    signed_size_type read  (void *buffer, size_type length);

    //####################################################################
    /** 
     * Write data from the given buffer to the TLS conection. If an error
     * occures this function will throw an exception.
     *
     * @param buffer The buffer to write to the connection.
     * @param length The number of bytes to use from the buffer.
     * @return Greater than 0: The number of bytes written to the connection.
     * @return 0: The connected peer closed the connection.
     * @return -1: A timeout occured.
     * @author Peter Jones
    **/
    //####################################################################
    signed_size_type write (const void *buffer, size_type length);

    //####################################################################
    /** 
     * Close the connection. Once you do this you can't call read or write
     * anymore. This is normally done by the destructor.
     *
     * @author Peter Jones
    **/
    //####################################################################
    void close (void);

    //####################################################################
    /** 
     * Get the connected peer's certificate.
     *
     * @return A valid certificate if the peer gave one to you
     * @return An invalid certificate if the peer does not have one
     * @author Alex Mitrofanov
    **/
    //####################################################################
    const Certificate& get_peer_cert (void) const;
    
    //####################################################################
    /** 
     * Get the certificate for the issuer of the connected peer's
     * certificate.
     *
     * @return A valid certificate if the peer gave one and it was signed by an issuer
     * @return An invalid certificate if there was no peer cert or no issuer
     * @author Alex Mitrofanov
    **/
    //####################################################################
    const Certificate& get_issuer_cert (void) const;

    //####################################################################
    /** 
     * Return the current socket file descriptor in use.
     *
     * @author Alex Mitrofanov
    **/
    //####################################################################
    socket_type get_socketfd (void) const;

    //####################################################################
    /** 
     * Get information about how this TLS::Stream should be probed from the
     * Netxx::Probe class.
     *
     * @return A Netxx::ProbeInfo object.
     * @author Peter Jones
    **/
    //####################################################################
    const ProbeInfo* get_probe_info (void) const;

private:
    tls_pimpl *pimpl_;
    Stream (const Stream&);
    Stream& operator= (const Stream&);
}; // end Netxx::TLS::Stream class

}} // end Netxx and TLS namespaces
#endif