From patchwork Tue Nov 26 01:06:22 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "kallisti5 (Code Review)" X-Patchwork-Id: 3960 Return-Path: Delivered-To: patchwork@openvpn.net Received: by 2002:a05:7000:92cd:b0:5db:5963:ef83 with SMTP id e13csp1734663mai; Mon, 25 Nov 2024 17:06:55 -0800 (PST) X-Forwarded-Encrypted: i=2; AJvYcCWqn37Go8a9vXpxwZJtgXAGzAh0PA1PCHYHsacpVzf59ikBzwtSIwGnyxJYZZPNSl6TAejcsS8zPLw=@openvpn.net X-Google-Smtp-Source: AGHT+IGO5fm3jvvrM3CtR6IYlfq637McvnSDuIofNPXwP8umuHdVUDN8FtWIF/gP95xvj+ad5cV1 X-Received: by 2002:a05:6602:6c0a:b0:83a:b52b:5cb5 with SMTP id ca18e2360f4ac-83ecdc53a05mr1644579539f.5.1732583215484; Mon, 25 Nov 2024 17:06:55 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1732583215; cv=none; d=google.com; s=arc-20240605; b=iiGU/YWNCw01Lk8CbEChfNW283L71HGDpIB41ELDmF8HlK90evcbS3RgVj8NtNfkkW Twf/Zx5sGT0ZIB+sPZ99zHYSuib4Z6W0/K+jy7/Sw48Ub+hfnR/N7+SYlQFq7F1Kth8D RtPzk1BpDzuPm9oG5LSXb/xfaeQDbY+/XSsI42DZ5/lhIGyl6ojAEfMgkPGXHwkQn2BD wM9txNTKiMSI6SMT63MgmZl8EzQfhYYGi8UNJK+eAcGP02s6FS0BgQGe31uEuyDDr80A znGgZxP/LrwmvGmKZDx48CJ6kkKFu8NhWENCO/dzgkVwOYnxjJP2EJJapm7YcI32FvjW MkmQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20240605; h=errors-to:cc:reply-to:list-subscribe:list-help:list-post :list-archive:list-unsubscribe:list-id:precedence:subject:user-agent :mime-version:message-id:references:auto-submitted:to:date:from :dkim-signature:dkim-signature:dkim-signature; bh=mZ2hvjXqY05NMmyV38kabLQYVDcvPeyIgxiWH7FsBwQ=; fh=GFP4qDxgyJ2WEPo/oeLZg3Mj4NqvY1j2nTvTt7psNwg=; b=kzNEWrRUp3npQrsjNdyURFq8mzB5ELUshsCPgTgwHu79MYDleaokKFPDqKUC30cjOE KzUjh9VFvs6Kd6y05L+8dpfAQsQCx4kSbZUhY054MHs49COVIfejlHQsYtA3tRdMonoG SZPvrATxrjKzGI3JiRqXQRQuiFvbc6e4BWVYEpkdElHG5sgLyvqK2HNzNFK9J3/ALjZS R6bRgICjZX7oyCnu+sInq+3eEzZG9+eEpvLs/uCPeiMjZms5ypbnQoBFKJ+yvsuPFrQu VoJpVINLYr4Wb42Xn8XQYD18xF6izYZapnSNO7dBPqUZ76+2MUkbeqyl5eijVgcYhjD3 E1ug==; dara=google.com ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@sourceforge.net header.s=x header.b=FNt0hYgD; dkim=neutral (body hash did not verify) header.i=@sf.net header.s=x header.b=Oajvn3Ut; dkim=neutral (body hash did not verify) header.i=@openvpn.net header.s=google header.b=KVYepNES; spf=pass (google.com: domain of openvpn-devel-bounces@lists.sourceforge.net designates 216.105.38.7 as permitted sender) smtp.mailfrom=openvpn-devel-bounces@lists.sourceforge.net; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=openvpn.net; dara=fail header.i=@openvpn.net Received: from lists.sourceforge.net (lists.sourceforge.net. [216.105.38.7]) by mx.google.com with ESMTPS id 8926c6da1cb9f-4e20af70a9esi1087431173.129.2024.11.25.17.06.55 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Mon, 25 Nov 2024 17:06:55 -0800 (PST) Received-SPF: pass (google.com: domain of openvpn-devel-bounces@lists.sourceforge.net designates 216.105.38.7 as permitted sender) client-ip=216.105.38.7; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@sourceforge.net header.s=x header.b=FNt0hYgD; dkim=neutral (body hash did not verify) header.i=@sf.net header.s=x header.b=Oajvn3Ut; dkim=neutral (body hash did not verify) header.i=@openvpn.net header.s=google header.b=KVYepNES; spf=pass (google.com: domain of openvpn-devel-bounces@lists.sourceforge.net designates 216.105.38.7 as permitted sender) smtp.mailfrom=openvpn-devel-bounces@lists.sourceforge.net; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=openvpn.net; dara=fail header.i=@openvpn.net Received: from [127.0.0.1] (helo=sfs-ml-2.v29.lw.sourceforge.com) by sfs-ml-2.v29.lw.sourceforge.com with esmtp (Exim 4.95) (envelope-from ) id 1tFk2K-0000Ds-2d; Tue, 26 Nov 2024 01:06:40 +0000 Received: from [172.30.29.66] (helo=mx.sourceforge.net) by sfs-ml-2.v29.lw.sourceforge.com with esmtps (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.95) (envelope-from ) id 1tFk2I-0000Df-Mj for openvpn-devel@lists.sourceforge.net; Tue, 26 Nov 2024 01:06:38 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sourceforge.net; s=x; h=Content-Type:Content-Transfer-Encoding:MIME-Version :Message-ID:Reply-To:References:Subject:List-Unsubscribe:List-Id:Cc:To:Date: From:Sender:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:List-Help: List-Subscribe:List-Post:List-Owner:List-Archive; bh=hbtrLyTw2S5EZJbnF0OT2isCnRzygN6KjB0TQKEp9f4=; b=FNt0hYgDtaaAZJ9h7myJ01ykjQ Hrr1/XrJaanhKeoxt1hjTO4OtTKtKy7dL/kjqadg/4cNWFza2EgWgjO8r4hi/vJYQjxCodjHV5tvO 9ecT+nHDh0Xbr8W01PTq9hSpvHig5Oy0MDjK9Snmgona8uE8e77ymDPf3ki1/NcbWNy4=; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sf.net; s=x ; h=Content-Type:Content-Transfer-Encoding:MIME-Version:Message-ID:Reply-To: References:Subject:List-Unsubscribe:List-Id:Cc:To:Date:From:Sender:Content-ID :Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To: Resent-Cc:Resent-Message-ID:In-Reply-To:List-Help:List-Subscribe:List-Post: List-Owner:List-Archive; bh=hbtrLyTw2S5EZJbnF0OT2isCnRzygN6KjB0TQKEp9f4=; b=O ajvn3UtVRoPd6XTHc2hTVLN15X+cuu7mzOpGc2DxtC8RcD/Q6HlDeepWLDO5o+AWJgDTRrEVDMfs0 VTFhiOjy/Yycxg8O8fnmpjvVOWXsdRScM+fmS/UB1nQxOHBd4N3JC4uVWnqhI52Tl9KdQugWkKpY3 Bc3DJx8imI/rGif0=; Received: from mail-wm1-f44.google.com ([209.85.128.44]) by sfi-mx-2.v28.lw.sourceforge.com with esmtps (TLS1.2:ECDHE-RSA-AES128-GCM-SHA256:128) (Exim 4.95) id 1tFk2H-0003Bx-8Q for openvpn-devel@lists.sourceforge.net; Tue, 26 Nov 2024 01:06:38 +0000 Received: by mail-wm1-f44.google.com with SMTP id 5b1f17b1804b1-432d9b8558aso34633765e9.0 for ; Mon, 25 Nov 2024 17:06:36 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=openvpn.net; s=google; t=1732583185; x=1733187985; darn=lists.sourceforge.net; h=user-agent:content-disposition:content-transfer-encoding :mime-version:message-id:reply-to:references:subject :list-unsubscribe:list-id:auto-submitted:cc:to:date:from:from:to:cc :subject:date:message-id:reply-to; bh=hbtrLyTw2S5EZJbnF0OT2isCnRzygN6KjB0TQKEp9f4=; b=KVYepNES+tx75wJXspdKTfyBeRHgTwnOu6D+lChlA1T56YfOdtT/X16c6CXjpeQOt9 M7pCl0ZZKIQUBODj+nUtqmDNd69/f9CBuRML6pjHI5ZJOwK2SAkj7RK34JwoxkxrSdGz aV9rE0TEV+Seu1XffWiB8cCdQdo5Fh033WngGDPLO+K3bFKURi38gEZyuHXf/DUlZtjv yK8wo8h+8/m0nsez6UU3wEpAbAVxI7uI/Jtz1JgoxgDNkdUvHCrG33W21EQkwtAHnNGq uDojR4IUcplNA8pU/+4qaR+yY8CuhlUIMAtDMdGljKCT4ldslHvI35pkCXyNZz+XbznG XG5Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1732583185; x=1733187985; h=user-agent:content-disposition:content-transfer-encoding :mime-version:message-id:reply-to:references:subject :list-unsubscribe:list-id:auto-submitted:cc:to:date:from :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=hbtrLyTw2S5EZJbnF0OT2isCnRzygN6KjB0TQKEp9f4=; b=d7w8M1P9UGGY5ZqzH3n15lnf2S6zOAh3HrTW0T8rCq56zvgenQEP37svGuaI9FZcNX JH4Zg1+sWOUIhcq4ZhJPaksz9k3S7U+wnmKll79kE0Q85gtRkXiIVfSVk1v87hQq0jNa SIUuIuP72bnOcrwZ1yIIP8CujSmRZV1CnIGgwb8WUXMMYplZH8jAjVEfsgMzitROtdLg 2kwoMmE+cGnr72k4AKELqk6x8zz7VP5fnAme1Z7EuatkST2Ybvs2W6BEP1LN1EOHk7Wb hR9REXHrEVIF1SqXDJBzHDhA8w2Sk03TR4EPUuj8sxT22IfqYRljPTRQmTrpPatq/QUX 1G6Q== X-Gm-Message-State: AOJu0YwblS2mLqW1yrCo4WwR7Jeg//SYo2NO/BaiXPYXta4tVI3K5Byv 4y81ValOTvK3lFfbALT13onn91NiqGsDshy9+9+J/SLEewr5HpibBEODiAdHVOSBgHIH0BDOJ5y R X-Gm-Gg: ASbGncsqz6dwLA4ohOipA4iukPmBHFZpyYATxx+GIfQ+KUja2K5hqWjk0wewhL7ZeID jlI60DTcwf4QotZSzI05jvzOADSXZ3Vrj72Trj1CJ4PivcGO32f4pKrkpQjeDJ/knPGbe/hYyE/ nqC7p7U8+7qR0lT/Yvpy0Y+dOwRnRp/1/eaVVZifeQxAPLV/Ziyqt+5N+w5/UAO46fFf6Alzjmf tARSAjG6r7m9FItX7tKg4zQa6nBA020e9raLK9euO6jeXJhxsg7GI/4cMBL8tXuOuYar5o5WViJ rjZ/wywouV7n4VgcMOutExVxIk+wnWFBOc0SMBTFYA== X-Received: by 2002:a5d:6d03:0:b0:367:8e57:8 with SMTP id ffacd0b85a97d-385bfb14b92mr1041199f8f.19.1732583185434; Mon, 25 Nov 2024 17:06:25 -0800 (PST) Received: from gerrit.openvpn.in (ec2-18-159-0-78.eu-central-1.compute.amazonaws.com. [18.159.0.78]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-433b463abb4sm216914015e9.31.2024.11.25.17.06.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 25 Nov 2024 17:06:24 -0800 (PST) From: "flichtenheld (Code Review)" X-Google-Original-From: "flichtenheld (Code Review)" X-Gerrit-PatchSet: 1 Date: Tue, 26 Nov 2024 01:06:22 +0000 To: plaisthos Auto-Submitted: auto-generated X-Gerrit-MessageType: newchange X-Gerrit-Change-Id: Ib88ce925b20c5912de489ef1b62615c4b87d365c X-Gerrit-Change-Number: 820 X-Gerrit-Project: openvpn X-Gerrit-ChangeURL: X-Gerrit-Commit: 36741308005fd38bfc85254661b887cedeb8e2a7 References: Message-ID: MIME-Version: 1.0 User-Agent: Gerrit/3.8.2 X-Spam-Score: -1.1 (-) X-Spam-Report: Spam detection software, running on the system "util-spamd-2.v13.lw.sourceforge.com", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see the administrator of that system for details. Content preview: Attention is currently required from: plaisthos. Hello plaisthos, I'd like you to do a code review. Please visit Content analysis details: (-1.1 points, 6.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 0.0 RCVD_IN_VALIDITY_RPBL_BLOCKED RBL: ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. [209.85.128.44 listed in bl.score.senderscore.com] 0.0 RCVD_IN_VALIDITY_SAFE_BLOCKED RBL: ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. [209.85.128.44 listed in sa-accredit.habeas.com] -0.9 RCVD_IN_MSPIKE_H2 RBL: Average reputation (+2) [209.85.128.44 listed in wl.mailspike.net] -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at https://www.dnswl.org/, no trust [209.85.128.44 listed in list.dnswl.org] 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.0 SPF_PASS SPF: sender matches SPF record 0.0 WEIRD_PORT URI: Uses non-standard port number for HTTP 0.0 HTML_MESSAGE BODY: HTML included in message -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain 0.0 T_KAM_HTML_FONT_INVALID Test for Invalidly Named or Formatted Colors in HTML X-Headers-End: 1tFk2H-0003Bx-8Q Subject: [Openvpn-devel] [S] Change in openvpn[master]: Fix wrong doxygen comments X-BeenThere: openvpn-devel@lists.sourceforge.net X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: frank@lichtenheld.com, arne-openvpn@rfc2549.org, openvpn-devel@lists.sourceforge.net Cc: openvpn-devel Errors-To: openvpn-devel-bounces@lists.sourceforge.net X-getmail-retrieved-from-mailbox: Inbox X-GMAIL-THRID: =?utf-8?q?1816745177700846902?= X-GMAIL-MSGID: =?utf-8?q?1816745177700846902?= X-getmail-filter-classifier: gerrit message type newchange Attention is currently required from: plaisthos. Hello plaisthos, I'd like you to do a code review. Please visit http://gerrit.openvpn.net/c/openvpn/+/820?usp=email to review the following change. Change subject: Fix wrong doxygen comments ...................................................................... Fix wrong doxygen comments Add some missing "<" to trailing comments to make sure they apply to the correct line. Change-Id: Ib88ce925b20c5912de489ef1b62615c4b87d365c Signed-off-by: Frank Lichtenheld --- M src/openvpn/options.c M src/openvpnmsica/msica_arg.h M src/openvpnmsica/openvpnmsica.c M src/openvpnmsica/openvpnmsica.h M src/tapctl/tap.h 5 files changed, 26 insertions(+), 23 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/20/820/1 diff --git a/src/openvpn/options.c b/src/openvpn/options.c index 10ee9f6..043b240 100644 --- a/src/openvpn/options.c +++ b/src/openvpn/options.c @@ -929,10 +929,10 @@ struct pull_filter { -#define PUF_TYPE_UNDEF 0 /** undefined filter type */ -#define PUF_TYPE_ACCEPT 1 /** filter type to accept a matching option */ -#define PUF_TYPE_IGNORE 2 /** filter type to ignore a matching option */ -#define PUF_TYPE_REJECT 3 /** filter type to reject and trigger SIGUSR1 */ +#define PUF_TYPE_UNDEF 0 /**< undefined filter type */ +#define PUF_TYPE_ACCEPT 1 /**< filter type to accept a matching option */ +#define PUF_TYPE_IGNORE 2 /**< filter type to ignore a matching option */ +#define PUF_TYPE_REJECT 3 /**< filter type to reject and trigger SIGUSR1 */ int type; int size; char *pattern; @@ -3846,14 +3846,14 @@ * Check file/directory sanity * */ -#ifndef ENABLE_SMALL /** Expect people using the stripped down version to know what they do */ +#ifndef ENABLE_SMALL /* Expect people using the stripped down version to know what they do */ -#define CHKACC_FILE (1<<0) /** Check for a file/directory presence */ -#define CHKACC_DIRPATH (1<<1) /** Check for directory presence where a file should reside */ -#define CHKACC_FILEXSTWR (1<<2) /** If file exists, is it writable? */ -#define CHKACC_ACPTSTDIN (1<<3) /** If filename is stdin, it's allowed and "exists" */ -#define CHKACC_PRIVATE (1<<4) /** Warn if this (private) file is group/others accessible */ -#define CHKACC_ACCEPT_URI (1<<5) /** If filename is a URI, no check is done unless it starts with file: */ +#define CHKACC_FILE (1<<0) /**< Check for a file/directory presence */ +#define CHKACC_DIRPATH (1<<1) /**< Check for directory presence where a file should reside */ +#define CHKACC_FILEXSTWR (1<<2) /**< If file exists, is it writable? */ +#define CHKACC_ACPTSTDIN (1<<3) /**< If filename is stdin, it's allowed and "exists" */ +#define CHKACC_PRIVATE (1<<4) /**< Warn if this (private) file is group/others accessible */ +#define CHKACC_ACCEPT_URI (1<<5) /**< Do not check URIs, unless they start with file: */ static bool check_file_access(const int type, const char *file, const int mode, const char *opt) diff --git a/src/openvpnmsica/msica_arg.h b/src/openvpnmsica/msica_arg.h index 6cd272c..cec046f 100644 --- a/src/openvpnmsica/msica_arg.h +++ b/src/openvpnmsica/msica_arg.h @@ -37,8 +37,8 @@ */ struct msica_arg { - struct msica_arg *next; /** Pointer to the next argument in the sequence */ - TCHAR val[]; /** Zero terminated argument string */ + struct msica_arg *next; /**< Pointer to the next argument in the sequence */ + TCHAR val[]; /**< Zero terminated argument string */ }; @@ -47,8 +47,8 @@ */ struct msica_arg_seq { - struct msica_arg *head; /** Pointer to the first argument in the sequence */ - struct msica_arg *tail; /** Pointer to the last argument in the sequence */ + struct msica_arg *head; /**< Pointer to the first argument in the sequence */ + struct msica_arg *tail; /**< Pointer to the last argument in the sequence */ }; diff --git a/src/openvpnmsica/openvpnmsica.c b/src/openvpnmsica/openvpnmsica.c index 5ffb5b3..154fff4 100644 --- a/src/openvpnmsica/openvpnmsica.c +++ b/src/openvpnmsica/openvpnmsica.c @@ -59,9 +59,10 @@ * Local constants */ -#define MSICA_ADAPTER_TICK_SIZE (16*1024) /** Amount of tick space to reserve for one TAP/TUN adapter creation/deletition. */ +/** Amount of tick space to reserve for one TAP/TUN adapter creation/deletition. */ +#define MSICA_ADAPTER_TICK_SIZE (16 * 1024) -#define FILE_NEED_REBOOT L".ovpn_need_reboot" +#define FILE_NEED_REBOOT L".ovpn_need_reboot" #define OPENVPN_CONNECT_ADAPTER_SUBSTR L"OpenVPN Connect" @@ -88,7 +89,9 @@ free(szSequence); if (uiResult != ERROR_SUCCESS) { - SetLastError(uiResult); /* MSDN does not mention MsiSetProperty() to set GetLastError(). But we do have an error code. Set last error manually. */ + /* MSDN does not mention MsiSetProperty() to set GetLastError(). But we do have an error + * code. Set last error manually. */ + SetLastError(uiResult); msg(M_NONFATAL | M_ERRNO, "%s: MsiSetProperty(\"%" PRIsLPTSTR "\") failed", __FUNCTION__, szProperty); return uiResult; } diff --git a/src/openvpnmsica/openvpnmsica.h b/src/openvpnmsica/openvpnmsica.h index 6640d7e..7aacdf3 100644 --- a/src/openvpnmsica/openvpnmsica.h +++ b/src/openvpnmsica/openvpnmsica.h @@ -38,7 +38,7 @@ */ struct openvpnmsica_thread_data { - MSIHANDLE hInstall; /** Handle to the installation session. */ + MSIHANDLE hInstall; /**< Handle to the installation session. */ }; diff --git a/src/tapctl/tap.h b/src/tapctl/tap.h index 9c403cc..680c13a 100644 --- a/src/tapctl/tap.h +++ b/src/tapctl/tap.h @@ -135,11 +135,11 @@ */ struct tap_adapter_node { - GUID guid; /** Adapter GUID */ - LPTSTR szzHardwareIDs; /** Device hardware ID(s) */ - LPTSTR szName; /** Adapter name */ + GUID guid; /**< Adapter GUID */ + LPTSTR szzHardwareIDs; /**< Device hardware ID(s) */ + LPTSTR szName; /**< Adapter name */ - struct tap_adapter_node *pNext; /** Pointer to next adapter */ + struct tap_adapter_node *pNext; /**< Pointer to next adapter */ };