request_data.h

Go to the documentation of this file.

/*
 * Copyright (C) Max Dymond, <cmeister2@gmail.com>, et al.
 *
 * SPDX-License-Identifier: curl
 */

 
#ifndef PROTO_FUZZER_REQUEST_DATA_H_
#define PROTO_FUZZER_REQUEST_DATA_H_
 
#include <curl/curl.h>
 
#include <array>
#include <cstddef>
#include <cstdint>
#include <string_view>
 
#include "curl_fuzzer.pb.h"
#include "proto_fuzzer/curl_raii.h"
#include "proto_fuzzer/scenario_limits.h"
 
namespace proto_fuzzer {

class UploadScriptState {
 public:
  using BeforeReadCallback = void (*)(void*);
 
  explicit UploadScriptState(const curl::fuzzer::proto::Scenario& scenario);

  UploadScriptState(curl::fuzzer::proto::Scenario&& scenario) = delete;
  UploadScriptState(const curl::fuzzer::proto::Scenario&& scenario) = delete;
 
  std::size_t Read(char* buffer, std::size_t capacity);
 
  int Seek(curl_off_t requested_offset, int origin);
 
  std::size_t data_size() const;
 
  std::size_t read_step_count() const;
 
  std::size_t offset() const;
 
  std::size_t seek_calls() const;
 
  bool scripted() const;
 
  CURLcode InstallAsMimePart(curl_mimepart* part);
 
 private:
  friend class ScenarioRequestData;
 
  void SetBeforeReadCallback(BeforeReadCallback callback, void* userdata);
 
  static std::size_t ReadCallback(char* buffer, std::size_t size, std::size_t nitems, void* userdata);
 
  static int SeekCallback(void* userdata, curl_off_t offset, int origin);
 
  std::string_view data_;
  std::array<std::size_t, scenario_limits::kMaxUploadReadSteps> read_sizes_;
  std::size_t read_step_count_;
  std::size_t total_size_;
  std::size_t max_read_size_;
  std::size_t offset_;
  std::size_t next_read_size_;
  std::size_t seek_calls_;
  curl::fuzzer::proto::UploadTerminal terminal_;
  curl::fuzzer::proto::UploadSeekResult seek_result_;
  BeforeReadCallback before_read_callback_;
  void* before_read_userdata_;
  bool scripted_;
};

struct RequestBuildStats {
  std::size_t request_headers = 0;
  std::size_t resolve_entries = 0;
  std::size_t telnet_options = 0;
  std::size_t mail_rcpt = 0;
  std::size_t mime_parts = 0;
  std::size_t mime_callback_parts = 0;
  std::size_t mime_headers = 0;
  std::size_t generated_mime_bytes = 0;
};

class ScenarioRequestData {
 public:
  ScenarioRequestData(CURL* easy, const curl::fuzzer::proto::Scenario& scenario, bool apply_resolve_entries = false);

  ScenarioRequestData(CURL* easy, curl::fuzzer::proto::Scenario&& scenario,
                      bool apply_resolve_entries = false) = delete;
  ScenarioRequestData(CURL* easy, const curl::fuzzer::proto::Scenario&& scenario,
                      bool apply_resolve_entries = false) = delete;
 
  ~ScenarioRequestData();
 
  ScenarioRequestData(const ScenarioRequestData&) = delete;
  ScenarioRequestData& operator=(const ScenarioRequestData&) = delete;
 
  const RequestBuildStats& stats() const;
 
  const UploadScriptState& upload_state() const;
 
  bool upload_callbacks_installed() const;
 
  bool resolve_entries_ready() const;
 
  void SetBeforeUploadReadCallback(UploadScriptState::BeforeReadCallback callback, void* userdata);
 
 private:
  CURL* easy_;
  CurlSlistPtr request_headers_;
  CurlSlistPtr resolve_entries_;
  CurlSlistPtr telnet_options_;
  CurlSlistPtr mail_rcpt_;
  UploadScriptState upload_state_;
  // Declared after upload_state_ so the MIME root releases its retained
  // callback userdata before the cursor is destroyed.
  CurlMimePtr mime_post_;
  bool upload_callbacks_installed_;
  bool resolve_entries_ready_;
  RequestBuildStats stats_;
};
 
}  // namespace proto_fuzzer
 
#endif  // PROTO_FUZZER_REQUEST_DATA_H_