7cb37f16ae041bdb0cf8d8937b406378d7b9d60e
[vlc.git] / include / vlc_update.h
1 /*****************************************************************************
2  * vlc_update.h: VLC update and plugins download
3  *****************************************************************************
4  * Copyright © 2005-2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Antoine Cellerier <dionoea -at- videolan -dot- org>
8  *          Rafaël Carré <funman@videolanorg>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either release 2 of the License, or
13  * (at your option) any later release.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
23  *****************************************************************************/
24
25 #if !defined( __LIBVLC__ )
26   #error You are not libvlc or one of its plugins. You cannot include this file
27 #endif
28
29 #ifdef UPDATE_CHECK
30
31 #ifndef _VLC_UPDATE_H
32 #define _VLC_UPDATE_H
33
34 #include <vlc/vlc.h>
35
36 #include <vlc_stream.h>     /* key & signature downloading */
37 #include <vlc_strings.h>    /* b64 decoding */
38 #include <vlc_charset.h>    /* utf8_fopen() */
39 #include <gcrypt.h>         /* cryptography and digest algorithms */
40
41 /**
42  * \defgroup update Update
43  *
44  * @{
45  */
46
47 enum    /* Public key algorithms */
48 {
49     /* we will only use DSA public keys */
50     PUBLIC_KEY_ALGO_DSA = 0x11
51 };
52
53 enum    /* Digest algorithms */
54 {
55     /* and DSA use SHA-1 digest */
56     DIGEST_ALGO_SHA1    = 0x02
57 };
58
59 enum    /* Packet types */
60 {
61     SIGNATURE_PACKET    = 0x02,
62     PUBLIC_KEY_PACKET   = 0x06,
63     USER_ID_PACKET      = 0x0d
64 };
65
66 enum    /* Signature types */
67 {
68     BINARY_SIGNATURE        = 0x00,
69     TEXT_SIGNATURE          = 0x01,
70
71     /* Public keys signatures */
72     GENERIC_KEY_SIGNATURE   = 0x10, /* No assumption of verification */
73     PERSONA_KEY_SIGNATURE   = 0x11, /* No verification has been made */
74     CASUAL_KEY_SIGNATURE    = 0x12, /* Some casual verification */
75     POSITIVE_KEY_SIGNATURE  = 0x13  /* Substantial verification */
76 };
77
78
79 enum    /* Signature subpacket types */
80 {
81     ISSUER_SUBPACKET    = 0x10
82 };
83
84
85
86 struct public_key_packet_t
87 { /* a public key packet (DSA/SHA-1) is 418 bytes */
88
89     uint8_t version;      /* we use only version 4 */
90     uint8_t timestamp[4]; /* creation time of the key */
91     uint8_t algo;         /* we only use DSA */
92     /* the multi precision integers, with their 2 bytes length header */
93     uint8_t p[2+128];
94     uint8_t q[2+20];
95     uint8_t g[2+128];
96     uint8_t y[2+128];
97 };
98
99 /* used for public key signatures */
100 struct signature_packet_v4_t
101 { /* hashed_data or unhashed_data can be empty, so the signature packet is
102    * theorically at least 54 bytes long, but always more than that. */
103
104     uint8_t version;
105     uint8_t type;
106     uint8_t public_key_algo;
107     uint8_t digest_algo;
108     uint8_t hashed_data_len[2];
109     uint8_t *hashed_data;
110     uint8_t unhashed_data_len[2];
111     uint8_t *unhashed_data;
112     uint8_t hash_verification[2];
113
114     /* The part below is made of consecutive MPIs, their number and size being
115      * public-key-algorithm dependant.
116      * But since we use DSA signatures only, we fix it. */
117     uint8_t r[2+20];
118     uint8_t s[2+20];
119 };
120
121 /* Used for binary document signatures (to be compatible with older software)
122  * DSA/SHA-1 is always 65 bytes */
123 struct signature_packet_v3_t
124 {
125     uint8_t header[2];
126     uint8_t version;            /* 3 */
127     uint8_t hashed_data_len;    /* MUST be 5 */
128     uint8_t type;
129     uint8_t timestamp[4];       /* 4 bytes scalar number */
130     uint8_t issuer_longid[8];  /* The key which signed the document */
131     uint8_t public_key_algo;    /* we only know about DSA */
132     uint8_t digest_algo;        /* and his little sister SHA-1 */
133     uint8_t hash_verification[2];/* the 2 1st bytes of the SHA-1 hash */
134
135     /* The part below is made of consecutive MPIs, their number and size being
136      * public-key-algorithm dependant.
137      * But since we use DSA signatures only, we fix it. */
138     uint8_t r[2+20];
139     uint8_t s[2+20];
140 };
141
142 typedef struct public_key_packet_t public_key_packet_t;
143 typedef struct signature_packet_v4_t signature_packet_v4_t;
144 typedef struct signature_packet_v3_t signature_packet_v3_t;
145
146 struct public_key_t
147 {
148     uint8_t longid[8];       /* Long id */
149     uint8_t *psz_username;    /* USER ID */
150
151     public_key_packet_t key;       /* Public key packet */
152
153     signature_packet_v4_t sig;     /* Signature packet, by the embedded key */
154 };
155
156 typedef struct public_key_t public_key_t;
157
158 /* We trust this public key, and by extension, also keys signed by it. */
159 static uint8_t videolan_public_key_longid[8] = {
160   0x90, 0x28, 0x17, 0xE4, 0xAA, 0x5F, 0x4D, 0xE6 
161 };
162
163 static uint8_t videolan_public_key[] = {
164 "-----BEGIN PGP PUBLIC KEY BLOCK-----\n"
165 "Version: GnuPG v2.0.4 (FreeBSD)\n"
166 "\n"
167 "mQGiBEWbjf8RBAC+4m2yYYzuA0+D5JQatKmoxG4z3+bat08tMz0YvBUp1UU+95i4\n"
168 "cP9ndklv3yzhtZ4MIx5yy64FXtPi0/NQiikEVYPYn2KMO4LCfZCwYBEizVWzABya\n"
169 "LZcffCP/3VhoR90NUluWyi+zVAn9KNIRlnhnYpDDlI76fCrTTHDCtgpImwCg7VzB\n"
170 "4L6O0JpUJBCZOCAPJNYirUkD/3uCZe4vK4kLW+W3HB+grMCI1uFULmVSKMBQZc+p\n"
171 "dqDq++u3zYGqiMNaVrLg/J4GSH/P0ossXEtmTVjLHF4nJ7HXfIjqkqdkxq7g9odY\n"
172 "/dkA/aC7z4JBgcYfRnDMqfL12C+3b+KSwxQSzPcbvsFYm2KTgteLwG3mRlpL7Dh5\n"
173 "S70nBAC1PkIl7mP4OL7vpQk9dkdQCARJLgyn5pu/pZV7He4fDLHkUr/atnYaIHk1\n"
174 "15xl/ziHcBql2WmF0Uff9SuuNOi/hFCuWZSwPKsgtIhYZ5ut4FrBAVkqHV2CgxFp\n"
175 "aSiA7+FTG91++LDsg2xrHyTRW+fQnPdpf5a4H1fF15azo40h17QjVmlkZW9MQU4g\n"
176 "UmVsZWFzZSBTaWduaW5nIEtleSAoMjAwNymIRgQQEQIABgUCRZ41PgAKCRDDZ9i5\n"
177 "gcrKhPmUAJ49Krgt6ZPZZ2YkW7fWFwTvSgGongCePDjnFh1g4078f7lycT4wFk/c\n"
178 "vPiIRgQQEQIABgUCRZ71NQAKCRD9Ibw7rD4IebztAKCxuyWCjF2JPAe1hdZqNNbE\n"
179 "/gWDRACfaBw6mpHh3+jZuNnRk6NctFMbTzWIRgQTEQIABgUCRZuOiQAKCRDD7G2+\n"
180 "3W0SvRkEAJ9cCPrbfzoTHKUVlGLAKbx5pcoutQCdENlo4nwXbQHaREDqm+ISBU3p\n"
181 "iXeIZgQTEQIAJgUCRZuN/wIbAwUJAeEzgAYLCQgHAwIEFQIIAwQWAgMBAh4BAheA\n"
182 "AAoJEJAoF+SqX03m4ZQAoOSj3JzzUuY+n/oS0Y4/yZ4tThNNAJ4h+9FacWApQdNJ\n"
183 "+PcydRFEEm203LkCDQRFm44DEAgAlNLlnyIkLJ/Uyncsd5nB46LqQpJDLJ3AalfN\n"
184 "44Vy3aOG+aA7JsNL5T5r5WRGnAf41qSOFiuZHwjfrtKb4TWkcfWlpsi8t5uasII9\n"
185 "WAVX2aVIbiPMNWUnhQIn8rjCRLm2t/0Hch0HDbXaI/hvub5qhmSHfmqzlkuEUyVu\n"
186 "H+beivX8pQwxqpcWXrmwuNzhISR1DsWBn5u0WcOSqUDtFG5Me8AuPFR1oxdYTtvC\n"
187 "vqlVnw6ag3QuNqaAgWDU5Ug/U10ZxCZTn5TAcp+1ZDlM/dXIwh8wKXDjiKqHgYg1\n"
188 "VLQ4fOsscTJoUDOaobeaVwTcDaSB4yQ3bhB2q5fLKqj+bNrY9wADBQf/Rw92M9b/\n"
189 "JRs5IpX3fcrgHetVLHPiRuW8btD6EkmlgyRFOwOCzOSlSzFW6DKFrbOvd01EWkaP\n"
190 "4PWJNW7b7OZqzK+UWzlWTgtV/2iUJtHg3+euZRdc5V9gqW17+HIAxjJVE53Syn8u\n"
191 "kiJpk7HebtQo/v/pk3jtxdeJU3fY8ZAKJFl8V9aAj7ATFaAhYohzyKTRYc04F0n6\n"
192 "VJDtwQkobdhq2//+5hSVrJ9wXRRF6XFVxc32NinqDEYrJUvTVayYu28Ivg4CTlts\n"
193 "a+R7x92aDVT2KT+voPIGZxPYjALGa/I2hrlEYD9CiRFNBKAzRiNGAOo67SNI4hDu\n"
194 "rFWRmMNOONWpIIhPBBgRAgAPBQJFm44DAhsMBQkB4TOAAAoJEJAoF+SqX03m57kA\n"
195 "oMPb2o2D9gSwQFKXhamx2YdrykHOAKDqQ1tHH3ULY5cLLAKVaQtsNhVEtQ==\n"
196 "=qrc1\n"
197 "-----END PGP PUBLIC KEY BLOCK-----\n"
198 };
199
200 enum
201 {
202     UpdateReleaseStatusOlder,
203     UpdateReleaseStatusEqual,
204     UpdateReleaseStatusNewer
205 };
206
207 /**
208  * Describes an update VLC release number
209  */
210 struct update_release_t
211 {
212     int i_major;        ///< Version major
213     int i_minor;        ///< Version minor
214     int i_revision;     ///< Version revision
215     unsigned char extra;///< Version extra
216     char* psz_url;      ///< Download URL
217     char* psz_desc;     ///< Release description
218 };
219
220 /**
221  * The update object. Stores (and caches) all information relative to updates
222  */
223 struct update_t
224 {
225     libvlc_int_t *p_libvlc;
226     vlc_mutex_t lock;
227     struct update_release_t release;    ///< Release (version)
228     public_key_t *p_pkey;
229 };
230
231 #define update_New( a ) __update_New( VLC_OBJECT( a ) )
232
233 VLC_EXPORT( update_t *, __update_New, ( vlc_object_t * ) );
234 VLC_EXPORT( void, update_Delete, ( update_t * ) );
235 VLC_EXPORT( void, update_Check, ( update_t *, void (*callback)( void* ), void * ) );
236 VLC_EXPORT( int, update_CompareReleaseToCurrent, ( update_t * ) );
237 VLC_EXPORT( void, update_Download, ( update_t *, char* ) );
238
239 /**
240  * @}
241  */
242
243 #endif
244
245 #endif