-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathccnxSimpleFileTransfer_Common.h
173 lines (152 loc) · 7.94 KB
/
ccnxSimpleFileTransfer_Common.h
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
/*
* Copyright (c) 2014-2015, Xerox Corporation (Xerox) and Palo Alto Research Center, Inc (PARC)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * 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.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 XEROX OR PARC 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.
*
* ################################################################################
* #
* # PATENT NOTICE
* #
* # This software is distributed under the BSD 2-clause License (see LICENSE
* # file). This BSD License does not make any patent claims and as such, does
* # not act as a patent grant. The purpose of this section is for each contributor
* # to define their intentions with respect to intellectual property.
* #
* # Each contributor to this source code is encouraged to state their patent
* # claims and licensing mechanisms for any contributions made. At the end of
* # this section contributors may each make their own statements. Contributor's
* # claims and grants only apply to the pieces (source code, programs, text,
* # media, etc) that they have contributed directly to this software.
* #
* # There is no guarantee that this section is complete, up to date or accurate. It
* # is up to the contributors to maintain their portion of this section and up to
* # the user of the software to verify any claims herein.
* #
* # Do not remove this header notification. The contents of this section must be
* # present in all distributions of the software. You may only modify your own
* # intellectual property statements. Please provide contact information.
*
* - Palo Alto Research Center, Inc
* This software distribution does not grant any rights to patents owned by Palo
* Alto Research Center, Inc (PARC). Rights to these patents are available via
* various mechanisms. As of January 2016 PARC has committed to FRAND licensing any
* intellectual property used by its contributions to this software. You may
* contact PARC at [email protected] for more information or visit http://www.ccnx.org
*/
/**
* @author Alan Walendowski, Palo Alto Research Center (Xerox PARC)
* @copyright (c) 2014-2015, Xerox Corporation (Xerox) and Palo Alto Research Center, Inc (PARC). All rights reserved.
*/
#ifndef ccnxSimpleFileTransferCommon_h
#define ccnxSimpleFileTransferCommon_h
#include <stdint.h>
#include <parc/security/parc_Identity.h>
#include <ccnx/common/ccnx_Name.h>
#include <ccnx/api/ccnx_Portal/ccnx_Portal.h>
/**
* See ccnxSimpleFileTransferCommon.h for the initilization of these constants.
*/
extern const char *ccnxSimpleFileTransferCommon_TutorialName;
/**
* The CCNx Name prefix we'll use for the tutorial.
*/
extern const char *ccnxSimpleFileTransferCommon_NamePrefix;
/**
* The size of a chunk. We break CCNx Content payloads up into pieces of this size.
* 1200 was chosen as a size that should prevent IP fragmentation of CCNx ContentObject Messages.
*/
extern const uint32_t ccnxSimpleFileTransferCommon_DefaultChunkSize;
/**
* The string we use for the 'fetch' command.
*/
extern const char *ccnxSimpleFileTransferCommon_CommandFetch;
/**
* The string we use for the 'list' command.
*/
extern const char *ccnxSimpleFileTransferCommon_CommandList;
/**
* Creates and returns a new randomly generated Identity, which is required for signing.
* In a real application, you would actually use a real Identity. The returned instance
* must eventually be released by calling parcIdentity_Release().
*
* @param [in] keystoreName The name of the file to save the new identity.
* @param [in] keystorePassword The password of the file holding the identity.
* @param [in] subjectName The name of the owner of the identity.
*
*
* @return A new, randomly generated, PARCIdentity instance.
*/
PARCIdentity *ccnxSimpleFileTransferCommon_CreateAndGetIdentity(const char *keystoreName,
const char *keystorePassword,
const char *subjectName);
/**
* Initialize and return a new instance of CCNxPortalFactory. A randomly generated identity is
* used to initialize the factory. The returned instance must eventually be released by calling
* ccnxPortalFactory_Release().
*
* @param [in] keystoreName The name of the file to save the new identity.
* @param [in] keystorePassword The password of the file holding the identity.
* @param [in] subjectName The name of the owner of the identity.
*
* @return A new instance of a CCNxPortalFactory initialized with a randomly created identity.
*/
CCNxPortalFactory *ccnxSimpleFileTransferCommon_SetupPortalFactory(const char *keystoreName,
const char *keystorePassword,
const char *subjectName);
/**
* Given a CCNxName instance, return the numeric value of the chunk specified by the Name.
* The chunk number is contained in the final NameSegment of the Name.
*
* @param [in] name A CCNxName instance from which to extract the chunk number.
* @return The chunk number encoded in the supplied CCNxName instance.
*/
uint64_t ccnxSimpleFileTransferCommon_GetChunkNumberFromName(const CCNxName *name);
/**
* Given a CCNxName instance, return a new CCNxName that is the same as the original
* except without the final segment copied. We use this to strip the chunk number from a
* supplied CCNxName.
*
* @param [in] name A CCNxName instance from which to extract the base name.
* @return A new CCNxName instance that is the same as the original name, but without the final segment.
*/
CCNxName *ccnxSimpleFileTransferCommon_CreateWithBaseName(const CCNxName *name);
/**
* Given a CCNxName instance, structured for this tutorial, return a string representation
* of the file name in the CCNxName. For the tutorial, this is located in the second to
* last CCnxNameSegment in the CCNxName. The string returned here must eventually be freed
* by calling parcMemory_Deallocate().
*
* @param [in] name A CCNxName instance from which to extract the filename.
* @return A C string representation of the filename encoded in the supplied CCNxName instance.
*/
char *ccnxSimpleFileTransferCommon_CreateFileNameFromName(const CCNxName *name);
/**
* Given a CCNxName instance, structured for this tutorial, return a string representation
* of the command string (e.g. "fetch" or "list"). For the tutorial, this is located in the CCnxNameSegment
* immediately following the domain prefix in the CCNxName. The string returned here must eventually be freed
* by calling parcMemory_Deallocate().
*
* @param [in] name A CCNxName instance from which to extract the filename.
* @return A C string representation of the filename encoded in the supplied CCNxName instance.
*/
char *ccnxSimpleFileTransferCommon_CreateCommandStringFromName(const CCNxName *name, const CCNxName *domainPrefix);
#endif // ccnxSimpleFileTransferCommon.h